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

Class With

A with statement such as with f as open("file"): text = f.read()

Import path

import python

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getASubExpression

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

getASubStatement

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

getLastStatement

Gets the final statement in this statement, ordered by location. Will be this statement if not a compound statement.

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
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().

from Stmt
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
getAStmt

Gets a statement of this with statement.

from With_
getASubPattern

Gets an immediate (non-nested) sub-pattern of this statement

from Stmt
getAnEntryNode

Gets a control flow node for an entry into this statement.

from Stmt
getBody

Gets the body of this with statement.

from With_
getContextExpr

Gets the context manager of this with statement.

from With_
getEnclosingModule

Gets the module enclosing this statement

from Stmt
getLocationfrom Stmt
getOptionalVars

Gets the optional variable of this with statement.

from With_
getParent

Gets a parent of this statement

from Stmt_
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 immediately enclosing this statement

from Stmt
getStmt

Gets the nth statement of this with statement.

from With_
isArtificial

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

from AstNode
isAsync

Whether the async property of this with statement is true.

from With_
isUnreachable

Holds if this statement cannot be reached

from Stmt
toStringfrom With_