Python: ObjectAPI to ValueAPI: ReturnValueIgnore: Moves getAnInferredType to CallableObjectInternal

BekaValentine · BekaValentine · commit 838e37ca98ed · 2020-04-01T08:45:27.000-07:00
diff --git a/python/ql/src/Functions/ReturnValueIgnored.ql b/python/ql/src/Functions/ReturnValueIgnored.ql
@@ -15,6 +15,7 @@
  */
 
 import python
+import semmle.python.objects.Callables
 
 predicate meaningful_return_value(Expr val) {
     val instanceof Name
@@ -44,7 +45,7 @@ predicate returns_meaningful_value(FunctionValue f) {
       or
       /* Is f a builtin function that returns something other than None?
        * Ignore __import__ as it is often called purely for side effects */
-      f.isBuiltin() and f.getAnInferredReturnType() != ClassValue::nonetype() and not f.getName() = "__import__"
+      f.isBuiltin() and f.(CallableObjectInternal).getAnInferredReturnType() != ClassValue::nonetype() and not f.getName() = "__import__"
     )
 }
 
diff --git a/python/ql/src/semmle/python/objects/Callables.qll b/python/ql/src/semmle/python/objects/Callables.qll
@@ -49,6 +49,13 @@ abstract class CallableObjectInternal extends ObjectInternal {
 
     /* Callables aren't iterable */
     override ObjectInternal getIterNext() { none() }
+
+    /** Gets a class that this function may return */
+    ClassValue getAnInferredReturnType() {
+        result = TBuiltinClassObject(this.(BuiltinFunctionObjectInternal).getReturnType())
+        or
+        result = TBuiltinClassObject(this.(BuiltinMethodObjectInternal).getReturnType())
+    }
 }
 
 /** Class representing Python functions */
diff --git a/python/ql/src/semmle/python/objects/ObjectAPI.qll b/python/ql/src/semmle/python/objects/ObjectAPI.qll
@@ -581,13 +581,6 @@ abstract class FunctionValue extends CallableValue {
             exists(Expr expr, AstNode origin | expr.pointsTo(this, origin) | not origin instanceof Lambda)
         )
     }
-
-    /** Gets a class that this function may return */
-    ClassValue getAnInferredReturnType() {
-        result = this.(BuiltinFunctionValue).getAReturnType()
-        or
-        result = this.(BuiltinMethodValue).getAReturnType()
-    }
 }
 
 /** Class representing Python functions */
@@ -627,29 +620,6 @@ class BuiltinFunctionValue extends FunctionValue {
     override int minParameters() { none() }
 
     override int maxParameters() { none() }
-
-    ClassValue getAReturnType() {
-        /* Enumerate the types of a few builtin functions, that the CPython analysis misses.
-        */
-        this = TBuiltinFunctionObject(Builtin::builtin("hex")) and result = ClassValue::str()
-        or
-        this = TBuiltinFunctionObject(Builtin::builtin("oct")) and result = ClassValue::str()
-        or
-        this = TBuiltinFunctionObject(Builtin::builtin("intern")) and result = ClassValue::str()
-        or
-        /* Fix a few minor inaccuracies in the CPython analysis */ 
-        exists(Builtin mthd, Builtin cls | this = TBuiltinFunctionObject(mthd) and result = TBuiltinClassObject(cls)
-        | ext_rettype(mthd, cls)) and
-        not (
-            this = TBuiltinFunctionObject(Builtin::builtin("__import__")) and result = ClassValue::nonetype()
-            or
-            this = TBuiltinFunctionObject(Builtin::builtin("compile")) and result = ClassValue::nonetype()
-            or
-            this = TBuiltinFunctionObject(Builtin::builtin("sum"))
-            or
-            this = TBuiltinFunctionObject(Builtin::builtin("filter"))
-        )
-    }
 }
 
 /** Class representing builtin methods, such as `list.append` or `set.add` */
@@ -667,15 +637,6 @@ class BuiltinMethodValue extends FunctionValue {
     override int minParameters() { none() }
 
     override int maxParameters() { none() }
-
-    ClassValue getAReturnType() {
-        exists(Builtin mthd, Builtin cls |
-            this = TBuiltinMethodObject(mthd) and
-            result = TBuiltinClassObject(cls)
-        |
-            ext_rettype(mthd, cls)
-        )
-    }
 }
 
 /**

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@`
`15`	`15`	`*/`
`16`	`16`
`17`	`17`	`import python`
	`18`	`+import semmle.python.objects.Callables`
`18`	`19`
`19`	`20`	`predicate meaningful_return_value(Expr val) {`
`20`	`21`	`val instanceof Name`
`@@ -44,7 +45,7 @@ predicate returns_meaningful_value(FunctionValue f) {`
`44`	`45`	`or`
`45`	`46`	`/* Is f a builtin function that returns something other than None?`
`46`	`47`	`* Ignore __import__ as it is often called purely for side effects */`
`47`		`- f.isBuiltin() and f.getAnInferredReturnType() != ClassValue::nonetype() and not f.getName() = "__import__"`
	`48`	`+ f.isBuiltin() and f.(CallableObjectInternal).getAnInferredReturnType() != ClassValue::nonetype() and not f.getName() = "__import__"`
`48`	`49`	`)`
`49`	`50`	`}`
`50`	`51`