Merge pull request github#3031 from BekaValentine/python-objectapi-to-valueapi-signaturespecialmethods

tausbn · web-flow · commit ea5aa5715144 · 2020-03-10T14:54:39.000+01:00
Python: ObjectAPI to ValueAPI: SignatureSpecialMethods
diff --git a/python/ql/src/Functions/SignatureSpecialMethods.ql b/python/ql/src/Functions/SignatureSpecialMethods.ql
@@ -112,7 +112,7 @@ predicate is_quad_op(string name) {
     name = "__setslice__" or name = "__exit__"
 }
 
-int argument_count(PyFunctionObject f, string name, ClassObject cls) {
+int argument_count(PythonFunctionValue f, string name, ClassValue cls) {
     cls.declaredAttribute(name) = f and
     (
         is_unary_op(name) and result = 1
@@ -125,22 +125,22 @@ int argument_count(PyFunctionObject f, string name, ClassObject cls) {
     )
 }
 
-predicate incorrect_special_method_defn(PyFunctionObject func, string message, boolean show_counts, string name, ClassObject owner) {
+predicate incorrect_special_method_defn(PythonFunctionValue func, string message, boolean show_counts, string name, ClassValue owner) {
    exists(int required |
           required = argument_count(func, name, owner) |
           /* actual_non_default <= actual */
           if required > func.maxParameters() then
               (message = "Too few parameters" and show_counts = true)
           else if required < func.minParameters() then
               (message = "Too many parameters" and show_counts = true)
-          else if (func.minParameters() < required and not func.getFunction().hasVarArg()) then
+          else if (func.minParameters() < required and not func.getScope().hasVarArg()) then
               (message = (required -func.minParameters()) +  " default values(s) will never be used" and show_counts = false)
           else
               none()
    )
 }
 
-predicate incorrect_pow(FunctionObject func, string message, boolean show_counts, ClassObject owner) {
+predicate incorrect_pow(FunctionValue func, string message, boolean show_counts, ClassValue owner) {
     owner.declaredAttribute("__pow__") = func and
     (
        func.maxParameters() < 2 and message = "Too few parameters" and show_counts = true
@@ -153,27 +153,27 @@ predicate incorrect_pow(FunctionObject func, string message, boolean show_counts
      )
 }
 
-predicate incorrect_get(FunctionObject func, string message, boolean show_counts, ClassObject owner) {
+predicate incorrect_get(FunctionValue func, string message, boolean show_counts, ClassValue owner) {
     owner.declaredAttribute("__get__") = func and
     (
        func.maxParameters() < 3 and message = "Too few parameters" and show_counts = true
        or
        func.minParameters() > 3 and message = "Too many parameters" and show_counts = true
        or
-       func.minParameters() < 2 and not func.getFunction().hasVarArg() and
+       func.minParameters() < 2 and not func.getScope().hasVarArg() and
        message = (2 - func.minParameters()) + " default value(s) will never be used" and show_counts = false
      )
 }
 
-string should_have_parameters(PyFunctionObject f, string name, ClassObject owner) {
+string should_have_parameters(PythonFunctionValue f, string name, ClassValue owner) {
     exists(int i | i = argument_count(f, name, owner) | 
         result = i.toString()
     )
     or 
     owner.declaredAttribute(name) = f and (name = "__get__" or name = "__pow__") and result = "2 or 3"
 }
 
-string has_parameters(PyFunctionObject f) {
+string has_parameters(PythonFunctionValue f) {
     exists(int i | i = f.minParameters() |
         i = 0 and result = "no parameters"
         or
@@ -183,7 +183,7 @@ string has_parameters(PyFunctionObject f) {
     )
 }
 
-from PyFunctionObject f, string message, string sizes, boolean show_counts, string name, ClassObject owner
+from PythonFunctionValue f, string message, string sizes, boolean show_counts, string name, ClassValue owner
 where 
   (
     incorrect_special_method_defn(f, message, show_counts, name, owner)
diff --git a/python/ql/test/query-tests/Functions/general/SignatureSpecialMethods.expected b/python/ql/test/query-tests/Functions/general/SignatureSpecialMethods.expected
@@ -1,9 +1,9 @@
-| om_test.py:59:5:59:28 | Function __div__ | Too many parameters for special method __div__, which has 3 parameters, but should have 2, in class $@. | om_test.py:57:1:57:28 | class WrongSpecials | WrongSpecials |
-| om_test.py:62:5:62:22 | Function __mul__ | Too few parameters for special method __mul__, which has 1 parameter, but should have 2, in class $@. | om_test.py:57:1:57:28 | class WrongSpecials | WrongSpecials |
-| om_test.py:65:5:65:29 | Function __neg__ | Too many parameters for special method __neg__, which has 2 parameters, but should have 1, in class $@. | om_test.py:57:1:57:28 | class WrongSpecials | WrongSpecials |
-| om_test.py:68:5:68:35 | Function __exit__ | Too few parameters for special method __exit__, which has 3 parameters, but should have 4, in class $@. | om_test.py:57:1:57:28 | class WrongSpecials | WrongSpecials |
-| om_test.py:71:5:71:19 | Function __repr__ | Too few parameters for special method __repr__, which has no parameters, but should have 1, in class $@. | om_test.py:57:1:57:28 | class WrongSpecials | WrongSpecials |
-| om_test.py:74:5:74:46 | Function __add__ | 1 default values(s) will never be used for special method __add__, in class $@. | om_test.py:57:1:57:28 | class WrongSpecials | WrongSpecials |
-| om_test.py:97:15:97:34 | Function lambda | Too few parameters for special method __sub__, which has 1 parameter, but should have 2, in class $@. | om_test.py:95:1:95:28 | class NotOKSpecials | NotOKSpecials |
+| om_test.py:59:5:59:28 | Function WrongSpecials.__div__ | Too many parameters for special method __div__, which has 3 parameters, but should have 2, in class $@. | om_test.py:57:1:57:28 | class WrongSpecials | WrongSpecials |
+| om_test.py:62:5:62:22 | Function WrongSpecials.__mul__ | Too few parameters for special method __mul__, which has 1 parameter, but should have 2, in class $@. | om_test.py:57:1:57:28 | class WrongSpecials | WrongSpecials |
+| om_test.py:65:5:65:29 | Function WrongSpecials.__neg__ | Too many parameters for special method __neg__, which has 2 parameters, but should have 1, in class $@. | om_test.py:57:1:57:28 | class WrongSpecials | WrongSpecials |
+| om_test.py:68:5:68:35 | Function WrongSpecials.__exit__ | Too few parameters for special method __exit__, which has 3 parameters, but should have 4, in class $@. | om_test.py:57:1:57:28 | class WrongSpecials | WrongSpecials |
+| om_test.py:71:5:71:19 | Function WrongSpecials.__repr__ | Too few parameters for special method __repr__, which has no parameters, but should have 1, in class $@. | om_test.py:57:1:57:28 | class WrongSpecials | WrongSpecials |
+| om_test.py:74:5:74:46 | Function WrongSpecials.__add__ | 1 default values(s) will never be used for special method __add__, in class $@. | om_test.py:57:1:57:28 | class WrongSpecials | WrongSpecials |
+| om_test.py:97:15:97:34 | Function NotOKSpecials.lambda | Too few parameters for special method __sub__, which has 1 parameter, but should have 2, in class $@. | om_test.py:95:1:95:28 | class NotOKSpecials | NotOKSpecials |
 | protocols.py:104:1:104:12 | Function f | Too few parameters for special method __add__, which has 1 parameter, but should have 2, in class $@. | protocols.py:107:1:107:29 | class MissingMethods | MissingMethods |
 | protocols.py:104:1:104:12 | Function f | Too few parameters for special method __set__, which has 1 parameter, but should have 3, in class $@. | protocols.py:107:1:107:29 | class MissingMethods | MissingMethods |

Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ predicate is_quad_op(string name) {`
`112`	`112`	`name = "__setslice__" or name = "__exit__"`
`113`	`113`	`}`
`114`	`114`
`115`		`-int argument_count(PyFunctionObject f, string name, ClassObject cls) {`
	`115`	`+int argument_count(PythonFunctionValue f, string name, ClassValue cls) {`
`116`	`116`	`cls.declaredAttribute(name) = f and`
`117`	`117`	`(`
`118`	`118`	`is_unary_op(name) and result = 1`
`@@ -125,22 +125,22 @@ int argument_count(PyFunctionObject f, string name, ClassObject cls) {`
`125`	`125`	`)`
`126`	`126`	`}`
`127`	`127`
`128`		`-predicate incorrect_special_method_defn(PyFunctionObject func, string message, boolean show_counts, string name, ClassObject owner) {`
	`128`	`+predicate incorrect_special_method_defn(PythonFunctionValue func, string message, boolean show_counts, string name, ClassValue owner) {`
`129`	`129`	`exists(int required \|`
`130`	`130`	`required = argument_count(func, name, owner) \|`
`131`	`131`	`/* actual_non_default <= actual */`
`132`	`132`	`if required > func.maxParameters() then`
`133`	`133`	`(message = "Too few parameters" and show_counts = true)`
`134`	`134`	`else if required < func.minParameters() then`
`135`	`135`	`(message = "Too many parameters" and show_counts = true)`
`136`		`- else if (func.minParameters() < required and not func.getFunction().hasVarArg()) then`
	`136`	`+ else if (func.minParameters() < required and not func.getScope().hasVarArg()) then`
`137`	`137`	`(message = (required -func.minParameters()) + " default values(s) will never be used" and show_counts = false)`
`138`	`138`	`else`
`139`	`139`	`none()`
`140`	`140`	`)`
`141`	`141`	`}`
`142`	`142`
`143`		`-predicate incorrect_pow(FunctionObject func, string message, boolean show_counts, ClassObject owner) {`
	`143`	`+predicate incorrect_pow(FunctionValue func, string message, boolean show_counts, ClassValue owner) {`
`144`	`144`	`owner.declaredAttribute("__pow__") = func and`
`145`	`145`	`(`
`146`	`146`	`func.maxParameters() < 2 and message = "Too few parameters" and show_counts = true`
`@@ -153,27 +153,27 @@ predicate incorrect_pow(FunctionObject func, string message, boolean show_counts`
`153`	`153`	`)`
`154`	`154`	`}`
`155`	`155`
`156`		`-predicate incorrect_get(FunctionObject func, string message, boolean show_counts, ClassObject owner) {`
	`156`	`+predicate incorrect_get(FunctionValue func, string message, boolean show_counts, ClassValue owner) {`
`157`	`157`	`owner.declaredAttribute("__get__") = func and`
`158`	`158`	`(`
`159`	`159`	`func.maxParameters() < 3 and message = "Too few parameters" and show_counts = true`
`160`	`160`	`or`
`161`	`161`	`func.minParameters() > 3 and message = "Too many parameters" and show_counts = true`
`162`	`162`	`or`
`163`		`- func.minParameters() < 2 and not func.getFunction().hasVarArg() and`
	`163`	`+ func.minParameters() < 2 and not func.getScope().hasVarArg() and`
`164`	`164`	`message = (2 - func.minParameters()) + " default value(s) will never be used" and show_counts = false`
`165`	`165`	`)`
`166`	`166`	`}`
`167`	`167`
`168`		`-string should_have_parameters(PyFunctionObject f, string name, ClassObject owner) {`
	`168`	`+string should_have_parameters(PythonFunctionValue f, string name, ClassValue owner) {`
`169`	`169`	`exists(int i \| i = argument_count(f, name, owner) \|`
`170`	`170`	`result = i.toString()`
`171`	`171`	`)`
`172`	`172`	`or`
`173`	`173`	`owner.declaredAttribute(name) = f and (name = "__get__" or name = "__pow__") and result = "2 or 3"`
`174`	`174`	`}`
`175`	`175`
`176`		`-string has_parameters(PyFunctionObject f) {`
	`176`	`+string has_parameters(PythonFunctionValue f) {`
`177`	`177`	`exists(int i \| i = f.minParameters() \|`
`178`	`178`	`i = 0 and result = "no parameters"`
`179`	`179`	`or`
`@@ -183,7 +183,7 @@ string has_parameters(PyFunctionObject f) {`
`183`	`183`	`)`
`184`	`184`	`}`
`185`	`185`
`186`		`-from PyFunctionObject f, string message, string sizes, boolean show_counts, string name, ClassObject owner`
	`186`	`+from PythonFunctionValue f, string message, string sizes, boolean show_counts, string name, ClassValue owner`
`187`	`187`	`where`
`188`	`188`	`(`
`189`	`189`	`incorrect_special_method_defn(f, message, show_counts, name, owner)`