All Classes (Python :: Frontend 3.12.0.9583 API)

All Classes Interface Summary Class Summary Enum Summary
Class	Description
AliasedName	Aliased name
AliasedNameImpl
AmbiguousDescriptor
AmbiguousSymbol
AmbiguousSymbolImpl
AnnotatedAssignment	`AnnotatedAssignment.variable()` `AnnotatedAssignment.annotation()` = `AnnotatedAssignment.assignedValue()`
AnnotatedAssignmentImpl
AnyParameter
ArgList
ArgListImpl
Argument	Common interface for `RegularArgument`, `UnpackingExpression`
AsPattern	As pattern
AsPatternImpl
AssertStatement	assert `AssertStatement.condition()`, `AssertStatement.message()`
AssertStatementImpl
AssignmentExpression	`AssignmentExpression.lhsName()` := `AssignmentExpression.expression()`
AssignmentExpressionImpl
AssignmentStatement	`AssignmentStatement.lhsExpressions()`, `AssignmentStatement.lhsExpressions()`, `AssignmentStatement.lhsExpressions()` = `AssignmentStatement.assignedValue()`
AssignmentStatementImpl
AwaitExpression	await `AwaitExpression.expression()`
AwaitExpressionImpl
BaseTreeVisitor	Default implementation of `TreeVisitor`.
BinaryExpression	`BinaryExpression.leftOperand()` `BinaryExpression.operator()` `BinaryExpression.rightOperand()`
BinaryExpressionImpl
BreakStatement	See https://docs.python.org/3/reference/simple_stmts.html#grammar-token-break-stmt
BreakStatementImpl
BuiltinSymbols
BuiltinTypes
CallExpression	`CallExpression.callee()` ( `CallExpression.argumentList()` )
CallExpressionImpl
CapturePattern	Capture Pattern
CapturePatternImpl
CaseBlock	Case block
CaseBlockImpl
CfgBlock
CfgBlockState
CfgBranchingBlock	A `CfgBlock` with 2 successors: represents a block ending with a condition which determines which successor is executed next.
CfgUtils
ClassDef	`ClassDef.decorators()` class `ClassDef.name()`( `ClassDef.args()` ): `ClassDef.docstring()` `ClassDef.body()`
ClassDefImpl
ClassDescriptor
ClassDescriptor.ClassDescriptorBuilder
ClassPattern	Class pattern
ClassPatternImpl
ClassSymbol
ClassSymbolImpl
CognitiveComplexityVisitor
CognitiveComplexityVisitor.SecondaryLocationConsumer
ComplexityVisitor
CompoundAssignmentStatement	`CompoundAssignmentStatement.lhsExpression()` `CompoundAssignmentStatement.compoundAssignmentToken()` `CompoundAssignmentStatement.rhsExpression()`
CompoundAssignmentStatementImpl
ComprehensionClause
ComprehensionExpression	`ComprehensionExpression.resultExpression()` `ComprehensionExpression.comprehensionFor()`
ComprehensionExpressionImpl
ComprehensionFor	for `ComprehensionFor.loopExpression()` in `ComprehensionFor.iterable()`
ComprehensionForImpl
ComprehensionIf	if `ComprehensionIf.condition()`
ComprehensionIfImpl
ConditionalExpression	`ConditionalExpression.trueExpression()` if `ConditionalExpression.condition()` else `ConditionalExpression.falseExpression()`
ConditionalExpressionImpl
ContinueStatement	See https://docs.python.org/3/reference/simple_stmts.html#the-continue-statement
ContinueStatementImpl
ControlFlowGraph
ControlFlowGraphBuilder
DeclaredType
Decorator	`@Decorator.name()` ( `Decorator.arguments()` )
DecoratorImpl	Even if decorator is not a statement, it extends `SimpleStatement` in order to properly resolve its last token as it's a newline token
DefinedVariablesAnalysis
DefinedVariablesAnalysis.DefinedVariables
DefinedVariablesAnalysis.VariableDefinition
DelStatement	del `DelStatement.expressions()`
DelStatementImpl
Descriptor
Descriptor.Kind
DescriptorUtils
DictCompExpression	Dictionary Comprehension
DictCompExpressionImpl
DictionaryLiteral	{ `DictionaryLiteral.elements()` }
DictionaryLiteralElement	It can be either `KeyValuePair` or `UnpackingExpression`
DictionaryLiteralImpl
DictOrSetLiteralImpl<E extends Tree>
DocstringExtractor	Extractor of docstring tokens.
DottedName	Example: `os.env` or `Crypto.Cipher.AES`
DottedNameImpl
DoubleStarPattern	Double Star Pattern (only used within mapping patterns)
DoubleStarPatternImpl
EllipsisExpression	Represents singleton Ellipsis object
EllipsisExpressionImpl
ElseClause	Common interface for ElseClause used in `IfStatement.elseBranch()`, `ForStatement.elseClause()`, `WhileStatement.elseClause()` and `TryStatement.elseClause()`
ElseClauseImpl
ExceptClause	except `ExceptClause.exception()` as `ExceptClause.exceptionInstance()`: `ExceptClause.body()`
ExceptClauseImpl
ExecStatement	Python 2 only.
ExecStatementImpl
Expression
ExpressionList	Example:
ExpressionListImpl
ExpressionStatement	See https://docs.python.org/3/reference/simple_stmts.html#grammar-token-expression-stmt
ExpressionStatementImpl
FileInput	Root of the AST.
FileInputImpl
FileLinesVisitor	Visitor that computes `CoreMetrics.NCLOC_DATA_KEY` and `CoreMetrics.COMMENT_LINES` metrics used by the DevCockpit.
FileMetrics
FinallyClause	finally: `FinallyClause.body()`
FinallyClauseImpl
FormatSpecifier
FormatSpecifierImpl
FormattedExpression
FormattedExpressionImpl
ForStatement	for `ForStatement.expressions()` in `ForStatement.testExpressions()`: `ForStatement.body()` `ForStatement.elseClause()`
ForStatementImpl
ForwardAnalysis	Data flow analysis operating on the CFG.
FStringChannel	A channel to handle the literal_char parts inside f-strings.
FStringParser
FunctionDef	`FunctionDef.decorators()` def `FunctionDef.name()` ( `FunctionLike.parameters()` ) `FunctionDef.returnTypeAnnotation()`: `FunctionDef.docstring()` `FunctionDef.body()`
FunctionDefImpl
FunctionDescriptor
FunctionDescriptor.FunctionDescriptorBuilder
FunctionDescriptor.Parameter
FunctionLike	Common interface for `FunctionDef` and `LambdaExpression`
FunctionSymbol
FunctionSymbol.Parameter
FunctionSymbolImpl
FunctionSymbolImpl.ParameterImpl
GlobalStatement	global `GlobalStatement.variables()`
GlobalStatementImpl
GroupPattern	Group Pattern
GroupPatternImpl
Guard	Guard
GuardImpl
HasSymbol
HasTypeDependencies
IfStatement	if-elif-else statement.
IfStatementImpl
ImportFrom	Import From statement
ImportFromImpl
ImportName	Import statement
ImportNameImpl
ImportStatement	Import statement See https://docs.python.org/3/reference/simple_stmts.html#grammar-token-import-stmt
IndentationChannel	http://docs.python.org/reference/lexical_analysis.html#indentation
InExpression	`BinaryExpression.leftOperand()` not in `BinaryExpression.rightOperand()`
InExpressionImpl
InferredType
InferredTypes
IsExpression	`BinaryExpression.leftOperand()` is not `BinaryExpression.rightOperand()`
IsExpressionImpl
IssueLocation
KeyValuePair	`KeyValuePair.key()` `KeyValuePair.colon()` `KeyValuePair.value()`
KeyValuePairImpl
KeyValuePattern	Key Value Pattern (only used within mapping patterns)
KeyValuePatternImpl
KeywordPattern	Keyword pattern Used only inside Class pattern
KeywordPatternImpl
LambdaExpression	lambda `FunctionLike.parameters()` : `LambdaExpression.expression()`
LambdaExpressionImpl
LexerState
ListLiteral	[ `ListLiteral.elements()` ]
ListLiteralImpl
LiteralPattern	Literal Pattern
LiteralPatternImpl
LiveVariablesAnalysis
LiveVariablesAnalysis.LiveVariables
LocationInFile
MappingPattern	Mapping Pattern
MappingPatternImpl
MatchStatement	Match statement
MatchStatementImpl
Name	See https://docs.python.org/3/reference/expressions.html#atom-identifiers
NameImpl
NewLineChannel	http://docs.python.org/reference/lexical_analysis.html#explicit-line-joining http://docs.python.org/reference/lexical_analysis.html#implicit-line-joining http://docs.python.org/reference/lexical_analysis.html#blank-lines
NoneExpression	See https://docs.python.org/3/library/constants.html#None
NoneExpressionImpl
NonlocalStatement	nonlocal `NonlocalStatement.variables()`
NonlocalStatementImpl
NumericLiteral
NumericLiteralImpl
OrPattern	OR pattern
OrPatternImpl
Parameter	`Parameter.name()` `Parameter.typeAnnotation()` = `Parameter.defaultValue()`
ParameterImpl
ParameterList	See https://docs.python.org/3/reference/compound_stmts.html#grammar-token-parameter-list
ParameterListImpl
ParenthesizedExpression	( `ParenthesizedExpression.expression()` )
ParenthesizedExpressionImpl
Parser	Use this class to parse Python module
PassStatement	https://docs.python.org/3/reference/simple_stmts.html#grammar-token-pass-stmt
PassStatementImpl
Pattern
PrintStatement	Python 2 only.
PrintStatementImpl
ProgramState
ProjectLevelSymbolTable
ProjectPythonVersion
PythonAnalyzerRegexSource
PythonCfgBlock
PythonCfgBranchingBlock
PythonCfgEndBlock
PythonCfgSimpleBlock
PythonCheck
PythonCheck.PreciseIssue
PythonConfiguration
PythonCustomRuleRepository	Extension point to create a custom rule repository for Python.
PythonFile
PythonGrammar
PythonKeyword	http://docs.python.org/reference/lexical_analysis.html#keywords
PythonLexer
PythonParser
PythonPunctuator
PythonRegexIssueLocation
PythonStringCharacterParser
PythonSubscriptionCheck
PythonTokenType
PythonTreeMaker
PythonVersionUtils
PythonVersionUtils.Version
PythonVisitorCheck
PythonVisitorContext
PyTree
QualifiedExpression	Qualified expression like "foo.bar"
QualifiedExpressionImpl
RaiseStatement	raise `RaiseStatement.expressions()` from `RaiseStatement.fromExpression()`
RaiseStatementImpl
ReachingDefinitionsAnalysis	https://en.wikipedia.org/wiki/Reaching_definition Data flow analysis to determinate what definitions may reach a given point in the code.
ReadWriteVisitor
ReadWriteVisitor.SymbolReadWrite
RegexContext
RegularArgument	`RegularArgument.keywordArgument()` = `RegularArgument.expression()`
RegularArgumentImpl
ReprExpression	Python 2 only.
ReprExpressionImpl
ReturnStatement	return `ReturnStatement.expressions()`
ReturnStatementImpl
Separators
SequencePattern	Sequence Pattern
SequencePatternImpl
SetLiteral	{ `SetLiteral.elements()` }
SetLiteralImpl
SimpleStatement
SliceExpression	`SliceExpression.object()`[`SliceExpression.sliceList()`]
SliceExpressionImpl
SliceItem	`SliceItem.lowerBound()` `SliceItem.boundSeparator()` `SliceItem.upperBound()` `SliceItem.strideSeparator()` `SliceItem.stride()`
SliceItemImpl
SliceList
SliceListImpl
StarPattern	Star Pattern Only used inside sequence patterns
StarPatternImpl
Statement
StatementList
StatementListImpl
StatementWithSeparator
StringElement	`StringElement.prefix()StringElement.value()`
StringElementImpl
StringLiteral	See https://docs.python.org/3/reference/lexical_analysis.html#string-literal-concatenation
StringLiteralImpl
StringLiteralsChannel	http://docs.python.org/reference/lexical_analysis.html#string-literals
SubscriptionCheck
SubscriptionCheck.Context
SubscriptionContext
SubscriptionExpression	`SubscriptionExpression.object()`[`SubscriptionExpression.subscripts()`]
SubscriptionExpressionImpl
SubscriptionVisitor
Symbol
Symbol.Kind
SymbolImpl
SymbolsProtos
SymbolsProtos.ClassSymbol	Protobuf type `protoblog.ClassSymbol`
SymbolsProtos.ClassSymbol.Builder	Protobuf type `protoblog.ClassSymbol`
SymbolsProtos.ClassSymbolOrBuilder
SymbolsProtos.FunctionSymbol	Protobuf type `protoblog.FunctionSymbol`
SymbolsProtos.FunctionSymbol.Builder	Protobuf type `protoblog.FunctionSymbol`
SymbolsProtos.FunctionSymbolOrBuilder
SymbolsProtos.ModuleSymbol	Protobuf type `protoblog.ModuleSymbol`
SymbolsProtos.ModuleSymbol.Builder	Protobuf type `protoblog.ModuleSymbol`
SymbolsProtos.ModuleSymbolOrBuilder
SymbolsProtos.OverloadedFunctionSymbol	Protobuf type `protoblog.OverloadedFunctionSymbol`
SymbolsProtos.OverloadedFunctionSymbol.Builder	Protobuf type `protoblog.OverloadedFunctionSymbol`
SymbolsProtos.OverloadedFunctionSymbolOrBuilder
SymbolsProtos.ParameterKind	Protobuf enum `protoblog.ParameterKind`
SymbolsProtos.ParameterSymbol	Protobuf type `protoblog.ParameterSymbol`
SymbolsProtos.ParameterSymbol.Builder	Protobuf type `protoblog.ParameterSymbol`
SymbolsProtos.ParameterSymbolOrBuilder
SymbolsProtos.Type	Protobuf type `protoblog.Type`
SymbolsProtos.Type.Builder	Protobuf type `protoblog.Type`
SymbolsProtos.TypeKind	Protobuf enum `protoblog.TypeKind`
SymbolsProtos.TypeOrBuilder
SymbolsProtos.VarSymbol	Protobuf type `protoblog.VarSymbol`
SymbolsProtos.VarSymbol.Builder	Protobuf type `protoblog.VarSymbol`
SymbolsProtos.VarSymbolOrBuilder
SymbolTableBuilder
SymbolUtils
TestPythonVisitorRunner
Token
TokenImpl
TokenLocation
Tree
Tree.Kind
TreeUtils
TreeVisitor
Trivia
TriviaImpl
TryStatement	try: `TryStatement.body()` `TryStatement.exceptClauses()` `TryStatement.elseClause()` `TryStatement.finallyClause()`
TryStatementImpl
Tuple	( `Tuple.elements()` )
TupleImpl
TupleParameter	Python 2 only
TupleParameterImpl
TypeAnnotation	: `TypeAnnotation.expression()`
TypeAnnotationImpl
TypeInference
TypeInferenceProgramState
TypeShed
UnaryExpression	`UnaryExpression.operator()` `UnaryExpression.expression()`
UnaryExpressionImpl
UnpackingExpression	`UnpackingExpression.starToken()` `UnpackingExpression.expression()`
UnpackingExpressionImpl
Usage
Usage.Kind
UsageImpl
ValuePattern	Value Pattern
ValuePatternImpl
VariableDescriptor
WhileStatement	while `WhileStatement.condition()`: `WhileStatement.body()` `WhileStatement.elseClause()`
WhileStatementImpl
WildcardPattern	Group Pattern
WildcardPatternImpl
WithItem	`WithItem.test()` as `WithItem.expression()`
WithStatement	with `WithStatement.withItems()` `WithStatement.statements()`
WithStatementImpl
WithStatementImpl.WithItemImpl
YieldExpression	yield `YieldExpression.expressions()`
YieldExpressionImpl
YieldStatement	See https://docs.python.org/3/reference/simple_stmts.html#grammar-token-yield-stmt
YieldStatementImpl