CodeQL library for Python
codeql/python-all 2.1.1-dev (changelog, source)
Search

Class Dict

A dictionary expression, such as {'key':'value'}

Import path

import python

Direct supertypes

Indirect supertypes

Predicates

getAChildNode

Gets a child node of this node in the AST. This predicate exists to aid exploration of the AST and other experiments. The child-parent relation may not be meaningful. For a more meaningful relation in terms of dependency use Expr.getASubExpression(), Stmt.getASubStatement(), Stmt.getASubExpression() or Scope.getAStmt().

getAKey

Gets the key of an item of this dict display, for those items that have keys E.g, in {‘a’:1, **b} this returns only ‘a’

getASubExpression

Gets an immediate (non-nested) sub-expression of this expression

getAValue

Gets the value of an item of this dict display

Inherited predicates

contains

Whether this contains inner syntactically

from AstNode
containsInScope

Whether this contains inner syntactically and inner has the same scope as this

from AstNode
defines

Whether this expression defines variable v If doing dataflow, then consider using SsaVariable.getDefinition() for more precision.

from Expr
getAFlowNode

Gets a flow node corresponding directly to this node. NOTE: For some statements and other purely syntactic elements, there may not be a ControlFlowNode

from AstNode
getAnItem

Gets an item of this dictionary expression.

from Dict_
getEnclosingModule

Gets the module in which this expression occurs

from Expr
getItem

Gets the nth item of this dictionary expression.

from Dict_
getItems

Gets the items of this dictionary expression.

from Dict_
getLocationfrom Expr
getParent

Gets a parent of this expression

from Expr_
getParentNode

Gets the parent node of this node in the AST. This predicate exists to aid exploration of the AST and other experiments. The child-parent relation may not be meaningful. For a more meaningful relation in terms of dependency use Expr.getASubExpression(), Stmt.getASubStatement(), Stmt.getASubExpression() or Scope.getAStmt() applied to the parent.

from AstNode
getScope

Gets the scope of this expression

from Expr
hasSideEffects

Whether this expression may have a side effect (as determined purely from its syntax)

from Expr
isArtificial

Whether this syntactic element is artificial, that is it is generated by the compiler and is not present in the source

from AstNode
isConstant

Whether this expression is a constant

from Expr
isParenthesised

Whether the parenthesised property of this expression is true.

from Expr_
isParenthesized

Whether the parenthesized property of this expression is true.

from Expr
pointsTo

Gets a value that this expression might “point-to”.

from Expr
pointsTo

Holds if this expression might “point-to” to value.

from Expr
pointsTo

Holds if this expression might “point-to” to value which is from origin.

from Expr
pointsTo

Holds if this expression might “point-to” to value which is from origin in the given context.

from Expr
refersTo

NOTE: refersTo will be deprecated in 2019. Use pointsTo instead. Equivalent to this.refersTo(value, _)

from Expr
refersTo

NOTE: refersTo will be deprecated in 2019. Use pointsTo instead. Holds if this expression might “refer-to” to value which is from origin Unlike this.refersTo(value, _, origin), this predicate includes results where the class cannot be inferred.

from Expr
refersTo

NOTE: refersTo will be deprecated in 2019. Use pointsTo instead. Gets what this expression might “refer-to”. Performs a combination of localized (intra-procedural) points-to analysis and global module-level analysis. This points-to analysis favours precision over recall. It is highly precise, but may not provide information for a significant number of flow-nodes. If the class is unimportant then use refersTo(value) or refersTo(value, origin) instead. NOTE: For complex dataflow, involving multiple stages of points-to analysis, it may be more precise to use ControlFlowNode.refersTo(...) instead.

from Expr
refersTo

NOTE: refersTo will be deprecated in 2019. Use pointsTo instead. Gets what this expression might “refer-to” in the given context.

from Expr
toString

Gets a textual representation of this element.

from Dict_