arx.dataframe

`arx.dataframe`

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

title: DataFrame surface helpers for Arx.
summary: >-
  Adapt Arx surface dataframe syntax to IRx DataFrame nodes while keeping user-
  facing schema rules local to Arx.

Functions

`is_dataframe_type(data_type: astx.DataType | None) -> bool`

title: Return whether one type is a DataFrame type.
parameters:
  data_type:
    type: astx.DataType | None
returns:
  type: bool

`is_series_type(data_type: astx.DataType | None) -> bool`

title: Return whether one type is a Series type.
parameters:
  data_type:
    type: astx.DataType | None
returns:
  type: bool

`dataframe_type(columns: tuple[astx.DataFrameColumn, ...]) -> astx.DataFrameType`

title: Build one static-schema DataFrame surface type.
parameters:
  columns:
    type: tuple[astx.DataFrameColumn, Ellipsis]
returns:
  type: astx.DataFrameType

`runtime_dataframe_type() -> astx.DataFrameType`

title: Build one runtime-schema DataFrame surface type.
returns:
  type: astx.DataFrameType

`series_type(element_type: astx.DataType) -> astx.SeriesType`

title: Build one Series surface type.
parameters:
  element_type:
    type: astx.DataType
returns:
  type: astx.SeriesType

`binding_from_type(data_type: astx.DataType | None) -> DataFrameBinding | None`

title: Build one static DataFrame binding from one declared type.
parameters:
  data_type:
    type: astx.DataType | None
returns:
  type: DataFrameBinding | None

`attach_binding(node: astx.AST, binding: DataFrameBinding) -> None`

title: Attach static DataFrame metadata to one AST node.
parameters:
  node:
    type: astx.AST
  binding:
    type: DataFrameBinding

`coerce_expression(expr: astx.Expr, target_type: astx.DataType, *, context: str) -> astx.Expr`

title: Coerce one parsed expression into one declared DataFrame type.
parameters:
  expr:
    type: astx.Expr
  target_type:
    type: astx.DataType
  context:
    type: str
returns:
  type: astx.Expr

`column_type(binding: DataFrameBinding, column_name: str) -> astx.DataType | None`

title: Return the type of one DataFrame column.
parameters:
  binding:
    type: DataFrameBinding
  column_name:
    type: str
returns:
  type: astx.DataType | None

Classes

`DataFrameBinding`

title: Static DataFrame binding metadata.
attributes:
  schema:
    type: DataFrameSchema