Xarray¶

New in 0.31.0

Schemas and components for validating xarray.DataArray, xarray.Dataset, and xarray.DataTree. Typical imports use pandera.xarray; implementations live under pandera.api.xarray. See Xarray Data Validation for usage examples.

The pandera.xarray entry point also re-exports Check, Parser, the decorators (check_input(), etc.), and pandera.errors — see Core for those APIs.

Schemas¶

`pandera.api.xarray.container.DataArraySchema`	A lightweight xarray DataArray validator.
`pandera.api.xarray.container.DatasetSchema`	A lightweight xarray Dataset validator.
`pandera.api.xarray.container.DataTreeSchema`	Validate an `xarray.DataTree`.

Schema components¶

`pandera.api.xarray.components.DataVar`	Per-variable schema inside `DatasetSchema`.
`pandera.api.xarray.components.Coordinate`	Specification for one entry in `DataArraySchema(coords=...)`.

Declarative models¶

`pandera.api.xarray.model.DataArrayModel`	Declarative schema for a single `xarray.DataArray`.
`pandera.api.xarray.model.DatasetModel`	Declarative schema for an `xarray.Dataset`.
`pandera.api.xarray.model.DataTreeModel`	Declarative schema for an `xarray.DataTree`.

pandera.api.xarray.model_components.Field

Field specification for xarray models (mirrors dataframe Field()).

Typing¶

`pandera.typing.xarray.Coordinate`	Mark a field on `DataArrayModel` or `DatasetModel` as a coordinate schema.
`pandera.typing.xarray.DataArray`	Annotation-only generic for `xarray.DataArray`.
`pandera.typing.xarray.Dataset`	Annotation-only generic for `xarray.Dataset`.
`pandera.typing.xarray.DataTree`	Annotation-only generic for `xarray.DataTree`.
`pandera.typing.xarray.XarrayAnnotationBase`	Marker base for pandera xarray annotation types.

Model configuration¶

`pandera.api.xarray.model_config.DataArrayConfig`	Options for `DataArrayModel`.
`pandera.api.xarray.model_config.DatasetConfig`	Options for `DatasetModel`.
`pandera.api.xarray.model_config.DataTreeConfig`	Options for `DataTreeModel`.

Abstract base classes¶

`pandera.api.xarray.base.BaseDataArraySchema`	Base class for xarray `DataArray` schemas.
`pandera.api.xarray.base.BaseDatasetSchema`	Base class for xarray `Dataset` schemas.
`pandera.api.xarray.base.BaseDataTreeSchema`	Base class for xarray `DataTree` schemas.

Check object types¶

Types accepted by xarray Check backends and the XARRAY_CHECK_OBJECT_TYPES registry tuple.

`pandera.api.xarray.types.XarrayData`	Container passed to Check backends.
`pandera.api.xarray.types.XARRAY_CHECK_OBJECT_TYPES`	Built-in immutable sequence.
`pandera.api.xarray.types.XarrayCheckObjects`	Built-in immutable sequence.

Configuration¶

See also Core for the full configuration API.

`pandera.config.ValidationDepth`	Whether to apply checks at schema- or data-level, or both.
`pandera.config.ValidationScope`	Indicates whether a check/validator operates at a schema of data level.

Utilities¶

pandera.api.xarray.utils.get_validation_depth

Resolve ValidationDepth for an xarray object.

Schema inference¶

pandera.schema_inference.xarray.infer_schema

Infer schema for an xarray DataArray or Dataset.

IO (YAML / JSON)¶

Serialization helpers for xarray schemas (also re-exported from pandera.xarray).

`pandera.io.xarray_io.to_yaml`	Write a DataArraySchema or DatasetSchema to yaml.
`pandera.io.xarray_io.from_yaml`	Create a DataArraySchema or DatasetSchema from yaml.
`pandera.io.xarray_io.to_json`	Write a DataArraySchema or DatasetSchema to json.
`pandera.io.xarray_io.from_json`	Create a DataArraySchema or DatasetSchema from json.

Hypothesis strategies¶

Hypothesis strategies for generating DataArray / Dataset objects that match a schema. Requires the strategies extra.

`pandera.strategies.xarray_strategies.xarray_dtype_strategy`	Strategy to generate scalar values matching a numpy dtype.
`pandera.strategies.xarray_strategies.data_array_strategy`	Strategy to generate an `xarray.DataArray`.
`pandera.strategies.xarray_strategies.dataset_strategy`	Strategy to generate an `xarray.Dataset`.
`pandera.strategies.xarray_strategies.data_array_schema_strategy`	Create a strategy from a DataArraySchema.
`pandera.strategies.xarray_strategies.dataset_schema_strategy`	Create a strategy from a DatasetSchema.

Dtypes¶

See Data Types for DataType and Engine.