pandera.api.polars.model.DataFrameModel

class pandera.api.polars.model.DataFrameModel(*args, **kwargs)[source]

Model of a polars DataFrameSchema.

See the User Guide for more.

Validate a DataFrame based on the schema specification.

Parameters:

  • check_obj (pd.DataFrame) – the dataframe to be validated.

  • head – validate the first n rows. Rows overlapping with tail or sample are de-duplicated.

  • tail – validate the last n rows. Rows overlapping with head or sample are de-duplicated.

  • sample – validate a random sample of n rows. Rows overlapping with head or tail are de-duplicated.

  • random_state – random seed for the sample argument.

  • lazy – if True, lazily evaluates dataframe against all validation checks and raises a SchemaErrors. Otherwise, raise SchemaError as soon as one occurs.

  • inplace – if True, applies coercion to the object of validation, otherwise creates a copy of the data.

Returns:

validated DataFrame

Raises:

SchemaError – when DataFrame violates built-in or custom checks.

Methods

build_schema_

to_json_schema

Serialize schema metadata into json-schema format.