Skip to content

Prepare dataflow for local annotations #21138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tausbn merged 9 commits into from
Feb 12, 2026
Merged

Prepare dataflow for local annotations #21138

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4543c66
Python: Prepare `LocalSourceNode` for locality
tausbn Jan 9, 2026
30ce406
Python: Remove global restriction on `ModuleVariableNode`
tausbn Jan 9, 2026
ac5a744
Python: Fix tests
tausbn Jan 12, 2026
7fccc23
Python: Make `ExtractedArgumentNode` local
tausbn Jan 26, 2026
6113d4b
Python: Fix test issues
tausbn Jan 26, 2026
3f71812
Python: Make capturing closure arguments synthetic and non-global
tausbn Jan 29, 2026
fb6175d
Python: Fix consistency test failures
tausbn Jan 29, 2026
958c798
Python: Accept dataflow test changes
tausbn Jan 29, 2026
62fb38d
Python: Rename `otherArgs` to `implicitArgumentNode`
tausbn Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 8 additions & 14 deletions python/ql/lib/semmle/python/dataflow/new/internal/DataFlowPublic.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,15 +76,7 @@ newtype TNode =
node.getNode() = any(Comp c).getIterable()
} or
/** A node representing a global (module-level) variable in a specific module. */
TModuleVariableNode(Module m, GlobalVariable v) {
v.getScope() = m and
(
v.escapes()
or
isAccessedThroughImportStar(m) and
ImportStar::globalNameDefinedInModule(v.getId(), m)
Comment on lines -82 to -85
Copy link
Contributor

@yoff yoff Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose v.escapes() could be kept, but the other branch would have to be over-approximated. Well, if it is not too expensive to just have all of them, then that is fine.

Copy link
Contributor Author

@tausbn tausbn Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I considered doing a more fine-grained over-approximation (as we've done elsewhere), but in this case the benefit seemed limited.

)
} or
TModuleVariableNode(Module m, GlobalVariable v) { v.getScope() = m } or
/**
* A synthetic node representing that an iterable sequence flows to consumer.
*/
Expand Down Expand Up @@ -440,13 +432,17 @@ class ModuleVariableNode extends Node, TModuleVariableNode {

/** Gets a node that reads this variable. */
Node getARead() {
result.asCfgNode() = var.getALoad().getAFlowNode() and
// Ignore reads that happen when the module is imported. These are only executed once.
not result.getScope() = mod
result = this.getALocalRead()
or
this = import_star_read(result)
}

/** Gets a node that reads this variable, excluding reads that happen through `from ... import *`. */
Node getALocalRead() {
result.asCfgNode() = var.getALoad().getAFlowNode() and
not result.getScope() = mod
}

/** Gets an `EssaNode` that corresponds to an assignment of this global variable. */
Node getAWrite() {
any(EssaNodeDefinition def).definedBy(var, result.asCfgNode().(DefinitionNode))
Expand All @@ -466,8 +462,6 @@ class ModuleVariableNode extends Node, TModuleVariableNode {
override Location getLocation() { result = mod.getLocation() }
}

private predicate isAccessedThroughImportStar(Module m) { m = ImportStar::getStarImported(_) }

private ModuleVariableNode import_star_read(Node n) {
resolved_import_star_module(result.getModule(), result.getVariable().getId(), n)
}
Expand Down
4 changes: 2 additions & 2 deletions python/ql/lib/semmle/python/dataflow/new/internal/LocalSources.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ class LocalSourceNode extends Node {
or
// We explicitly include any read of a global variable, as some of these may have local flow going
// into them.
this = any(ModuleVariableNode mvn).getARead()
this = any(ModuleVariableNode v).getALocalRead()
or
// We include all scope entry definitions, as these act as the local source within the scope they
// enter.
Expand Down Expand Up @@ -248,7 +248,7 @@ private module Cached {
pragma[nomagic]
private predicate localSourceFlowStep(Node nodeFrom, Node nodeTo) {
simpleLocalFlowStep(nodeFrom, nodeTo, _) and
not nodeTo = any(ModuleVariableNode v).getARead()
not nodeTo = any(ModuleVariableNode v).getALocalRead()
}

/**
Expand Down