astx.nullable

astx.nullable

Source: packages/astx/src/astx/nullable.py

title: Nullable scalar and parameterized column modeling.

Functions

column_type_name(value: DataType | str | int) -> str

title: Render deterministic parameter names, independent of AST counters.
parameters:
  value:
    type: DataType | str | int
returns:
  type: str

Classes

NullableType(AnyType)

title: A scalar value paired with an explicit validity bit.
attributes:
  value_type:
    type: DataType

Methods

get_struct(self, simplified: bool=False) -> ReprStruct
title: Render the node with all typed children.
parameters:
  simplified:
    type: bool
returns:
  type: ReprStruct

ColumnType(AnyType)

title: Parameterized column storage type, not a standalone scalar.
attributes:
  column_kind:
    type: str
  arguments:
    type: tuple[DataType | int | str, Ellipsis]

Methods

get_struct(self, simplified: bool=False) -> ReprStruct
title: Render the node with all typed children.
parameters:
  simplified:
    type: bool
returns:
  type: ReprStruct

NullCheck(DataType)

title: Test a scalar validity bit or produce a Series null mask.
attributes:
  value:
    type: Expr
  type_:
    type: DataType

Methods

get_struct(self, simplified: bool=False) -> ReprStruct
title: Render the node with all typed children.
parameters:
  simplified:
    type: bool
returns:
  type: ReprStruct

NullFill(DataType)

title: Replace nulls with an eagerly evaluated non-null scalar.
attributes:
  value:
    type: Expr
  replacement:
    type: Expr
  type_:
    type: DataType

Methods

get_struct(self, simplified: bool=False) -> ReprStruct
title: Render the node with all typed children.
parameters:
  simplified:
    type: bool
returns:
  type: ReprStruct

SeriesReduction(DataType)

title: Reduce a column using an explicit null-skipping aggregate.
attributes:
  operation:
    type: str
  value:
    type: Expr
  type_:
    type: DataType

Methods

get_struct(self, simplified: bool=False) -> ReprStruct
title: Include the operation and operand in structural output.
parameters:
  simplified:
    type: bool
returns:
  type: ReprStruct
Back to top