Merge pull request #10387 from RasmusWL/getStarArg-always-first

Python: `getStarArg` gives first `*args` argument

Author: yoff

python/ql/lib/change-notes/2022-09-12-getStarArg-first.md

@@ -0,0 +1,4 @@
+---
+category: minorAnalysis
+---
+* `getStarArg` member-predicate on `Call` and `CallNode` has been changed for calls that have multiple `*args` arguments (for example `func(42, *my_args, *other_args)`): Instead of producing no results, it will always have a result for the _first_ such `*args` argument.

python/ql/lib/semmle/python/Exprs.qll

@@ -245,10 +245,12 @@ class Call extends Call_ {
     result = count(Expr arg | arg = this.getAPositionalArg() and not arg instanceof Starred)
   }
 
-  /** Gets the tuple (*) argument of this call, provided there is exactly one. */
+  /** Gets the first tuple (*) argument of this call, if any. */
   Expr getStarArg() {
-    count(this.getStarargs()) < 2 and
-    result = this.getStarargs()
+    exists(int firstStarArgIndex |
+      firstStarArgIndex = min(int i | this.getPositionalArg(i) instanceof Starred | i) and
+      result = this.getPositionalArg(firstStarArgIndex).(Starred).getValue()
+    )
   }
 }
 

python/ql/lib/semmle/python/Flow.qll

@@ -406,7 +406,7 @@ class CallNode extends ControlFlowNode {
     exists(FunctionExpr func | this.getNode() = func.getADecoratorCall())
   }
 
-  /** Gets the tuple (*) argument of this call, provided there is exactly one. */
+  /** Gets the first tuple (*) argument of this call, if any. */
   ControlFlowNode getStarArg() {
     result.getNode() = this.getNode().getStarArg() and
     result.getBasicBlock().dominates(this.getBasicBlock())