dataeval.types.DataFrameOutput

class dataeval.types.DataFrameOutput(data)

An Output that wraps a Polars DataFrame and proxies its interface.

Attribute access, indexing, and iteration are delegated to the underlying DataFrame so instances can be used directly in DataFrame contexts. data() and meta() remain available alongside all DataFrame methods and properties.

Subclasses pass the required DataFrame as the first positional argument and may accept additional keyword arguments.

Warning

Return-type loss on DataFrame operations

Methods delegated via __getattr__() (e.g. filter, select, sort) return a plain polars.DataFrame, not an instance of the subclass. Any subclass-specific attributes such as calculation_results or meta() will not be available on the result.

Note

Instance attribute names to avoid in subclasses

Because instance attributes shadow the proxy, do not use any of the following names for subclass __init__ parameters or attributes: columns, schema, dtypes, shape, height, width.

Parameters:
data : pl.DataFrame

The underlying DataFrame.

data()

Return the output data as a polars DataFrame.

meta()

Metadata about the execution of the function or method for the Output class.

Return type:

ExecutionMetadata