xarrayspecs package#

class xarrayspecs.AsDataArray[source]#

Bases: object

Mixin class for Xarray DataArray specifications.

classmethod new(*args: Any, **kwargs: Any) → Any[source]#: Convert the Xarray specifications to an Xarray DataArray.

class xarrayspecs.AsDataTree[source]#

Bases: object

Mixin class for Xarray DataTree specifications.

classmethod new(*args: Any, **kwargs: Any) → Any[source]#: Convert the Xarray specifications to an Xarray DataTree.

class xarrayspecs.AsDataset[source]#

Bases: object

Mixin class for Xarray Dataset specifications.

classmethod new(*args: Any, **kwargs: Any) → Any[source]#: Convert the Xarray specifications to an Xarray Dataset.

xarrayspecs.asdataarray(obj: Any, /) → Any[source]#: Convert given Xarray specifications to an Xarray DataArray.

xarrayspecs.asdataset(obj: Any, /) → Any[source]#: Convert given Xarray specifications to an Xarray Dataset.

xarrayspecs.asdatatree(obj: Any, /) → Any[source]#: Convert given Xarray specifications to an Xarray DataTree.

xarrayspecs.attrs(*args: Any, **kwargs: Any) → Spec[source]#: Returns a type specification for Xarray attributes.

xarrayspecs.dims(*args: Any) → Spec[source]#: Returns a type specification for Xarray dimensions.

xarrayspecs.dtype(dtype: Any | None, /) → Spec[source]#: Returns a type specification for Xarray data type.

xarrayspecs.name(name: Hashable | None, /) → Spec[source]#: Returns a type specification for Xarray name.

xarrayspecs.node(node: str | None, /) → Spec[source]#: Returns a type specification for Xarray node.

xarrayspecs.type(type: Callable[[...], Any] | None, /) → Spec[source]#: Returns a type specification for Xarray type.

xarrayspecs.use(use: Literal['attr', 'attrs', 'coord', 'coords', 'data', 'name', 'type', 'vars'] | None, /) → Spec[source]#: Returns a type specification for Xarray use.