Apply suggestions from code review

yoff · RasmusWL · web-flow · commit c6eb795e76aa · 2021-09-03T14:23:57.000+02:00
Co-authored-by: Rasmus Wriedt Larsen &lt;rasmuswriedtlarsen@gmail.com&gt;
diff --git a/python/ql/src/semmle/python/functions/ModificationOfParameterWithDefaultCustomizations.qll b/python/ql/src/semmle/python/functions/ModificationOfParameterWithDefaultCustomizations.qll
@@ -53,7 +53,7 @@ module ModificationOfParameterWithDefault {
   }
 
   /**
-   * A source of remote user input, considered as a flow source.
+   * A mutable default value for a parameter, considered as a flow source.
    */
   class MutableDefaultValue extends Source {
     boolean nonEmpty;
@@ -120,6 +120,9 @@ module ModificationOfParameterWithDefault {
     }
   }
 
+  /** 
+   * An expression that is checked directly in an `if`, possibly with `not`, such as `if x:` or `if not x:`.
+   */
   private class IdentityGuarded extends Expr {
     boolean inverted;
 
@@ -136,6 +139,9 @@ module ModificationOfParameterWithDefault {
       )
     }
 
+    /** 
+     * Whether this guard has been inverted. For `if x:` the result is `false`, and for `if not x:` the result is `true`.
+     */
     boolean isInverted() { result = inverted }
   }
 
diff --git a/python/ql/test/query-tests/Functions/ModificationOfParameterWithDefault/test.py b/python/ql/test/query-tests/Functions/ModificationOfParameterWithDefault/test.py
@@ -15,7 +15,7 @@ def list_del(l = [0]):
 
 # Not OK
 def append_op(l = []):
-    l += 1  #$ modification=l
+    l += [1, 2, 3]  #$ modification=l
     return l
 
 # Not OK
@@ -123,6 +123,6 @@ def dict_update_op_nochange(d = {}):
 
 # OK
 def sanitizer(l = []):
-    if not l == []:
+    if l:
         l.append(1)  #$ SPURIOUS: modification=l
     return l

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ module ModificationOfParameterWithDefault {`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`/**`
`56`		`- * A source of remote user input, considered as a flow source.`
	`56`	`+ * A mutable default value for a parameter, considered as a flow source.`
`57`	`57`	`*/`
`58`	`58`	`class MutableDefaultValue extends Source {`
`59`	`59`	`boolean nonEmpty;`
`@@ -120,6 +120,9 @@ module ModificationOfParameterWithDefault {`
`120`	`120`	`}`
`121`	`121`	`}`
`122`	`122`
	`123`	`+ /**`
	`124`	+ * An expression that is checked directly in an `if`, possibly with `not`, such as `if x:` or `if not x:`.
	`125`	`+ */`
`123`	`126`	`private class IdentityGuarded extends Expr {`
`124`	`127`	`boolean inverted;`
`125`	`128`
`@@ -136,6 +139,9 @@ module ModificationOfParameterWithDefault {`
`136`	`139`	`)`
`137`	`140`	`}`
`138`	`141`
	`142`	`+ /**`
	`143`	+ * Whether this guard has been inverted. For `if x:` the result is `false`, and for `if not x:` the result is `true`.
	`144`	`+ */`
`139`	`145`	`boolean isInverted() { result = inverted }`
`140`	`146`	`}`
`141`	`147`