Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
📢 Pandera 0.31.0 introduces the pandera-xarray integration ! Validate all supported xarray data structures, including Dataset, DataArray, and DataTree. Learn more details here
pandera documentation
Logo
pandera documentation

Introduction

  • Welcome to Pandera
  • ▶️ Try Pandera
  • Official Website

Basics

  • DataFrame Schemas
  • DataFrame Models
  • Series Schemas
  • Data Type Validation
  • Validating with Checks
  • Pandera Data Types
  • Lazy Validation
  • Error Reports

Advanced

  • Hypothesis Testing
  • Preprocessing with Parsers
  • Decorators for Pipeline Integration
  • Dropping Invalid Rows
  • Schema Inference and Persistence
  • Data Synthesis Strategies
  • Data Format Conversion
  • Extensions
  • Configuration

Integrations

  • Supported DataFrame Libraries
    • Polars
    • Ibis
    • Pyspark SQL
    • Dask
    • Modin
    • Pyspark Pandas
    • GeoPandas
    • Fugue
  • Xarray Data Validation
    • DataArray Schemas
    • Dataset Schemas
    • DataTree Validation
    • Data Models
    • Checks and Parsers
    • Decorators
    • Configuration
    • Dask and Duck Arrays
    • Encoding Validation
    • Error reports and lazy validation
    • CF Convention Checks
    • Schema Inference
    • IO Serialization
    • Hypothesis Data Strategies
  • Ecosystem Integrations
    • FastAPI
    • Frictionless
    • Hypothesis
    • Mypy
    • Pydantic

Reference

  • API
    • Core
      • pandera.api.pandas.container.DataFrameSchema
      • pandera.api.geopandas.container.GeoDataFrameSchema
      • pandera.api.pandas.array.SeriesSchema
      • pandera.api.polars.container.DataFrameSchema
      • pandera.api.pyspark.container.DataFrameSchema
      • pandera.api.dataframe.container.DataFrameSchema
      • pandera.api.pandas.components.Column
      • pandera.api.pandas.components.Index
      • pandera.api.pandas.components.MultiIndex
      • pandera.api.polars.components.Column
      • pandera.api.pyspark.components.Column
      • pandera.api.dataframe.components.ComponentSchema
      • pandera.api.checks.Check
      • pandera.api.hypotheses.Hypothesis
      • pandera.api.polars.types.PolarsData
      • pandera.api.pyspark.types.PysparkDataframeColumnObject
      • pandera.config.PanderaConfig
      • pandera.config.ValidationDepth
      • pandera.config.ValidationScope
      • pandera.config.config_context
      • pandera.config.get_config_context
      • pandera.config.get_config_global
      • pandera.config.reset_config_context
    • GeoPandas
      • pandera.geopandas.GeoDataFrameModel
      • pandera.geopandas.GeoDataFrameSchema
    • Data Types
      • pandera.dtypes.DataType
      • pandera.dtypes.Bool
      • pandera.dtypes.Timestamp
      • pandera.dtypes.DateTime
      • pandera.dtypes.Timedelta
      • pandera.dtypes.Category
      • pandera.dtypes.Float
      • pandera.dtypes.Float16
      • pandera.dtypes.Float32
      • pandera.dtypes.Float64
      • pandera.dtypes.Float128
      • pandera.dtypes.Int
      • pandera.dtypes.Int8
      • pandera.dtypes.Int16
      • pandera.dtypes.Int32
      • pandera.dtypes.Int64
      • pandera.dtypes.UInt
      • pandera.dtypes.UInt8
      • pandera.dtypes.UInt16
      • pandera.dtypes.UInt32
      • pandera.dtypes.UInt64
      • pandera.dtypes.Complex
      • pandera.dtypes.Complex64
      • pandera.dtypes.Complex128
      • pandera.dtypes.Complex256
      • pandera.dtypes.Decimal
      • pandera.dtypes.String
      • pandera.engines.pandas_engine.BOOL
      • pandera.engines.pandas_engine.INT8
      • pandera.engines.pandas_engine.INT16
      • pandera.engines.pandas_engine.INT32
      • pandera.engines.pandas_engine.INT64
      • pandera.engines.pandas_engine.UINT8
      • pandera.engines.pandas_engine.UINT16
      • pandera.engines.pandas_engine.UINT32
      • pandera.engines.pandas_engine.UINT64
      • pandera.engines.pandas_engine.STRING
      • pandera.engines.numpy_engine.Object
      • pandera.engines.pandas_engine.Decimal
      • pandera.engines.pandas_engine.Category
      • pandera.engines.pandas_engine.STRING
      • pandera.engines.pandas_engine.NpString
      • pandera.engines.pandas_engine.DateTime
      • pandera.engines.pandas_engine.Date
      • pandera.engines.pandas_engine.Period
      • pandera.engines.pandas_engine.Sparse
      • pandera.engines.pandas_engine.Interval
      • pandera.engines.pandas_engine.PydanticModel
      • pandera.engines.pandas_engine.PythonDict
      • pandera.engines.pandas_engine.PythonList
      • pandera.engines.pandas_engine.PythonTuple
      • pandera.engines.pandas_engine.PythonTypedDict
      • pandera.engines.pandas_engine.PythonNamedTuple
      • pandera.engines.pandas_engine.ArrowBool
      • pandera.engines.pandas_engine.ArrowInt64
      • pandera.engines.pandas_engine.ArrowInt32
      • pandera.engines.pandas_engine.ArrowInt16
      • pandera.engines.pandas_engine.ArrowInt8
      • pandera.engines.pandas_engine.ArrowString
      • pandera.engines.pandas_engine.ArrowUInt64
      • pandera.engines.pandas_engine.ArrowUInt32
      • pandera.engines.pandas_engine.ArrowUInt16
      • pandera.engines.pandas_engine.ArrowUInt8
      • pandera.engines.pandas_engine.ArrowFloat64
      • pandera.engines.pandas_engine.ArrowFloat32
      • pandera.engines.pandas_engine.ArrowFloat16
      • pandera.engines.pandas_engine.ArrowDecimal128
      • pandera.engines.pandas_engine.ArrowTimestamp
      • pandera.engines.pandas_engine.ArrowDictionary
      • pandera.engines.pandas_engine.ArrowList
      • pandera.engines.pandas_engine.ArrowStruct
      • pandera.engines.pandas_engine.ArrowNull
      • pandera.engines.pandas_engine.ArrowDate32
      • pandera.engines.pandas_engine.ArrowDate64
      • pandera.engines.pandas_engine.ArrowDuration
      • pandera.engines.pandas_engine.ArrowTime32
      • pandera.engines.pandas_engine.ArrowTime64
      • pandera.engines.pandas_engine.ArrowTimestamp
      • pandera.engines.pandas_engine.ArrowBinary
      • pandera.engines.pandas_engine.ArrowLargeBinary
      • pandera.engines.pandas_engine.ArrowLargeString
      • pandera.engines.geopandas_engine.Geometry
      • pandera.engines.pandas_engine.PydanticModel
      • pandera.engines.polars_engine.Int8
      • pandera.engines.polars_engine.Int16
      • pandera.engines.polars_engine.Int32
      • pandera.engines.polars_engine.Int64
      • pandera.engines.polars_engine.UInt8
      • pandera.engines.polars_engine.UInt16
      • pandera.engines.polars_engine.UInt32
      • pandera.engines.polars_engine.UInt64
      • pandera.engines.polars_engine.Float32
      • pandera.engines.polars_engine.Float64
      • pandera.engines.polars_engine.Decimal
      • pandera.engines.polars_engine.Date
      • pandera.engines.polars_engine.DateTime
      • pandera.engines.polars_engine.Time
      • pandera.engines.polars_engine.Timedelta
      • pandera.engines.polars_engine.Array
      • pandera.engines.polars_engine.List
      • pandera.engines.polars_engine.Struct
      • pandera.engines.polars_engine.Bool
      • pandera.engines.polars_engine.String
      • pandera.engines.polars_engine.Enum
      • pandera.engines.polars_engine.Categorical
      • pandera.engines.polars_engine.Category
      • pandera.engines.polars_engine.Binary
      • pandera.engines.polars_engine.Null
      • pandera.engines.polars_engine.Object
      • pandera.dtypes.is_subdtype
      • pandera.dtypes.is_float
      • pandera.dtypes.is_int
      • pandera.dtypes.is_uint
      • pandera.dtypes.is_complex
      • pandera.dtypes.is_numeric
      • pandera.dtypes.is_bool
      • pandera.dtypes.is_string
      • pandera.dtypes.is_datetime
      • pandera.dtypes.is_timedelta
      • pandera.dtypes.immutable
      • pandera.engines.xarray_engine.DataType
      • pandera.engines.engine.Engine
      • pandera.engines.numpy_engine.Engine
      • pandera.engines.pandas_engine.Engine
      • pandera.engines.polars_engine.Engine
      • pandera.engines.pyspark_engine.Engine
      • pandera.engines.xarray_engine.Engine
    • DataFrame Models
      • pandera.api.pandas.model.DataFrameModel
      • pandera.api.polars.model.DataFrameModel
      • pandera.api.pyspark.model.DataFrameModel
      • pandera.api.dataframe.model.DataFrameModel
      • pandera.api.dataframe.model_components.Field
      • pandera.api.dataframe.model_components.check
      • pandera.api.dataframe.model_components.dataframe_check
      • pandera.api.dataframe.model_components.parser
      • pandera.api.dataframe.model_components.dataframe_parser
      • pandera.api.pandas.model_config.BaseConfig
      • pandera.api.polars.model_config.BaseConfig
      • pandera.api.pyspark.model_config.BaseConfig
      • pandera.typing.DataFrame
      • pandera.typing.Series
      • pandera.typing.Index
      • pandera.typing.geopandas.GeoDataFrame
      • pandera.typing.geopandas.GeoSeries
      • pandera.typing.dask.DataFrame
      • pandera.typing.dask.Series
      • pandera.typing.dask.Index
      • pandera.typing.pyspark.DataFrame
      • pandera.typing.pyspark.Series
      • pandera.typing.pyspark.Index
      • pandera.typing.modin.DataFrame
      • pandera.typing.modin.Series
      • pandera.typing.modin.Index
      • pandera.typing.fastapi.UploadFile
      • pandera.typing.formats.Formats
    • Decorators
      • pandera.decorators.check_input
      • pandera.decorators.check_output
      • pandera.decorators.check_io
      • pandera.decorators.check_types
    • Schema Inference
      • pandera.schema_inference.pandas.infer_schema
    • IO Utilities
      • pandera.io.pandas_io.from_yaml
      • pandera.io.pandas_io.to_yaml
      • pandera.io.pandas_io.to_script
      • pandera.io.pandas_io.from_json
      • pandera.io.pandas_io.to_json
      • pandera.io.polars_io.from_yaml
      • pandera.io.polars_io.to_yaml
      • pandera.io.polars_io.from_json
      • pandera.io.polars_io.to_json
      • pandera.io.pyspark_sql_io.from_yaml
      • pandera.io.pyspark_sql_io.to_yaml
      • pandera.io.pyspark_sql_io.from_json
      • pandera.io.pyspark_sql_io.to_json
      • pandera.io.ibis_io.from_yaml
      • pandera.io.ibis_io.to_yaml
      • pandera.io.ibis_io.from_json
      • pandera.io.ibis_io.to_json
    • Data Synthesis Strategies
      • pandera.strategies.pandas_strategies
    • Extensions
      • pandera.extensions
    • Errors
      • pandera.errors.SchemaError
      • pandera.errors.SchemaErrors
      • pandera.errors.SchemaInitError
      • pandera.errors.SchemaDefinitionError
    • Xarray
      • pandera.api.xarray.container.DataArraySchema
      • pandera.api.xarray.container.DatasetSchema
      • pandera.api.xarray.container.DataTreeSchema
      • pandera.api.xarray.components.DataVar
      • pandera.api.xarray.components.Coordinate
      • pandera.api.xarray.model.DataArrayModel
      • pandera.api.xarray.model.DatasetModel
      • pandera.api.xarray.model.DataTreeModel
      • pandera.api.xarray.model_components.Field
      • pandera.typing.xarray.Coordinate
      • pandera.typing.xarray.DataArray
      • pandera.typing.xarray.Dataset
      • pandera.typing.xarray.DataTree
      • pandera.typing.xarray.XarrayAnnotationBase
      • pandera.api.xarray.model_config.DataArrayConfig
      • pandera.api.xarray.model_config.DatasetConfig
      • pandera.api.xarray.model_config.DataTreeConfig
      • pandera.api.xarray.base.BaseDataArraySchema
      • pandera.api.xarray.base.BaseDatasetSchema
      • pandera.api.xarray.base.BaseDataTreeSchema
      • pandera.api.xarray.types.XarrayData
      • pandera.api.xarray.types.XARRAY_CHECK_OBJECT_TYPES
      • pandera.api.xarray.types.XarrayCheckObjects
      • pandera.config.ValidationDepth
      • pandera.config.ValidationScope
      • pandera.api.xarray.utils.get_validation_depth
      • pandera.schema_inference.xarray.infer_schema
      • pandera.io.xarray_io.to_yaml
      • pandera.io.xarray_io.from_yaml
      • pandera.io.xarray_io.to_json
      • pandera.io.xarray_io.from_json
      • pandera.strategies.xarray_strategies.xarray_dtype_strategy
      • pandera.strategies.xarray_strategies.data_array_strategy
      • pandera.strategies.xarray_strategies.dataset_strategy
      • pandera.strategies.xarray_strategies.data_array_schema_strategy
      • pandera.strategies.xarray_strategies.dataset_schema_strategy

Community

  • Contributing
Back to top
View this page
Edit this page

Errors¶

pandera.errors.SchemaError

Raised when object does not pass schema validation constraints.

pandera.errors.SchemaErrors

Raised when multiple schema are lazily collected into one error.

pandera.errors.SchemaInitError

Raised when schema initialization fails.

pandera.errors.SchemaDefinitionError

Raised when schema definition is invalid on object validation.

Next
pandera.errors.SchemaError
Previous
pandera.extensions
Copyright © 2026, Pandera developers
Made with Sphinx and @pradyunsg's Furo