xarrayspecs.spec module#

xarrayspecs.spec.Dims#

Type hint for Xarray dimensions.

alias of Annotated[T, {‘xarray_dims’: <ITSELF>}]

xarrayspecs.spec.Dtype#

Type hint for Xarray data type.

alias of Annotated[T, {‘xarray_dtype’: <ITSELF>}]

xarrayspecs.spec.Type#

Type hint for Xarray type.

alias of Annotated[T, {‘xarray_type’: <ITSELF>}]

xarrayspecs.spec.attrs(attrs: Mapping[Any, Any] | None, /) Spec[source]#
xarrayspecs.spec.attrs(**attrs: Any) Spec

Returns a type specification for Xarray attributes.

xarrayspecs.spec.dims(dims: Iterable[Hashable] | None, /) Spec[source]#
xarrayspecs.spec.dims(*dims: Hashable) Spec

Returns a type specification for Xarray dimensions.

xarrayspecs.spec.dtype(dtype: Any | None, /) Spec[source]#

Returns a type specification for Xarray data type.

xarrayspecs.spec.name(name: Hashable | None, /) Spec[source]#

Returns a type specification for Xarray name.

xarrayspecs.spec.node(node: str | None, /) Spec[source]#

Returns a type specification for Xarray node.

xarrayspecs.spec.type(type: Callable[[...], Any] | None, /) Spec[source]#

Returns a type specification for Xarray type.

xarrayspecs.spec.use(use: Literal['attr', 'attrs', 'coord', 'coords', 'data', 'name', 'type', 'vars'] | None, /) Spec[source]#

Returns a type specification for Xarray use.