FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Python: deprecate AstNode.getAFlowNode() and rewrite internal callers · github/codeql@717ff62 · GitHub

Python: deprecate AstNode.getAFlowNode() and rewrite internal callers · github/codeql@717ff62 · GitHub
Skip to content

Navigation Menu

Sign in
Sign in
Sign up

Commit 717ff62

Browse files
Copilot
authored and
yoff
committed
Python: deprecate AstNode.getAFlowNode() and rewrite internal callers
Preparatory refactor for the shared-CFG dataflow migration. Deprecates the AstNode.getAFlowNode() cached predicate on the public Python QL API and rewrites all ~140 internal callers across lib/, src/, test/, and tools/ from `expr.getAFlowNode() = cfgNode` to `cfgNode.getNode() = expr`, using ControlFlowNode.getNode() which already exists in Flow.qll. The predicate itself is preserved (with a deprecation note pointing at the new pattern) so external users do not experience churn — they can migrate at their own pace and the AST/CFG hierarchies still get the intended untangling once the deprecation eventually elapses. Semantic noop verified by: - All 361 lib/ + src/ queries compile clean. - All 122 ControlFlow + PointsTo library-tests pass. - All 64 dataflow library-tests pass. - All 113 Variables/Exceptions/Expressions/Statements/Functions/Imports/ Security/CWE-798/ModificationOfParameterWithDefault query-tests pass. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 8179bff commit 717ff62

68 files changed

Lines changed: 273 additions & 181 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎python/ql/lib/LegacyPointsTo.qll‎

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -213,9 +213,11 @@ class ExprWithPointsTo extends Expr {
213213
* Gets what this expression might "refer-to" in the given `context`.
214214
*/
215215
predicate refersTo(Context context, Object obj, ClassObject cls, AstNode origin) {
216-
this.getAFlowNode()
217-
.(ControlFlowNodeWithPointsTo)
218-
.refersTo(context, obj, cls, origin.getAFlowNode())
216+
exists(ControlFlowNode this_, ControlFlowNode origin_ |
217+
this_.getNode() = this and origin_.getNode() = origin
218+
|
219+
this_.(ControlFlowNodeWithPointsTo).refersTo(context, obj, cls, origin_)
220+
)
219221
}
220222

221223
/**
@@ -226,7 +228,11 @@ class ExprWithPointsTo extends Expr {
226228
*/
227229
pragma[nomagic]
228230
predicate refersTo(Object obj, AstNode origin) {
229-
this.getAFlowNode().(ControlFlowNodeWithPointsTo).refersTo(obj, origin.getAFlowNode())
231+
exists(ControlFlowNode this_, ControlFlowNode origin_ |
232+
this_.getNode() = this and origin_.getNode() = origin
233+
|
234+
this_.(ControlFlowNodeWithPointsTo).refersTo(obj, origin_)
235+
)
230236
}
231237

232238
/**
@@ -240,16 +246,22 @@ class ExprWithPointsTo extends Expr {
240246
* in the given `context`.
241247
*/
242248
predicate pointsTo(Context context, Value value, AstNode origin) {
243-
this.getAFlowNode()
244-
.(ControlFlowNodeWithPointsTo)
245-
.pointsTo(context, value, origin.getAFlowNode())
249+
exists(ControlFlowNode this_, ControlFlowNode origin_ |
250+
this_.getNode() = this and origin_.getNode() = origin
251+
|
252+
this_.(ControlFlowNodeWithPointsTo).pointsTo(context, value, origin_)
253+
)
246254
}
247255

248256
/**
249257
* Holds if this expression might "point-to" to `value` which is from `origin`.
250258
*/
251259
predicate pointsTo(Value value, AstNode origin) {
252-
this.getAFlowNode().(ControlFlowNodeWithPointsTo).pointsTo(value, origin.getAFlowNode())
260+
exists(ControlFlowNode this_, ControlFlowNode origin_ |
261+
this_.getNode() = this and origin_.getNode() = origin
262+
|
263+
this_.(ControlFlowNodeWithPointsTo).pointsTo(value, origin_)
264+
)
253265
}
254266

255267
/**
@@ -475,7 +487,10 @@ class FunctionMetricsWithPointsTo extends FunctionMetrics {
475487
not non_coupling_method(result) and
476488
exists(Call call | call.getScope() = this |
477489
exists(FunctionObject callee | callee.getFunction() = result |
478-
call.getAFlowNode().getFunction().(ControlFlowNodeWithPointsTo).refersTo(callee)
490+
exists(CallNode call_ |
491+
call_.getNode() = call and
492+
call_.getFunction().(ControlFlowNodeWithPointsTo).refersTo(callee)
493+
)
479494
)
480495
or
481496
exists(Attribute a | call.getFunc() = a |

‎python/ql/lib/analysis/DefinitionTracking.qll‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ private predicate jump_to_defn(ControlFlowNode use, Definition defn) {
6464
private predicate preferred_jump_to_defn(Expr use, Definition def) {
6565
not use instanceof ClassExpr and
6666
not use instanceof FunctionExpr and
67-
jump_to_defn(use.getAFlowNode(), def)
67+
exists(ControlFlowNode useNode | useNode.getNode() = use | jump_to_defn(useNode, def))
6868
}
6969

7070
private predicate unique_jump_to_defn(Expr use, Definition def) {
@@ -452,7 +452,7 @@ private predicate self_parameter_jump_to_defn_attribute(
452452
* This exists primarily for testing use `getPreferredDefinition()` instead.
453453
*/
454454
Definition getADefinition(Expr use) {
455-
jump_to_defn(use.getAFlowNode(), result) and
455+
exists(ControlFlowNode useNode | useNode.getNode() = use | jump_to_defn(useNode, result)) and
456456
not use instanceof Call and
457457
not use.isArtificial() and
458458
// Not the use itself

‎python/ql/lib/change-notes/2026-05-19-deprecate-getAFlowNode.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
category: deprecated
3+
---
4+
* The `AstNode.getAFlowNode()` predicate has been deprecated. Use `ControlFlowNode.getNode()` from the other direction instead: replace `e.getAFlowNode() = n` with `n.getNode() = e`. This is a preparatory step towards migrating the dataflow library off the legacy CFG; it has no semantic effect.
5+

‎python/ql/lib/semmle/python/AstExtended.qll‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,17 @@ abstract class AstNode extends AstNode_ {
1717
abstract Scope getScope();
1818

1919
/**
20+
* DEPRECATED: use `ControlFlowNode.getNode()` from the other direction instead;
21+
* that is, replace `e.getAFlowNode() = n` with `n.getNode() = e`. This API is
22+
* being removed to untangle the AST and CFG hierarchies in preparation for
23+
* migrating the dataflow library off the legacy CFG.
24+
*
2025
* Gets a flow node corresponding directly to this node.
2126
* NOTE: For some statements and other purely syntactic elements,
22-
* there may not be a `ControlFlowNode`
27+
* there may not be a `ControlFlowNode`.
2328
*/
2429
cached
25-
ControlFlowNode getAFlowNode() {
30+
deprecated ControlFlowNode getAFlowNode() {
2631
Stages::AST::ref() and
2732
py_flow_bb_node(result, this, _, _)
2833
}

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

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ class Expr extends Expr_, AstNode {
2828
/** Whether this expression may have a side effect (as determined purely from its syntax) */
2929
predicate hasSideEffects() {
3030
/* If an exception raised by this expression handled, count that as a side effect */
31-
this.getAFlowNode().getASuccessor().getNode() instanceof ExceptStmt
31+
exists(ControlFlowNode n | n.getNode() = this |
32+
n.getASuccessor().getNode() instanceof ExceptStmt
33+
)
3234
or
3335
this.getASubExpression().hasSideEffects()
3436
}
@@ -68,7 +70,7 @@ class Attribute extends Attribute_ {
6870
/* syntax: Expr.name */
6971
override Expr getASubExpression() { result = this.getObject() }
7072

71-
override AttrNode getAFlowNode() { result = super.getAFlowNode() }
73+
deprecated override AttrNode getAFlowNode() { result = super.getAFlowNode() }
7274

7375
/** Gets the name of this attribute. That is the `name` in `obj.name` */
7476
string getName() { result = Attribute_.super.getAttr() }
@@ -97,7 +99,7 @@ class Subscript extends Subscript_ {
9799

98100
Expr getObject() { result = Subscript_.super.getValue() }
99101

100-
override SubscriptNode getAFlowNode() { result = super.getAFlowNode() }
102+
deprecated override SubscriptNode getAFlowNode() { result = super.getAFlowNode() }
101103
}
102104

103105
/** A call expression, such as `func(...)` */
@@ -113,7 +115,7 @@ class Call extends Call_ {
113115

114116
override string toString() { result = this.getFunc().toString() + "()" }
115117

116-
override CallNode getAFlowNode() { result = super.getAFlowNode() }
118+
deprecated override CallNode getAFlowNode() { result = super.getAFlowNode() }
117119

118120
/** Gets a tuple (*) argument of this call. */
119121
Expr getStarargs() { result = this.getAPositionalArg().(Starred).getValue() }
@@ -201,7 +203,7 @@ class IfExp extends IfExp_ {
201203
result = this.getTest() or result = this.getBody() or result = this.getOrelse()
202204
}
203205

204-
override IfExprNode getAFlowNode() { result = super.getAFlowNode() }
206+
deprecated override IfExprNode getAFlowNode() { result = super.getAFlowNode() }
205207
}
206208

207209
/** A starred expression, such as the `*rest` in the assignment `first, *rest = seq` */
@@ -411,7 +413,7 @@ class PlaceHolder extends PlaceHolder_ {
411413

412414
override string toString() { result = "$" + this.getId() }
413415

414-
override NameNode getAFlowNode() { result = super.getAFlowNode() }
416+
deprecated override NameNode getAFlowNode() { result = super.getAFlowNode() }
415417
}
416418

417419
/** A tuple expression such as `( 1, 3, 5, 7, 9 )` */
@@ -478,7 +480,7 @@ class Name extends Name_ {
478480

479481
override string toString() { result = this.getId() }
480482

481-
override NameNode getAFlowNode() { result = super.getAFlowNode() }
483+
deprecated override NameNode getAFlowNode() { result = super.getAFlowNode() }
482484

483485
override predicate isArtificial() {
484486
/* Artificial variable names in comprehensions all start with "." */
@@ -585,7 +587,7 @@ abstract class NameConstant extends Name, ImmutableLiteral {
585587

586588
override predicate isConstant() { any() }
587589

588-
override NameConstantNode getAFlowNode() { result = Name.super.getAFlowNode() }
590+
deprecated override NameConstantNode getAFlowNode() { result = Name.super.getAFlowNode() }
589591

590592
override predicate isArtificial() { none() }
591593
}

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -555,27 +555,27 @@ class DefinitionNode extends ControlFlowNode {
555555
cached
556556
DefinitionNode() {
557557
Stages::AST::ref() and
558-
exists(Assign a | a.getATarget().getAFlowNode() = this)
558+
exists(Assign a | this.getNode() = a.getATarget())
559559
or
560-
exists(AssignExpr a | a.getTarget().getAFlowNode() = this)
560+
exists(AssignExpr a | this.getNode() = a.getTarget())
561561
or
562-
exists(AnnAssign a | a.getTarget().getAFlowNode() = this and exists(a.getValue()))
562+
exists(AnnAssign a | this.getNode() = a.getTarget() and exists(a.getValue()))
563563
or
564-
exists(Alias a | a.getAsname().getAFlowNode() = this)
564+
exists(Alias a | this.getNode() = a.getAsname())
565565
or
566566
augstore(_, this)
567567
or
568568
// `x, y = 1, 2` where LHS is a combination of list or tuples
569-
exists(Assign a | list_or_tuple_nested_element(a.getATarget()).getAFlowNode() = this)
569+
exists(Assign a | this.getNode() = list_or_tuple_nested_element(a.getATarget()))
570570
or
571-
exists(For for | for.getTarget().getAFlowNode() = this)
571+
exists(For for | this.getNode() = for.getTarget())
572572
or
573-
exists(Parameter param | this = param.asName().getAFlowNode() and exists(param.getDefault()))
573+
exists(Parameter param | this.getNode() = param.asName() and exists(param.getDefault()))
574574
}
575575

576576
/** flow node corresponding to the value assigned for the definition corresponding to this flow node */
577577
ControlFlowNode getValue() {
578-
result = assigned_value(this.getNode()).getAFlowNode() and
578+
result.getNode() = assigned_value(this.getNode()) and
579579
(
580580
result.getBasicBlock().dominates(this.getBasicBlock())
581581
or
@@ -584,7 +584,7 @@ class DefinitionNode extends ControlFlowNode {
584584
// since the default value for a parameter is evaluated in the same basic block as
585585
// the function definition, but the parameter belongs to the basic block of the function,
586586
// there is no dominance relationship between the two.
587-
exists(Parameter param | this = param.asName().getAFlowNode())
587+
exists(Parameter param | this.getNode() = param.asName())
588588
)
589589
}
590590
}
@@ -901,7 +901,7 @@ class ExceptFlowNode extends ControlFlowNode {
901901
exists(ExceptStmt ex |
902902
this.getBasicBlock().dominates(result.getBasicBlock()) and
903903
ex = this.getNode() and
904-
result = ex.getType().getAFlowNode()
904+
result.getNode() = ex.getType()
905905
)
906906
}
907907

@@ -913,7 +913,7 @@ class ExceptFlowNode extends ControlFlowNode {
913913
exists(ExceptStmt ex |
914914
this.getBasicBlock().dominates(result.getBasicBlock()) and
915915
ex = this.getNode() and
916-
result = ex.getName().getAFlowNode()
916+
result.getNode() = ex.getName()
917917
)
918918
}
919919
}
@@ -928,7 +928,7 @@ class ExceptGroupFlowNode extends ControlFlowNode {
928928
*/
929929
ControlFlowNode getType() {
930930
this.getBasicBlock().dominates(result.getBasicBlock()) and
931-
result = this.getNode().(ExceptGroupStmt).getType().getAFlowNode()
931+
result.getNode() = this.getNode().(ExceptGroupStmt).getType()
932932
}
933933

934934
/**
@@ -937,7 +937,7 @@ class ExceptGroupFlowNode extends ControlFlowNode {
937937
*/
938938
ControlFlowNode getName() {
939939
this.getBasicBlock().dominates(result.getBasicBlock()) and
940-
result = this.getNode().(ExceptGroupStmt).getName().getAFlowNode()
940+
result.getNode() = this.getNode().(ExceptGroupStmt).getName()
941941
}
942942
}
943943

‎python/ql/lib/semmle/python/Import.qll‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ class ImportMember extends ImportMember_ {
163163
result = this.getModule().(ImportExpr).getImportedModuleName() + "." + this.getName()
164164
}
165165

166-
override ImportMemberNode getAFlowNode() { result = super.getAFlowNode() }
166+
deprecated override ImportMemberNode getAFlowNode() { result = super.getAFlowNode() }
167167
}
168168

169169
/** An import statement */

‎python/ql/lib/semmle/python/SelfAttribute.qll‎

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,20 +46,23 @@ class SelfAttributeRead extends SelfAttribute {
4646
}
4747

4848
predicate guardedByHasattr() {
49-
exists(Variable var, ControlFlowNode n |
50-
var.getAUse() = this.getObject().getAFlowNode() and
49+
exists(Variable var, ControlFlowNode n, ControlFlowNode this_, ControlFlowNode obj_ |
50+
this_.getNode() = this and obj_.getNode() = this.getObject()
51+
|
52+
var.getAUse() = obj_ and
5153
hasattr(n, var.getAUse(), this.getName()) and
52-
n.strictlyDominates(this.getAFlowNode())
54+
n.strictlyDominates(this_)
5355
)
5456
}
5557

5658
pragma[noinline]
5759
predicate locallyDefined() {
58-
exists(SelfAttributeStore store |
59-
this.getName() = store.getName() and
60-
this.getScope() = store.getScope()
60+
exists(SelfAttributeStore store, ControlFlowNode store_, ControlFlowNode this_ |
61+
store_.getNode() = store and this_.getNode() = this
6162
|
62-
store.getAFlowNode().strictlyDominates(this.getAFlowNode())
63+
this.getName() = store.getName() and
64+
this.getScope() = store.getScope() and
65+
store_.strictlyDominates(this_)
6366
)
6467
}
6568
}

‎python/ql/lib/semmle/python/dataflow/new/BarrierGuards.qll‎

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,30 @@ private import semmle.python.dataflow.new.DataFlow
55

66
private predicate constCompare(DataFlow::GuardNode g, ControlFlowNode node, boolean branch) {
77
exists(CompareNode cn | cn = g |
8-
exists(ImmutableLiteral const, Cmpop op |
9-
op = any(Eq eq) and branch = true
10-
or
11-
op = any(NotEq ne) and branch = false
8+
exists(ImmutableLiteral const, Cmpop op, ControlFlowNode c |
9+
c.getNode() = const and
10+
(
11+
op = any(Eq eq) and branch = true
12+
or
13+
op = any(NotEq ne) and branch = false
14+
)
1215
|
13-
cn.operands(const.getAFlowNode(), op, node)
16+
cn.operands(c, op, node)
1417
or
15-
cn.operands(node, op, const.getAFlowNode())
18+
cn.operands(node, op, c)
1619
)
1720
or
18-
exists(NameConstant const, Cmpop op |
19-
op = any(Is is_) and branch = true
20-
or
21-
op = any(IsNot isn) and branch = false
21+
exists(NameConstant const, Cmpop op, ControlFlowNode c |
22+
c.getNode() = const and
23+
(
24+
op = any(Is is_) and branch = true
25+
or
26+
op = any(IsNot isn) and branch = false
27+
)
2228
|
23-
cn.operands(const.getAFlowNode(), op, node)
29+
cn.operands(c, op, node)
2430
or
25-
cn.operands(node, op, const.getAFlowNode())
31+
cn.operands(node, op, c)
2632
)
2733
or
2834
exists(IterableNode const_iterable, Cmpop op |

‎python/ql/lib/semmle/python/dataflow/new/internal/Attributes.qll‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ private class ClassDefinitionAsAttrWrite extends AttrWrite, CfgNode {
228228

229229
override Node getValue() { result.asCfgNode() = node.getValue() }
230230

231-
override Node getObject() { result.asCfgNode() = cls.getAFlowNode() }
231+
override Node getObject() { result.asCfgNode().getNode() = cls }
232232

233233
override ExprNode getAttributeNameExpr() { none() }
234234

0 commit comments

Comments
 (0)

Footer

© 2026 GitHub, Inc.
Back | FazBrowse Home | New Git URL