Python: rename sythetic nodes

yoff · yoff · commit 6e4011d2aef3 · 2023-12-18T23:16:51.000+01:00
Avoid the term "closure" as it is somewhat academic.
diff --git a/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowDispatch.qll b/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowDispatch.qll
@@ -42,6 +42,12 @@ private import semmle.python.dataflow.new.internal.TypeTracker::CallGraphConstru
 newtype TParameterPosition =
   /** Used for `self` in methods, and `cls` in classmethods. */
   TSelfParameterPosition() or
+  /**
+   * This is used for tracking flow through captured variables, and
+   * we use separate parameter/argument positions in order to distinguish
+   * "lambda self" from "normal self", as lambdas may also access outer `self`
+   * variables (through variable capture).
+   */
   TLambdaSelfParameterPosition() or
   TPositionalParameterPosition(int index) {
     index = any(Parameter p).getPosition()
@@ -135,6 +141,12 @@ class ParameterPosition extends TParameterPosition {
 newtype TArgumentPosition =
   /** Used for `self` in methods, and `cls` in classmethods. */
   TSelfArgumentPosition() or
+  /**
+   * This is used for tracking flow through captured variables, and
+   * we use separate parameter/argument positions in order to distinguish
+   * "lambda self" from "normal self", as lambdas may also access outer `self`
+   * variables (through variable capture).
+   */
   TLambdaSelfArgumentPosition() or
   TPositionalArgumentPosition(int index) {
     exists(any(CallNode c).getArg(index))
@@ -1521,20 +1533,19 @@ abstract class ParameterNodeImpl extends Node {
 }
 
 /**
- * The value of a closure itself at function entry, viewed as a node in the data
- * flow graph.
+ * A sythetic parameter representing the values of the variables captured
+ * by the callable being called. This parameter represents a single object
+ * where all the values are stored as attributes.
+ * This is also known as the environment part of a closure.
  *
- * This is used for tracking flow through captured variables, and we use
- * separate argument/parameter nodes at their own parameter/argument positions in order to distinguish
- * "lambda self" from "normal self", as lambdas may also access outer `self`
- * variables (through variable capture).
+ * This is used for tracking flow through captured variables.
  */
-class SynthCapturingClosureParameterNode extends ParameterNodeImpl,
-  TSynthCapturingClosureParameterNode
+class SynthCapturedVariablesParameterNode extends ParameterNodeImpl,
+  TSynthCapturedVariablesParameterNode
 {
   private Function callable;
 
-  SynthCapturingClosureParameterNode() { this = TSynthCapturingClosureParameterNode(callable) }
+  SynthCapturedVariablesParameterNode() { this = TSynthCapturedVariablesParameterNode(callable) }
 
   final Function getCallable() { result = callable }
 
@@ -1627,13 +1638,12 @@ private class SummaryPostUpdateNode extends FlowSummaryNode, PostUpdateNodeImpl
 }
 
 /**
- * The value of a closure itself being passed to the funciton, viewed as a
- * node in the data flow graph.
+ * A sythetic argument representing the values of the variables captured
+ * by the callable being called. This argument represents a single object
+ * where all the values are stored as attributes.
+ * This is also known as the environment part of a closure.
  *
- * This is used for tracking flow through captured variables, and we use a
- * separate node and parameter/argument positions in order to distinguish
- * "lambda self" from "normal self", as lambdas may also access outer `self`
- * variables (through variable capture).
+ * This is used for tracking flow through captured variables.
  *
  * TODO:
  * We might want a synthetic node here, but currently that incurs problems
@@ -1642,10 +1652,10 @@ private class SummaryPostUpdateNode extends FlowSummaryNode, PostUpdateNodeImpl
  * `CallGraphConstruction::Make` in staed of
  * `CallGraphConstruction::Simple::Make` appropriately.
  */
-class CapturingClosureArgumentNode extends CfgNode, ArgumentNode {
+class CapturedVariablesArgumentNode extends CfgNode, ArgumentNode {
   CallNode callNode;
 
-  CapturingClosureArgumentNode() {
+  CapturedVariablesArgumentNode() {
     node = callNode.getFunction() and
     exists(Function target | resolveCall(callNode, target, _) |
       target = any(VariableCapture::CapturedVariable v).getACapturingScope()
diff --git a/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowPrivate.qll b/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowPrivate.qll
@@ -1062,7 +1062,7 @@ predicate allowParameterReturnInSelf(ParameterNode p) {
   or
   exists(Function f |
     VariableCapture::Flow::heuristicAllowInstanceParameterReturnInSelf(f) and
-    p = TSynthCapturingClosureParameterNode(f)
+    p = TSynthCapturedVariablesParameterNode(f)
   )
 }
 
diff --git a/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowPublic.qll b/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowPublic.qll
@@ -118,7 +118,7 @@ newtype TNode =
   /** A synthetic node representing a captured variable. */
   TSynthCaptureNode(VariableCapture::Flow::SynthesizedCaptureNode cn) or
   /** A synthetic node representing the heap of a function. Used for variable capture. */
-  TSynthCapturingClosureParameterNode(Function f) {
+  TSynthCapturedVariablesParameterNode(Function f) {
     f = any(VariableCapture::CapturedVariable v).getACapturingScope() and
     // TODO: Remove this restriction when adding proper support for captured variables in the body of the function we generate for comprehensions
     exists(TFunction(f))
diff --git a/python/ql/lib/semmle/python/dataflow/new/internal/VariableCapture.qll b/python/ql/lib/semmle/python/dataflow/new/internal/VariableCapture.qll
@@ -133,7 +133,7 @@ private Flow::ClosureNode asClosureNode(Node n) {
   result.(Flow::ParameterNode).getParameter().getCfgNode() = n.(CfgNode).getNode()
   or
   result.(Flow::ThisParameterNode).getCallable() =
-    n.(SynthCapturingClosureParameterNode).getCallable()
+    n.(SynthCapturedVariablesParameterNode).getCallable()
 }
 
 predicate storeStep(Node nodeFrom, CapturedVariableContent c, Node nodeTo) {

Original file line number	Diff line number	Diff line change
`@@ -1062,7 +1062,7 @@ predicate allowParameterReturnInSelf(ParameterNode p) {`
`1062`	`1062`	`or`
`1063`	`1063`	`exists(Function f \|`
`1064`	`1064`	`VariableCapture::Flow::heuristicAllowInstanceParameterReturnInSelf(f) and`
`1065`		`- p = TSynthCapturingClosureParameterNode(f)`
	`1065`	`+ p = TSynthCapturedVariablesParameterNode(f)`
`1066`	`1066`	`)`
`1067`	`1067`	`}`
`1068`	`1068`
Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,7 @@ private Flow::ClosureNode asClosureNode(Node n) {`
`133`	`133`	`result.(Flow::ParameterNode).getParameter().getCfgNode() = n.(CfgNode).getNode()`
`134`	`134`	`or`
`135`	`135`	`result.(Flow::ThisParameterNode).getCallable() =`
`136`		`- n.(SynthCapturingClosureParameterNode).getCallable()`
	`136`	`+ n.(SynthCapturedVariablesParameterNode).getCallable()`
`137`	`137`	`}`
`138`	`138`
`139`	`139`	`predicate storeStep(Node nodeFrom, CapturedVariableContent c, Node nodeTo) {`