pandera.api.xarray.container.DataTreeSchema¶

class pandera.api.xarray.container.DataTreeSchema(children=None, dataset=None, attrs=None, checks=None, strict=False, name=None, title=None, description=None, metadata=None)[source]¶

Validate an xarray.DataTree.

A DataTree is a hierarchical tree of datasets. This schema validates both the node-level dataset (via dataset) and the child nodes (via children). Children can be specified by direct name or /-separated paths.

Initialize a DataTreeSchema.

Parameters:

children (UnionType[dict[str, UnionType[DatasetSchema, DataTreeSchema]], None]) – mapping of child node names (or /-separated paths) to DatasetSchema or DataTreeSchema.
dataset (UnionType[DatasetSchema, None]) – schema for the dataset at this node.
attrs (UnionType[dict[str, Any], None]) – expected node-level attributes.
checks (Union[Check, list[Union[Check, Hypothesis]], None]) – checks applied to the tree node.
strict (bool) – if True, fail on unexpected child nodes.
name (UnionType[str, None]) – schema name.
title (UnionType[str, None]) – A human-readable label for the schema.
description (UnionType[str, None]) – An arbitrary textual description of the schema.
metadata (UnionType[dict, None]) – An optional key-value data.

Attributes

`BACKEND_REGISTRY`
`properties`	Get the properties of the schema for serialization purposes.

Methods

__init__(children=None, dataset=None, attrs=None, checks=None, strict=False, name=None, title=None, description=None, metadata=None)[source]¶

Initialize a DataTreeSchema.

Parameters:

children (UnionType[dict[str, UnionType[DatasetSchema, DataTreeSchema]], None]) – mapping of child node names (or /-separated paths) to DatasetSchema or DataTreeSchema.
dataset (UnionType[DatasetSchema, None]) – schema for the dataset at this node.
attrs (UnionType[dict[str, Any], None]) – expected node-level attributes.
checks (Union[Check, list[Union[Check, Hypothesis]], None]) – checks applied to the tree node.
strict (bool) – if True, fail on unexpected child nodes.
name (UnionType[str, None]) – schema name.
title (UnionType[str, None]) – A human-readable label for the schema.
description (UnionType[str, None]) – An arbitrary textual description of the schema.
metadata (UnionType[dict, None]) – An optional key-value data.

static register_default_backends(check_obj_cls)[source]¶

This method is invoked in the get_backend method so that the appropriate validation backend is loaded at validation time instead of schema-definition time.

This method needs to be implemented by the schema subclass.

validate(check_obj, head=None, tail=None, sample=None, random_state=None, lazy=False, inplace=False)[source]¶

Validate a DataTree.

Parameters:

check_obj (DataTree) – the DataTree to validate.
lazy (bool) – if True, collect all errors before raising.

Return type:

DataTree

Returns:

validated DataTree.