astx.dataframe

`astx.dataframe`

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

title: ASTx DataFrame AST nodes.
summary: >-
  Provide internal nodes for Arrow C++ backed DataFrame and Series runtime
  values.

Classes

`DataFrameColumn`

title: Static DataFrame column schema entry.
attributes:
  name:
    type: str
  type_:
    type: astx.DataType
  nullable:
    type: bool

Methods

`get_struct(self, simplified: bool=False) -> dict[str, object]`

title: Return the structured representation of the column schema.
parameters:
  simplified:
    type: bool
returns:
  type: dict[str, object]

`DataFrameLiteralColumn`

title: One DataFrame literal column payload.
attributes:
  name:
    type: str
  values:
    type: tuple[astx.AST, Ellipsis]

Methods

`get_struct(self, simplified: bool=False) -> dict[str, object]`

title: Return the structured representation of the literal column.
parameters:
  simplified:
    type: bool
returns:
  type: dict[str, object]

`SeriesType(AnyType)`

title: Internal Series semantic type.
summary: >-
  Represent a one-dimensional typed DataFrame column backed by Arrow
  ChunkedArray storage.
attributes:
  element_type:
    type: astx.DataType | None
  nullable:
    type: bool
  size:
    type: int | None

`DataFrameType(AnyType)`

title: Internal DataFrame semantic type.
summary: >-
  Represent a heterogeneous named-column table backed by Arrow Table
  storage.
attributes:
  columns:
    type: tuple[DataFrameColumn, Ellipsis] | None
  row_count:
    type: int | None

`DataFrameLiteral(astx.base.DataType)`

title: Internal Arrow C++ backed DataFrame literal node.
summary: Build one Arrow C++ table from named column values.
attributes:
  columns:
    type: tuple[DataFrameLiteralColumn, Ellipsis]
  type_:
    type: DataFrameType

Methods

`get_struct(self, simplified: bool=False) -> astx.base.ReprStruct`

title: Return the structured representation of the DataFrame literal.
parameters:
  simplified:
    type: bool
returns:
  type: astx.base.ReprStruct

`DataFrameColumnAccess(astx.base.DataType)`

title: Internal DataFrame column access by static column name.
attributes:
  base:
    type: astx.AST
  column_name:
    type: str
  type_:
    type: SeriesType

Methods

`get_struct(self, simplified: bool=False) -> astx.base.ReprStruct`

title: Return the structured representation of the column access.
parameters:
  simplified:
    type: bool
returns:
  type: astx.base.ReprStruct

`DataFrameStringColumnAccess(DataFrameColumnAccess)`

title: Internal DataFrame column access by string key.
attributes:
  base:
    type: astx.AST
  column_name:
    type: str
  type_:
    type: SeriesType

Methods

`get_struct(self, simplified: bool=False) -> astx.base.ReprStruct`

title: Return the structured representation of the string access.
parameters:
  simplified:
    type: bool
returns:
  type: astx.base.ReprStruct

`DataFrameRowCount(astx.base.DataType)`

title: Internal DataFrame row-count query.
attributes:
  base:
    type: astx.AST
  type_:
    type: astx.Int64

Methods

`get_struct(self, simplified: bool=False) -> astx.base.ReprStruct`

title: Return the structured representation of the row-count query.
parameters:
  simplified:
    type: bool
returns:
  type: astx.base.ReprStruct

`DataFrameColumnCount(astx.base.DataType)`

title: Internal DataFrame column-count query.
attributes:
  base:
    type: astx.AST
  type_:
    type: astx.Int64

Methods

`get_struct(self, simplified: bool=False) -> astx.base.ReprStruct`

title: Return the structured representation of the column-count query.
parameters:
  simplified:
    type: bool
returns:
  type: astx.base.ReprStruct

`DataFrameRetain(astx.base.DataType)`

title: Internal explicit retain for DataFrame-backed storage.
attributes:
  base:
    type: astx.AST
  type_:
    type: astx.Int32

`DataFrameRelease(astx.base.DataType)`

title: Internal explicit release for DataFrame-backed storage.
attributes:
  base:
    type: astx.AST
  type_:
    type: astx.Int32

`SeriesRetain(astx.base.DataType)`

title: Internal explicit retain for Series-backed storage.
attributes:
  base:
    type: astx.AST
  type_:
    type: astx.Int32

`SeriesRelease(astx.base.DataType)`

title: Internal explicit release for Series-backed storage.
attributes:
  base:
    type: astx.AST
  type_:
    type: astx.Int32