Python: Add overlay annotations to AST classes #20972
Open
+87
−9
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
... and everything else that it depends on.
tausbn
force-pushed
the
tausbn/python-add-ast-overlay-annotations
branch
from
6930b04 to
09e1f8d
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds overlay annotations to Python QL AST-related classes and modules to support the overlay system. The changes involve adding module-level overlay[local] annotations and introducing final class wrappers to enable proper class extension patterns.
Key changes:
- Added
overlay[local]andoverlay[global]annotations to approximately 25 QL library files and modules - Introduced final class type aliases (e.g.,
final class FinalAstNode = AstNode) to support the overlay pattern - Refactored class inheritance to use
instanceofsyntax where appropriate
Reviewed changes
Copilot reviewed 30 out of 30 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| python/ql/src/analysis/ImportFailure.ql | Added final class wrapper and converted VersionTest to extend it, removed override keyword from toString |
| python/ql/src/Variables/LoopVariableCapture/LoopVariableCaptureQuery.qll | Added final class wrapper and converted ForLoop to use instanceof syntax |
| python/ql/lib/semmle/python/types/ImportTime.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/types/Builtins.qll | Added overlay[local?] module annotation with question mark |
| python/ql/lib/semmle/python/internal/CachedStages.qll | Added overlay[local] to AST module |
| python/ql/lib/semmle/python/essa/SsaDefinitions.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/essa/SsaCompute.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/essa/Essa.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/essa/Definitions.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/Variables.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/Stmts.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/Scope.qll | Added overlay[local] module annotation and overlay[global] to specific predicates |
| python/ql/lib/semmle/python/SSA.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/Patterns.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/Operations.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/Module.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/Keywords.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/Import.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/GuardedControlFlow.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/Function.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/Flow.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/Files.qll | Added overlay[local] module annotation and overlay[global] to getChildContainer method |
| python/ql/lib/semmle/python/Exprs.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/Constants.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/Comprehensions.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/Comment.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/Class.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/AstGenerated.qll | Added overlay[local] module annotation |
| python/ql/lib/semmle/python/AstExtended.qll | Added overlay[local] module annotation |
| python/ql/lib/analysis/DefinitionTracking.qll | Added final class wrapper and refactored NiceLocationExpr, removed redundant toString override |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -1,3 +1,6 @@ | |||
| overlay[local?] | |||
There was a problem hiding this comment.
The overlay annotation uses 'local?' with a question mark. This appears to be inconsistent with other files which use either 'local' or 'global'. If this is intentional to indicate optional behavior, it should be documented. If not, it should be corrected to match the standard 'overlay[local]' pattern used in other files.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WIP