hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-18 01:33:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

Python: Clear up attribute name access QLDoc

Browse Source
This commit is contained in:
Taus Brock-Nannestad
2020-10-12 13:49:08 +02:00
parent 60eec7b136
commit b07c7abacc
1 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
python/ql/src/experimental/dataflow/internal/Attributes.qll
View File

@@ -22,7 +22,11 @@ abstract class AttrRef extends Node {
*/
abstract ExprNode getAttributeNameExpr();
/** Holds if this attribute reference may access an attribute named `attrName`. */
/**
* Holds if this attribute reference may access an attribute named `attrName`.
* Uses local data flow to track potential attribute names, which may lead to imprecision. If more
* precision is needed, consider using `getAttributeName` instead.
*/
predicate mayHaveAttributeName(string attrName) {
attrName = this.getAttributeName()
or
@@ -32,7 +36,11 @@ abstract class AttrRef extends Node {
)
}
/** Gets the name of the attribute being read or written, if it can be determined statically. */
/**
* Gets the name of the attribute being read or written. Only holds if the attribute name has
* been uniquely determined statically. For attributes that are computed dynamically,
* consider using `mayHaveAttributeName` instead.
*/
abstract string getAttributeName();
}