Merge pull request github#3088 from tausbn/python-prepare-autoformatting

Python: Prepare for autoformatting.

Author: RasmusWL

python/ql/src/Classes/MethodCallOrder.qll

@@ -22,8 +22,8 @@ predicate multiple_calls_to_superclass_method(ClassObject self, FunctionObject m
         multiple_invocation_paths(top, i1, i2, multi) and
         top.runtime(self.declaredAttribute(name)) and
         self.getASuperType().declaredAttribute(name) = multi |
-        /* Only called twice if called from different functions,
-         * or if one call-site can reach the other */
+        // Only called twice if called from different functions,
+        // or if one call-site can reach the other.
         i1.getCall().getScope() != i2.getCall().getScope()
         or
         i1.getCall().strictlyReaches(i2.getCall())

python/ql/src/Expressions/CallArgs.qll

@@ -39,9 +39,9 @@ private Keyword not_keyword_only_arg(Call call, FunctionValue func) {
 }
 
 /** Gets the count of arguments that are passed as positional parameters even if they
- *  are named in the call.
- *  This is the sum of the number of positional arguments, the number of elements in any explicit tuple passed as *arg
- *  plus the number of keyword arguments that do not match keyword-only arguments (if the function does not take **kwargs).
+ * are named in the call.
+ * This is the sum of the number of positional arguments, the number of elements in any explicit tuple passed as *arg
+ * plus the number of keyword arguments that do not match keyword-only arguments (if the function does not take **kwargs).
  */
 
 private int positional_arg_count_for_call_objectapi(Call call, Object callable) {
@@ -59,9 +59,9 @@ private int positional_arg_count_for_call_objectapi(Call call, Object callable)
 }
 
 /** Gets the count of arguments that are passed as positional parameters even if they
- *  are named in the call.
- *  This is the sum of the number of positional arguments, the number of elements in any explicit tuple passed as *arg
- *  plus the number of keyword arguments that do not match keyword-only arguments (if the function does not take **kwargs).
+ * are named in the call.
+ * This is the sum of the number of positional arguments, the number of elements in any explicit tuple passed as *arg
+ * plus the number of keyword arguments that do not match keyword-only arguments (if the function does not take **kwargs).
  */
 
 private int positional_arg_count_for_call(Call call, Value callable) {
@@ -139,10 +139,9 @@ predicate too_few_args_objectapi(Call call, Object callable, int limit) {
     arg_count_objectapi(call) < limit and
     exists(FunctionObject func | func = get_function_or_initializer_objectapi(callable) |
       call = func.getAFunctionCall().getNode() and limit = func.minParameters() and
-      /* The combination of misuse of `mox.Mox().StubOutWithMock()`
-       * and a bug in mox's implementation of methods results in having to
-       * pass 1 too few arguments to the mocked function.
-       */
+      // The combination of misuse of `mox.Mox().StubOutWithMock()`
+      // and a bug in mox's implementation of methods results in having to
+      // pass 1 too few arguments to the mocked function.
       not (useOfMoxInModule(call.getEnclosingModule()) and func.isNormalMethod())
       or
       call = func.getAMethodCall().getNode() and limit = func.minParameters() - 1
@@ -160,10 +159,9 @@ predicate too_few_args(Call call, Value callable, int limit) {
     arg_count(call) < limit and
     exists(FunctionValue func | func = get_function_or_initializer(callable) |
       call = func.getACall().getNode() and limit = func.minParameters() and
-      /* The combination of misuse of `mox.Mox().StubOutWithMock()`
-       * and a bug in mox's implementation of methods results in having to
-       * pass 1 too few arguments to the mocked function.
-       */
+      // The combination of misuse of `mox.Mox().StubOutWithMock()`
+      // and a bug in mox's implementation of methods results in having to
+      // pass 1 too few arguments to the mocked function.
       not (useOfMoxInModule(call.getEnclosingModule()) and func.isNormalMethod())
       or
       call = func.getACall().getNode() and limit = func.minParameters() - 1

python/ql/src/Testing/Mox.qll

@@ -1,7 +1,6 @@
 import python
 
-/** Whether `mox` or `.StubOutWithMock()` is used in thin module `m`.
- */
+/** Whether `mox` or `.StubOutWithMock()` is used in thin module `m`. */
 predicate useOfMoxInModule(Module m) {
     exists(ModuleObject mox |
         mox.getName() = "mox" or mox.getName() = "mox3.mox" |

python/ql/src/analysis/CrossProjectDefinitions.qll

@@ -48,8 +48,7 @@ class Symbol extends TSymbol {
         )
     }
 
-    /** Finds the `AstNode` that this `Symbol` refers to.
-     */
+    /** Finds the `AstNode` that this `Symbol` refers to. */
     AstNode find() {
         this = TModule(result)
         or
@@ -91,8 +90,7 @@ class Symbol extends TSymbol {
         )
     }
 
-    /** Gets the `Symbol` that is the named member of this `Symbol`.
-     */
+    /** Gets the `Symbol` that is the named member of this `Symbol`. */
     Symbol getMember(string name) {
         result = TMember(this, name)
     }

python/ql/src/analysis/DefinitionTracking.qll

@@ -10,8 +10,7 @@ private newtype TDefinition =
         a instanceof Expr or a instanceof Stmt or a instanceof Module
     }
 
-/** A definition for the purposes of jump-to-definition.
- */
+/** A definition for the purposes of jump-to-definition. */
 class Definition extends TLocalDefinition {
 
 
@@ -159,8 +158,7 @@ private predicate delete_defn(DeletionDefinition def, Definition defn) {
     none()
 }
 
-/* Implicit "defn" of the names of submodules at the start of an `__init__.py` file.
- */
+/* Implicit "defn" of the names of submodules at the start of an `__init__.py` file. */
 private predicate implicit_submodule_defn(ImplicitSubModuleDefinition def, Definition defn) {
     exists(PackageObject package, ModuleObject mod |
         package.getInitModule().getModule() = def.getDefiningNode().getScope() and
@@ -170,7 +168,9 @@ private predicate implicit_submodule_defn(ImplicitSubModuleDefinition def, Defin
 
 }
 
-/* Helper for scope_entry_value_transfer(...). Transfer of values from the callsite to the callee, for enclosing variables, but not arguments/parameters */
+/* Helper for scope_entry_value_transfer(...). 
+ * Transfer of values from the callsite to the callee, for enclosing variables, but not arguments/parameters 
+ */
 private predicate scope_entry_value_transfer_at_callsite(EssaVariable pred_var, ScopeEntryDefinition succ_def) {
     exists(CallNode callsite, FunctionObject f |
         f.getACall() = callsite and
@@ -469,8 +469,8 @@ class NiceLocationExpr extends @py_expr {
         or
         this.(Name).getLocation().hasLocationInfo(f, bl, bc, el, ec)
         or
-        /* Show xxx for `xxx` in `from xxx import y` or
-         * for `import xxx` or for `import xxx as yyy`. */
+        // Show xxx for `xxx` in `from xxx import y` or
+        // for `import xxx` or for `import xxx as yyy`.
         this.(ImportExpr).getLocation().hasLocationInfo(f, bl, bc, el, ec)
         or
         /* Show y for `y` in `from xxx import y` */

python/ql/src/semmle/python/AstExtended.qll

@@ -24,7 +24,7 @@ abstract class AstNode extends AstNode_ {
     }
 
     /** Whether this syntactic element is artificial, that is it is generated 
-     *  by the compiler and is not present in the source */
+     * by the compiler and is not present in the source */
     predicate isArtificial() {
         none()
     }

python/ql/src/semmle/python/Class.qll

@@ -92,7 +92,7 @@ class ClassDef extends Assign {
 class Class extends Class_, Scope, AstNode {
 
     /** Use getADecorator() instead of getDefinition().getADecorator() 
-     *  Use getMetaClass() instead of getDefinition().getMetaClass()
+     * Use getMetaClass() instead of getDefinition().getMetaClass()
      */
     deprecated ClassExpr getDefinition() {
         result = this.getParent()

python/ql/src/semmle/python/Comparisons.qll

@@ -1,8 +1,7 @@
 
 import python
 
-/* A class representing the six comparison operators, ==, !=, <, <=, > and >=.
- *  */
+/** A class representing the six comparison operators, ==, !=, <, <=, > and >=. */
 class CompareOp extends int {
 
     CompareOp() { 

python/ql/src/semmle/python/Exprs.qll

@@ -356,7 +356,7 @@ class Repr extends Repr_ {
 /* Constants */
 
 /** A bytes constant, such as `b'ascii'`. Note that unadorned string constants such as
-   `"hello"` are treated as Bytes for Python2, but Unicode for Python3. */
+  * `"hello"` are treated as Bytes for Python2, but Unicode for Python3. */
 class Bytes extends StrConst {
 
     /* syntax: b"hello" */
@@ -395,8 +395,7 @@ class Ellipsis extends Ellipsis_ {
 }
 
 /** Immutable literal expressions (except tuples).
- *  Consists of string (both unicode and byte) literals
- *  and numeric literals.
+ * Consists of string (both unicode and byte) literals and numeric literals.
  */
 abstract class ImmutableLiteral extends Expr {
 
@@ -433,8 +432,10 @@ class IntegerLiteral extends Num {
         not this instanceof FloatLiteral and not this instanceof ImaginaryLiteral
     }
 
-    /** Gets the (integer) value of this constant. Will not return a result if the value does not fit into
-        a 32 bit signed value */
+    /**
+     * Gets the (integer) value of this constant. Will not return a result if the value does not fit into
+     * a 32 bit signed value 
+     */
     int getValue() {
         result = this.getN().toInt()
     }
@@ -540,16 +541,19 @@ class NegativeIntegerLiteral extends ImmutableLiteral, UnaryExpr {
         py_cobjectnames(result, "-" + this.getOperand().(IntegerLiteral).getN())
     }
 
-    /** Gets the (integer) value of this constant. Will not return a result if the value does not fit into
-        a 32 bit signed value */
+    /** 
+     * Gets the (integer) value of this constant. Will not return a result if the value does not fit into
+     * a 32 bit signed value 
+     */
     int getValue() {
         result = -(this.getOperand().(IntegerLiteral).getValue())
     }
 
 }
 
 /** A unicode string expression, such as `u"\u20ac"`. Note that unadorned string constants such as
-   "hello" are treated as Bytes for Python2, but Unicode for Python3. */
+ * "hello" are treated as Bytes for Python2, but Unicode for Python3. 
+ */
 class Unicode extends StrConst {
 
     /* syntax: "hello" */

python/ql/src/semmle/python/Files.qll

@@ -129,8 +129,10 @@ class Folder extends Container {
 
 }
 
-/** A container is an abstract representation of a file system object that can
-    hold elements of interest. */
+/** 
+ * A container is an abstract representation of a file system object that can
+ * hold elements of interest. 
+ */
 abstract class Container extends @container {
 
     Container getParent() {
@@ -473,8 +475,10 @@ class Line extends @py_line {
 
 }
 
-/** A syntax error. Note that if there is a syntax error in a module,
-   much information about that module will be lost */
+/** 
+ * A syntax error. Note that if there is a syntax error in a module,
+ * much information about that module will be lost 
+ */
 class SyntaxError extends Location {
 
     SyntaxError() {
@@ -492,8 +496,10 @@ class SyntaxError extends Location {
 
 }
 
-/** An encoding error. Note that if there is an encoding error in a module,
-   much information about that module will be lost */
+/** 
+ * An encoding error. Note that if there is an encoding error in a module,
+ * much information about that module will be lost 
+ */
 class EncodingError extends SyntaxError {
 
     EncodingError() {