Python: Autoformat objects.

Author: tausbn

python/ql/src/semmle/python/objects/Callables.qll

@@ -1,5 +1,4 @@
 import python
-
 private import semmle.python.objects.TObject
 private import semmle.python.objects.ObjectInternal
 private import semmle.python.pointsto.PointsTo
@@ -9,16 +8,11 @@ private import semmle.python.types.Builtins
 
 /** Class representing property objects in Python */
 class PropertyInternal extends ObjectInternal, TProperty {
-
     /** Gets the name of this property */
-    override string getName() {
-        result = this.getGetter().getName()
-    }
+    override string getName() { result = this.getGetter().getName() }
 
     /** Gets the getter function of this property */
-    CallableObjectInternal getGetter() {
-        this = TProperty(_, _, result)
-    }
+    CallableObjectInternal getGetter() { this = TProperty(_, _, result) }
 
     private CallNode getCallNode() { this = TProperty(result, _, _) }
 
@@ -55,11 +49,9 @@ class PropertyInternal extends ObjectInternal, TProperty {
         )
     }
 
-    private Context getContext() { this = TProperty(_,result,  _) }
+    private Context getContext() { this = TProperty(_, result, _) }
 
-    override string toString() {
-        result = "property " + this.getName()
-    }
+    override string toString() { result = "property " + this.getName() }
 
     override boolean booleanValue() { result = true }
 
@@ -79,7 +71,9 @@ class PropertyInternal extends ObjectInternal, TProperty {
 
     override ControlFlowNode getOrigin() { this = TProperty(result, _, _) }
 
-    override predicate callResult(PointsToContext callee, ObjectInternal obj, CfgOrigin origin) { none() }
+    override predicate callResult(PointsToContext callee, ObjectInternal obj, CfgOrigin origin) {
+        none()
+    }
 
     override predicate callResult(ObjectInternal obj, CfgOrigin origin) { none() }
 
@@ -89,7 +83,8 @@ class PropertyInternal extends ObjectInternal, TProperty {
 
     override predicate calleeAndOffset(Function scope, int paramOffset) { none() }
 
-    pragma [noinline] override predicate attribute(string name, ObjectInternal value, CfgOrigin origin) {
+    pragma[noinline]
+    override predicate attribute(string name, ObjectInternal value, CfgOrigin origin) {
         value = TPropertySetterOrDeleter(this, name) and origin = CfgOrigin::unknown()
     }
 
@@ -103,20 +98,28 @@ class PropertyInternal extends ObjectInternal, TProperty {
 
     override predicate binds(ObjectInternal cls, string name, ObjectInternal descriptor) { none() }
 
-    pragma [noinline] override predicate descriptorGetClass(ObjectInternal cls, ObjectInternal value, CfgOrigin origin) {
+    pragma[noinline]
+    override predicate descriptorGetClass(ObjectInternal cls, ObjectInternal value, CfgOrigin origin) {
         any(ObjectInternal obj).binds(cls, _, this) and
-        value = this and origin = CfgOrigin::fromCfgNode(this.getOrigin())
+        value = this and
+        origin = CfgOrigin::fromCfgNode(this.getOrigin())
     }
 
-    pragma [noinline] override predicate descriptorGetInstance(ObjectInternal instance, ObjectInternal value, CfgOrigin origin) {
-        /* Just give an unknown value for now. We could improve this, but it would mean
+    pragma[noinline]
+    override predicate descriptorGetInstance(
+        ObjectInternal instance, ObjectInternal value, CfgOrigin origin
+    ) {
+        /*
+         * Just give an unknown value for now. We could improve this, but it would mean
          * changing Contexts to account for property accesses.
          */
+
         exists(ClassObjectInternal cls, string name |
             name = this.getName() and
             receiver_type(_, name, instance, cls) and
             cls.lookup(name, this, _) and
-            origin = CfgOrigin::unknown() and value = ObjectInternal::unknown()
+            origin = CfgOrigin::unknown() and
+            value = ObjectInternal::unknown()
         )
     }
 
@@ -128,40 +131,31 @@ class PropertyInternal extends ObjectInternal, TProperty {
     override ObjectInternal getIterNext() { none() }
 
     override predicate isNotSubscriptedType() { any() }
-
 }
 
 private class PropertySetterOrDeleter extends ObjectInternal, TPropertySetterOrDeleter {
+    override string toString() { result = this.getProperty().toString() + "." + this.getName() }
 
-    override string toString() {
-        result = this.getProperty().toString() + "." + this.getName()
-    }
+    override string getName() { this = TPropertySetterOrDeleter(_, result) }
 
-    override string getName() {
-        this = TPropertySetterOrDeleter(_, result)
-    }
-
-    PropertyInternal getProperty() {
-        this = TPropertySetterOrDeleter(result, _)
-    }
+    PropertyInternal getProperty() { this = TPropertySetterOrDeleter(result, _) }
 
     override predicate callResult(ObjectInternal obj, CfgOrigin origin) {
         exists(ControlFlowNode call |
-            obj = this.getProperty() and obj = TProperty(call, _, _) and
+            obj = this.getProperty() and
+            obj = TProperty(call, _, _) and
             origin = CfgOrigin::fromCfgNode(call)
         )
     }
 
-    override predicate introducedAt(ControlFlowNode node, PointsToContext context) {
-        none()
-    }
+    override predicate introducedAt(ControlFlowNode node, PointsToContext context) { none() }
 
     override ClassDecl getClassDeclaration() { none() }
 
     override boolean isClass() { result = false }
 
     override ObjectInternal getClass() {
-       result = TBuiltinClassObject(Builtin::special("MethodType"))
+        result = TBuiltinClassObject(Builtin::special("MethodType"))
     }
 
     override predicate notTestableForEquality() { none() }
@@ -170,7 +164,9 @@ private class PropertySetterOrDeleter extends ObjectInternal, TPropertySetterOrD
 
     override ControlFlowNode getOrigin() { none() }
 
-    override predicate callResult(PointsToContext callee, ObjectInternal obj, CfgOrigin origin) { none() }
+    override predicate callResult(PointsToContext callee, ObjectInternal obj, CfgOrigin origin) {
+        none()
+    }
 
     override int intValue() { none() }
 
@@ -196,23 +192,24 @@ private class PropertySetterOrDeleter extends ObjectInternal, TPropertySetterOrD
 
     override ObjectInternal getIterNext() { none() }
 
-    override predicate descriptorGetClass(ObjectInternal cls, ObjectInternal value, CfgOrigin origin) { none() }
+    override predicate descriptorGetClass(ObjectInternal cls, ObjectInternal value, CfgOrigin origin) {
+        none()
+    }
 
-    override predicate descriptorGetInstance(ObjectInternal instance, ObjectInternal value, CfgOrigin origin) { none() }
+    override predicate descriptorGetInstance(
+        ObjectInternal instance, ObjectInternal value, CfgOrigin origin
+    ) {
+        none()
+    }
 
     override predicate useOriginAsLegacyObject() { none() }
 
     override predicate isNotSubscriptedType() { any() }
-
 }
 
-
 /** A class representing classmethods in Python */
 class ClassMethodObjectInternal extends ObjectInternal, TClassMethod {
-
-    override string toString() {
-        result = "classmethod(" + this.getFunction() + ")"
-    }
+    override string toString() { result = "classmethod(" + this.getFunction() + ")" }
 
     override boolean booleanValue() { result = true }
 
@@ -224,9 +221,7 @@ class ClassMethodObjectInternal extends ObjectInternal, TClassMethod {
     }
 
     /** Gets the function wrapped by this classmethod object */
-    CallableObjectInternal getFunction() {
-        this = TClassMethod(_, result)
-    }
+    CallableObjectInternal getFunction() { this = TClassMethod(_, result) }
 
     override ClassDecl getClassDeclaration() { none() }
 
@@ -240,7 +235,9 @@ class ClassMethodObjectInternal extends ObjectInternal, TClassMethod {
 
     override ControlFlowNode getOrigin() { this = TClassMethod(result, _) }
 
-    override predicate callResult(PointsToContext callee, ObjectInternal obj, CfgOrigin origin) { none() }
+    override predicate callResult(PointsToContext callee, ObjectInternal obj, CfgOrigin origin) {
+        none()
+    }
 
     override predicate callResult(ObjectInternal obj, CfgOrigin origin) { none() }
 
@@ -258,26 +255,31 @@ class ClassMethodObjectInternal extends ObjectInternal, TClassMethod {
 
     override boolean isDescriptor() { result = true }
 
-    pragma [noinline] override predicate descriptorGetClass(ObjectInternal cls, ObjectInternal value, CfgOrigin origin) {
+    pragma[noinline]
+    override predicate descriptorGetClass(ObjectInternal cls, ObjectInternal value, CfgOrigin origin) {
         value = TBoundMethod(cls, this.getFunction()) and
         origin = CfgOrigin::unknown()
     }
 
-    pragma [noinline] override predicate descriptorGetInstance(ObjectInternal instance, ObjectInternal value, CfgOrigin origin) {
+    pragma[noinline]
+    override predicate descriptorGetInstance(
+        ObjectInternal instance, ObjectInternal value, CfgOrigin origin
+    ) {
         any(ObjectInternal obj).binds(instance, _, this) and
         value = TBoundMethod(instance.getClass(), this.getFunction()) and
         origin = CfgOrigin::unknown()
     }
 
-    /** Holds if attribute lookup on this object may "bind" `cls` to `descriptor`.
+    /**
+     * Holds if attribute lookup on this object may "bind" `cls` to `descriptor`.
      * `cls` will always be a class as this is a classmethod.
      * Here "bind" means that `instance` is passed to the `classmethod.__get__()` method
      * at runtime. The term "bind" is used as this most likely results in a bound-method.
      */
-    pragma [noinline] override predicate binds(ObjectInternal cls, string name, ObjectInternal descriptor) {
+    pragma[noinline]
+    override predicate binds(ObjectInternal cls, string name, ObjectInternal descriptor) {
         descriptor = this.getFunction() and
-        exists(ObjectInternal instance |
-            any(ObjectInternal obj).binds(instance, name, this) |
+        exists(ObjectInternal instance | any(ObjectInternal obj).binds(instance, name, this) |
             instance.isClass() = false and cls = instance.getClass()
             or
             instance.isClass() = true and cls = instance
@@ -286,9 +288,7 @@ class ClassMethodObjectInternal extends ObjectInternal, TClassMethod {
 
     override int length() { none() }
 
-    override string getName() {
-        result = this.getFunction().getName()
-    }
+    override string getName() { result = this.getFunction().getName() }
 
     override predicate contextSensitiveCallee() { none() }
 
@@ -298,14 +298,10 @@ class ClassMethodObjectInternal extends ObjectInternal, TClassMethod {
     override ObjectInternal getIterNext() { none() }
 
     override predicate isNotSubscriptedType() { any() }
-
 }
 
 class StaticMethodObjectInternal extends ObjectInternal, TStaticMethod {
-
-    override string toString() {
-        result = "staticmethod()"
-    }
+    override string toString() { result = "staticmethod()" }
 
     override boolean booleanValue() { result = true }
 
@@ -316,9 +312,7 @@ class StaticMethodObjectInternal extends ObjectInternal, TStaticMethod {
         )
     }
 
-    CallableObjectInternal getFunction() {
-        this = TStaticMethod(_, result)
-    }
+    CallableObjectInternal getFunction() { this = TStaticMethod(_, result) }
 
     override ClassDecl getClassDeclaration() { none() }
 
@@ -332,7 +326,9 @@ class StaticMethodObjectInternal extends ObjectInternal, TStaticMethod {
 
     override ControlFlowNode getOrigin() { this = TStaticMethod(result, _) }
 
-    override predicate callResult(PointsToContext callee, ObjectInternal obj, CfgOrigin origin) { none() }
+    override predicate callResult(PointsToContext callee, ObjectInternal obj, CfgOrigin origin) {
+        none()
+    }
 
     override predicate callResult(ObjectInternal obj, CfgOrigin origin) { none() }
 
@@ -352,23 +348,29 @@ class StaticMethodObjectInternal extends ObjectInternal, TStaticMethod {
 
     override boolean isDescriptor() { result = true }
 
-    pragma [noinline] override predicate descriptorGetClass(ObjectInternal cls, ObjectInternal value, CfgOrigin origin) {
+    pragma[noinline]
+    override predicate descriptorGetClass(ObjectInternal cls, ObjectInternal value, CfgOrigin origin) {
         any(ObjectInternal obj).binds(cls, _, this) and
-        value = this.getFunction() and origin = CfgOrigin::unknown()
+        value = this.getFunction() and
+        origin = CfgOrigin::unknown()
     }
 
-    pragma [noinline] override predicate descriptorGetInstance(ObjectInternal instance, ObjectInternal value, CfgOrigin origin) {
+    pragma[noinline]
+    override predicate descriptorGetInstance(
+        ObjectInternal instance, ObjectInternal value, CfgOrigin origin
+    ) {
         any(ObjectInternal obj).binds(instance, _, this) and
-        value = this.getFunction() and origin = CfgOrigin::unknown()
+        value = this.getFunction() and
+        origin = CfgOrigin::unknown()
     }
 
-    override predicate binds(ObjectInternal instance, string name, ObjectInternal descriptor) { none() }
+    override predicate binds(ObjectInternal instance, string name, ObjectInternal descriptor) {
+        none()
+    }
 
     override int length() { none() }
 
-    override string getName() {
-        result = this.getFunction().getName()
-    }
+    override string getName() { result = this.getFunction().getName() }
 
     override predicate contextSensitiveCallee() { none() }
 
@@ -378,5 +380,4 @@ class StaticMethodObjectInternal extends ObjectInternal, TStaticMethod {
     override ObjectInternal getIterNext() { none() }
 
     override predicate isNotSubscriptedType() { any() }
-
 }