API reference
python:astx:astx
module astx
astx
Source: packages/astx/src/astx/__init__.py:1
ASTx.
Modules
-
array — ASTx array AST nodes.
-
base — AST classes and functions.
-
binary_op — ASTx BinaryOp node specializations.
-
blocks — Module for different kind of ASTx blocks.
-
buffer — ASTx low-level buffer AST nodes.
-
callables — Module for callable ASTx.
-
classes — Module for classes definitions/declarations.
-
classes_ext — ASTx class AST nodes.
-
collections — ASTx collection helper AST nodes.
-
comprehensions — AST comprehension classes and functions.
-
context — ASTx context-manager AST nodes.
-
context_manager — ASTx class for With Statement (Context Manager).
-
data — Module for Variables.
-
dataframe — ASTx DataFrame AST nodes.
-
exceptions — Module for Exceptions.
-
ffi — ASTx public FFI AST types.
-
flows — Module for controle flow AST.
-
io — Language-neutral native file type.
-
iterables — ASTx iterable AST nodes.
-
literals — AST nodes for literals.
-
mixes — Module for mixing ASTx types from different modules.
-
modifiers — Modifications for ASTx, such as visibility, scope, etc.
-
modules — ASTx namespace AST types.
-
nullable — Nullable scalar and parameterized column modeling.
-
numeric_mode — Explicit numeric execution intent.
-
operators — ASTx classes for the operators.
-
packages — Define ASTx for more broader scope.
-
structs — ASTx struct AST nodes.
-
subscript — Module for subscripts definitions/declarations.
-
symbol_table — Symbol Table module for ASTx.
-
system — ASTx system AST nodes.
-
templates — ASTx template AST helpers.
-
tensor — ASTx Tensor AST nodes.
-
tools — Package for astx helper tools.
-
types — Collection of ASTx nodes used for types.
-
viz — AST graphic representation Module.
Classes
-
AST — AST main expression class.
-
ASTKind — The expression kind class used for downcasting.
-
ASTNodes — AST with a list of nodes, supporting type-specific elements.
-
AddBinOp — Specialized addition binary operation node.
-
AliasExpr — Represents an alias in an import statement.
-
AndOp — AST class for logical AND operation.
-
Argument — AST class for argument definition.
-
Arguments — AST class for argument definition.
-
ArrayInt32ArrayLength — Internal array helper AST node.
-
AssertStmt — AssertStmt AST class.
-
AssignmentBinOp — Specialized assignment binary operation node.
-
AssignmentExpr — AST class for assignment expressions.
-
AsyncForRangeLoopExpr — AST class for asynchronous `For` Range Expression.
-
AsyncForRangeLoopStmt — AST class for asynchronous `For` Range Statement.
-
AugAssign — AST class for augmented assignment.
-
AwaitExpr — AST class for AwaitExpr.
-
BaseFieldAccess — Explicit base-qualified instance field access expression.
-
BaseMethodCall — Explicit base-qualified instance method call expression.
-
BinaryOp — AST class for the binary operator.
-
BitAndBinOp — Specialized bitwise-and binary operation node.
-
BitOrBinOp — Specialized bitwise-or binary operation node.
-
BitXorBinOp — Specialized bitwise-xor binary operation node.
-
Block — The AST tree.
-
BoolBinaryOp — Base AST class for boolean binary operations.
-
BoolUnaryOp — Base AST class for boolean unary operations.
-
Boolean — Boolean data type expression.
-
BreakStmt — AST class for break statement.
-
BufferOwnerType — Internal opaque buffer owner handle type.
-
BufferViewDescriptor — Internal low-level buffer view descriptor literal.
-
BufferViewIndex — Internal low-level indexed read through a buffer view.
-
BufferViewRelease — Internal explicit runtime release for a buffer view owner.
-
BufferViewRetain — Internal explicit runtime retain for a buffer view owner.
-
BufferViewStore — Internal low-level indexed store through a buffer view.
-
BufferViewType — Internal canonical low-level buffer view descriptor type.
-
BufferViewWrite — Internal low-level raw byte write through a buffer view.
-
CaseStmt — AST class for a case in a Switch statement.
-
Cast — Cast AST node for type conversions.
-
CatchHandlerStmt — AST class for catch statements.
-
ClassConstruct — Class construction with ordered positional and keyword expressions.
-
ClassDeclStmt — AST class for class declaration.
-
ClassDefStmt — Explicit class definition statement.
-
ClassType — Named class type reference.
-
CollectionContains — Common collection containment query node.
-
CollectionCount — Common sequence count query node.
-
CollectionIndex — Common sequence index query node.
-
CollectionIsEmpty — Common collection emptiness query node.
-
CollectionLength — Common collection length query node.
-
CollectionType — Base class for collection data types.
-
ColumnType — Parameterized column storage type, not a standalone scalar.
-
CompareOp — AST class for comparison operators acting as properties.
-
Complex — Base class for complex numbers.
-
Complex32 — Complex32 data type class.
-
Complex64 — Complex64 data type class.
-
Comprehension — AST Comprehension class.
-
ComprehensionClause — AST node for generic comprehensions.
-
ContinueStmt — AST class for continue statement.
-
DataFrameColumn — Static DataFrame column schema entry.
-
DataFrameColumnAccess — Internal DataFrame column access by static column name.
-
DataFrameColumnCount — Internal DataFrame column-count query.
-
DataFrameLiteral — Internal Arrow C++ backed DataFrame literal node.
-
DataFrameLiteralColumn — One DataFrame literal column payload.
-
DataFrameRelease — Internal explicit release for DataFrame-backed storage.
-
DataFrameRetain — Internal explicit retain for DataFrame-backed storage.
-
DataFrameRowCount — Internal DataFrame row-count query.
-
DataFrameStringColumnAccess — Internal DataFrame column access by string key.
-
DataFrameType — Internal DataFrame semantic type.
-
DataType — AST main expression class.
-
DataTypeOps — Overload some magic functions used for the main operations.
-
Date — Date data type expression.
-
DateTime — DateTime data type expression.
-
DeleteStmt — AST class for 'del' statements.
-
DictComprehension — Internal dictionary comprehension node.
-
DictType — Dictionary data type expression.
-
DivBinOp — Specialized division binary operation node.
-
DoWhileExpr — AST class for `do-while` expression.
-
DoWhileStmt — AST class for `do-while` statement.
-
Ellipsis — AST class for Ellipsis expressions.
-
EnumDeclStmt — AST class for enum declaration.
-
EqBinOp — Specialized equality binary operation node.
-
ExceptionHandlerStmt — AST class for try statements.
-
Expr — AST main expression class.
-
ExprType — ExprType expression class.
-
FieldAccess — Field access expression.
-
FileType — An owned opaque text stream, distinct from arbitrary FFI handles.
-
FinallyHandlerStmt — AST class for finally statements.
-
Float16 — Float16 data type expression.
-
Float32 — Float32 data type expression.
-
Float64 — Float64 data type expression.
-
Floating — AST for the literal float number.
-
ForCountLoopExpr — AST class for a simple Count-Controlled `For` Loop expression.
-
ForCountLoopStmt — AST class for a simple Count-Controlled `For` Loop statement.
-
ForInLoopStmt — Internal for-in statement node.
-
ForRangeLoopExpr — AST class for `For` Range Expression.
-
ForRangeLoopStmt — AST class for `For` Range Statement.
-
FunctionAsyncDef — AST class for async function definition.
-
FunctionCall — AST class for function call.
-
FunctionDef — AST class for function definition.
-
FunctionPrototype — AST class for function prototype declaration.
-
FunctionReturn — AST class for function `return` statement.
-
GeBinOp — Specialized greater-than-or-equal binary operation node.
-
GeneratorExpr — AST class for generator expressions.
-
GeneratorType — First-class generator object type.
-
GotoStmt — AST class for function `Goto` statement.
-
GtBinOp — Specialized greater-than binary operation node.
-
Identifier — AST class for identifiers.
-
IfExpr — AST class for `if` expression.
-
IfStmt — AST class for `if` statement.
-
ImportExpr — Represents an import operation as an expression.
-
ImportFromExpr — Represents a 'from ... import ...' operation as an expression.
-
ImportFromStmt — Represents an import-from statement.
-
ImportStmt — Represents an import statement.
-
InlineVariableDeclaration — AST class for inline variable declaration expression.
-
Int16 — Int16 data type expression.
-
Int32 — Int32 data type expression.
-
Int64 — Int64 data type expression.
-
Int8 — Int8 data type expression.
-
Integer — Integer number data type expression.
-
IsInstanceExpr — IsInstanceExpr AST class.
-
KeywordArgument — One named call argument, preserving its source expression.
-
LambdaExpr — AST class for lambda expressions.
-
LeBinOp — Specialized less-than-or-equal binary operation node.
-
ListAppend — Internal list append node.
-
ListComprehension — ListComprehension class.
-
ListCreate — Internal empty-list constructor node.
-
ListExpr — Ordered expression-valued collection construction.
-
ListIndex — Internal list indexing node.
-
ListLength — Internal list length node.
-
ListType — List data type expression.
-
Literal — Literal Data type.
-
LiteralBoolean — LiteralBoolean data type class.
-
LiteralComplex — Base class for literal complex numbers.
-
LiteralComplex32 — LiteralComplex32 data type class.
-
LiteralComplex64 — LiteralComplex64 data type class.
-
LiteralDate — LiteralDate data type class.
-
LiteralDateTime — LiteralDateTime data type class.
-
LiteralDict — Literal representation of a Dictionary.
-
LiteralFloat — Exact decimal floating literal awaiting semantic contextualization.
-
LiteralFloat16 — LiteralFloat16 data type class.
-
LiteralFloat32 — LiteralFloat32 data type class.
-
LiteralFloat64 — LiteralFloat64 data type class.
-
LiteralInt128 — LiteralInt128 data type class.
-
LiteralInt16 — LiteralInt16 data type class.
-
LiteralInt32 — LiteralInt32 data type class.
-
LiteralInt64 — LiteralInt64 data type class.
-
LiteralInt8 — LiteralInt8 data type class.
-
LiteralInteger — Exact integer literal awaiting semantic contextualization.
-
LiteralList — Literal representation of a List.
-
LiteralNone — LiteralNone data type.
-
LiteralSet — Literal representation of a Set.
-
LiteralString — LiteralString data type class.
-
LiteralTime — LiteralTime data type class.
-
LiteralTimestamp — LiteralTimestamp data type class.
-
LiteralTuple — Literal representation of a Tuple.
-
LiteralUInt128 — LiteralUInt128 data type class.
-
LiteralUInt16 — LiteralUInt16 data type class.
-
LiteralUInt32 — LiteralUInt32 data type class.
-
LiteralUInt64 — LiteralUInt64 data type class.
-
LiteralUInt8 — LiteralUInt8 data type class.
-
LiteralUTF8Char — Literal class for UTF-8 characters.
-
LiteralUTF8String — Literal class for UTF-8 strings.
-
LogicalAndBinOp — Specialized logical-and binary operation node.
-
LogicalOrBinOp — Specialized logical-or binary operation node.
-
LtBinOp — Specialized less-than binary operation node.
-
MethodCall — Instance method call expression.
-
ModBinOp — Specialized modulo binary operation node.
-
Module — AST main expression class.
-
MulBinOp — Specialized multiplication binary operation node.
-
MutabilityKind — Definition for different kind of mutability.
-
NamespaceKind — Stable namespace categories.
-
NamespaceType — Semantic-only namespace type.
-
NandOp — AST class for logical NAND operation.
-
NeBinOp — Specialized inequality binary operation node.
-
NoneType — NoneType data type expression.
-
NorOp — AST class for logical NOR operation.
-
NotOp — AST class for logical NOT operation.
-
NullCheck — Test a scalar validity bit or produce a Series null mask.
-
NullFill — Replace nulls with an eagerly evaluated non-null scalar.
-
NullableType — A scalar value paired with an explicit validity bit.
-
Number — Number data type expression.
-
NumericMode — Explicit checked or modular numeric intent.
-
OpaqueHandleType — Stable public FFI opaque-handle type.
-
OperatorType — AST main expression class.
-
OrOp — AST class for logical OR operation.
-
Package — AST class for Package.
-
ParenthesizedExpr — AST class for explicitly grouped expressions (parentheses retained).
-
PointerType — Stable public FFI pointer type.
-
PrintExpr — PrintExpr AST class.
-
Program — AST class for Program.
-
ScopeKind — Definition for different kind of scopes.
-
SequenceType — Read-only ordered, sized, indexable sequence parameter contract.
-
SeriesReduction — Reduce a column using an explicit null-skipping aggregate.
-
SeriesRelease — Internal explicit release for Series-backed storage.
-
SeriesRetain — Internal explicit retain for Series-backed storage.
-
SeriesType — Internal Series semantic type.
-
SetComprehension — AST node representing set comprehension expressions.
-
SetType — Set data type expression.
-
SignedInteger — Signed integer number data type expression.
-
SourceLocation — Source coordinates attached to AST nodes.
-
Starred — AST class for starred expressions (*expr).
-
StatementType — AST main expression class.
-
StaticFieldAccess — Class-scoped static field access expression.
-
StaticMethodCall — Class-scoped static method call expression.
-
String — Base class for strings.
-
StructDeclStmt — AST class for struct declaration.
-
StructDefStmt — AST class for struct definition.
-
StructType — Named struct type reference.
-
SubBinOp — Specialized subtraction binary operation node.
-
SubscriptExpr — AST class for subscript expressions.
-
SwitchStmt — AST class for Switch statements based on Rust's match syntax.
-
Target — Define the Architecture target for the program.
-
TemplateParam — One compile-time template parameter.
-
TemplateTypeVar — Semantic-only template type variable.
-
TensorByteOffset — Internal Tensor byte-offset query for indexed addressing.
-
TensorElementCount — Internal Tensor element-count query.
-
TensorIndex — Internal Tensor indexed read.
-
TensorLiteral — Internal Arrow C++ backed Tensor literal node.
-
TensorNDim — Internal Tensor rank query.
-
TensorRelease — Internal explicit release for Tensor-backed storage.
-
TensorRetain — Internal explicit retain for Tensor-backed storage.
-
TensorShape — Internal Tensor shape-entry query.
-
TensorStore — Internal Tensor indexed store.
-
TensorStride — Internal Tensor stride-entry query.
-
TensorType — Internal Tensor semantic type.
-
TensorView — Internal Tensor view node.
-
ThrowStmt — AST class for throw statements.
-
Time — Time data type expression.
-
Timestamp — Timestamp data type expression.
-
TupleType — Tuple data type expression.
-
TypeCastExpr — AST class for type casting expressions.
-
TypeOfExpr — TypeOfExpr AST class.
-
UInt128 — UInt128 data type expression.
-
UInt16 — UInt16 data type expression.
-
UInt32 — UInt32 data type expression.
-
UInt64 — UInt64 data type expression.
-
UInt8 — UInt8 data type expression.
-
UTF8Char — Class for UTF-8 encoded characters.
-
UTF8String — Class for UTF-8 encoded strings.
-
UnaryOp — AST class for the unary operator.
-
Undefined — Undefined expression class.
-
UnionType — Finite compile-time union type domain.
-
UnsignedInteger — Unsigned integer number data type expression.
-
Variable — AST class for the variable usage.
-
VariableAssignment — AST class for variable declaration.
-
VariableDeclaration — AST class for variable declaration.
-
VisibilityKind — Definition of different kind of visibility.
-
WalrusOp — AST class for the Walrus (assignment expression) operator.
-
WhileExpr — AST class for `while` expression.
-
WhileStmt — AST class for `while` statement.
-
WithStmt — Internal context-manager statement node.
-
XnorOp — AST class for logical XNOR operation.
-
XorOp — AST class for logical XOR operation.
-
YieldExpr — AST class for YieldExpr.
-
YieldFromExpr — AST class for YieldFromExpr.
-
YieldStmt — AST class for yield statement.
Functions
-
add_generated_template_node — Attach one generated template node to a module.
-
binary_op_type_for_opcode — Return the specialized BinaryOp subclass for an opcode.
-
clear_generated_template_nodes — Remove generated template nodes attached to one module.
-
generated_template_nodes — Return the generated template nodes attached to a module.
-
get_template_args — Return the explicit template arguments attached to one AST node.
-
get_template_params — Return the template parameters attached to one AST node.
-
get_version — Return the program version.
-
is_template_node — Return whether one AST node carries template parameters.
-
is_template_specialization — Return whether one AST node is a generated specialization.
-
mark_template_specialization — Mark one AST node as a generated template specialization.
-
set_template_args — Attach explicit template arguments to one call-like AST node.
-
set_template_params — Attach template parameters to one AST node.
-
specialize_binary_op — Return a specialized BinaryOp instance for the given opcode.
-
template_specialization_name — Return the generated specialization name for one AST node.