API reference

This page contains a auto-generated summary of xarray-schema’s API.

Container schemas

DatasetSchema([data_vars, coords, attrs, checks])	A light-weight xarray.Dataset validator
DataArraySchema([dtype, shape, dims, name, ...])	A light-weight xarray.DataArray validator

Component schemas

DTypeSchema(dtype)	Datatype schema
DimsSchema(dims)	Dimensions schema
ShapeSchema(shape)	Shape schema
NameSchema(name)	Name schema
ChunksSchema(chunks)	Chunks schema
AttrSchema([type, value])	Attribute schema
AttrsSchema(attrs[, require_all_keys, ...])	Attributes schema
CoordsSchema(coords[, require_all_keys, ...])	Schema container for Coordinates

Internals

base.BaseSchema()
SchemaError	Custom Schema Error