DataFrame Models

DataFrame Model

pandera.api.pandas.model.DataFrameModel(...)	Model of a pandas DataFrameSchema.
pandera.api.polars.model.DataFrameModel(...)	Model of a polars DataFrameSchema.
pandera.api.pyspark.model.DataFrameModel(...)	Definition of a DataFrameSchema.
pandera.api.dataframe.model.DataFrameModel(...)	Base class for the DataFrame model.

Model Components

pandera.api.dataframe.model_components.Field(*)	Column or index field specification of a DataFrameModel.
pandera.api.dataframe.model_components.check(*fields)	Defines DataFrameModel check methods for columns/indexes.
pandera.api.dataframe.model_components.dataframe_check([_fn])	Defines DataFrameModel check methods for dataframes.
pandera.api.dataframe.model_components.parser(...)	Defines DataFrameModel parse methods for columns/indexes.
pandera.api.dataframe.model_components.dataframe_parser([_fn])	Defines DataFrameModel parse methods for dataframes.

Config

pandera.api.pandas.model_config.BaseConfig	Define pandas DataFrameSchema-wide options.
pandera.api.polars.model_config.BaseConfig	Define polars DataFrameSchema-wide options.
pandera.api.pyspark.model_config.BaseConfig	Define DataFrameSchema-wide options.

Typing

Pandas

pandera.typing.DataFrame([data, index, ...])	A generic type for pandas.DataFrame.
pandera.typing.Series([data, index, dtype, ...])	Representation of pandas.Series, only used for type annotation.
pandera.typing.Index([data, dtype, copy, ...])	Representation of pandas.Index, only used for type annotation.

Geopandas

pandera.typing.geopandas.GeoDataFrame([...])	A generic type for geopandas.GeoDataFrame.
pandera.typing.geopandas.GeoSeries([data, ...])	Representation of geopandas.GeoSeries, only used for type annotation.

Dask

pandera.typing.dask.DataFrame(expr)	Representation of dask.dataframe.DataFrame, only used for type annotation.
pandera.typing.dask.Series(expr)	Representation of pandas.Series, only used for type annotation.
pandera.typing.dask.Index(expr)	Representation of pandas.Index, only used for type annotation.

Pyspark

pandera.typing.pyspark.DataFrame([data, ...])	Representation of dask.dataframe.DataFrame, only used for type annotation.
pandera.typing.pyspark.Series([data, index, ...])	Representation of pandas.Series, only used for type annotation.
pandera.typing.pyspark.Index([data, dtype, ...])	Representation of pandas.Index, only used for type annotation.

Modin

pandera.typing.modin.DataFrame([data, ...])	Representation of dask.dataframe.DataFrame, only used for type annotation.
pandera.typing.modin.Series([data, index, ...])	Representation of pandas.Series, only used for type annotation.
pandera.typing.modin.Index([data, dtype, ...])	Representation of pandas.Index, only used for type annotation.

FastAPI

pandera.typing.fastapi.UploadFile(data, ...)

Pandera-specific subclass of fastapi.UploadFile.

Serialization Formats

pandera.typing.formats.Formats(value)

Data container serialization formats.