xarrayspecs.core module#

class xarrayspecs.core.AsDataArray[source]#

Bases: object

Mixin class for Xarray DataArray specifications.

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

class xarrayspecs.core.AsDataTree[source]#

Bases: object

Mixin class for Xarray DataTree specifications.

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

class xarrayspecs.core.AsDataset[source]#

Bases: object

Mixin class for Xarray Dataset specifications.

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

xarrayspecs.core.asdataarray(obj: HasFactory[P, T], /) → T[source]#
xarrayspecs.core.asdataarray(obj: Other[P], /) → DataArray: Convert given Xarray specifications to an Xarray DataArray.

xarrayspecs.core.asdataset(obj: HasFactory[P, T], /) → T[source]#
xarrayspecs.core.asdataset(obj: Other[P], /) → Dataset: Convert given Xarray specifications to an Xarray Dataset.

xarrayspecs.core.asdatatree(obj: HasFactory[P, T], /) → T[source]#
xarrayspecs.core.asdatatree(obj: Other[P], /) → DataTree: Convert given Xarray specifications to an Xarray DataTree.

xarrayspecs.core.attrs(**kwargs: Any) → Spec[source]#
xarrayspecs.core.attrs(mapping: Mapping[str, Any], /, **kwargs: Any) → Spec
xarrayspecs.core.attrs(iterable: Iterable[tuple[str, Any]], /, **kwargs: Any) → Spec: Returns a type specification for Xarray attributes.

xarrayspecs.core.dims() → Spec[source]#
xarrayspecs.core.dims(iterable: Iterable[Hashable], /) → Spec
xarrayspecs.core.dims(*hashable: Hashable) → Spec: Returns a type specification for Xarray dimensions.

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

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

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

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