zarr.errors#

Exceptions#

ArrayIndexError

Sequence index out of range.

ArrayNotFoundError

Raised when an array isn't found at a certain path.

BaseZarrError

Base error which all zarr errors are sub-classed from.

BoundsCheckError

Sequence index out of range.

ContainsArrayAndGroupError

Raised when both array and group metadata are found at the same path.

ContainsArrayError

Raised when an array already exists at a certain path.

ContainsGroupError

Raised when a group already exists at a certain path.

GroupNotFoundError

Raised when a group isn't found at a certain path.

MetadataValidationError

Raised when the Zarr metadata is invalid in some way

NegativeStepError

Sequence index out of range.

NodeTypeValidationError

Specialized exception when the node_type of the metadata document is incorrect.

UnstableSpecificationWarning

A warning raised to indicate that a feature is outside the Zarr specification.

VindexInvalidSelectionError

Sequence index out of range.

ZarrDeprecationWarning

A warning raised to indicate that a feature will be removed in a future release.

ZarrFutureWarning

A warning intended for end users raised to indicate deprecated features.

ZarrRuntimeWarning

A warning for dubious runtime behavior.

Module Contents#

exception zarr.errors.ArrayIndexError[source]#

Bases: IndexError

Sequence index out of range.

exception zarr.errors.ArrayNotFoundError(*args: object)[source]#

Bases: NodeNotFoundError

Raised when an array isn’t found at a certain path.

exception zarr.errors.BaseZarrError(*args: object)[source]#

Bases: ValueError

Base error which all zarr errors are sub-classed from.

exception zarr.errors.BoundsCheckError[source]#

Bases: IndexError

Sequence index out of range.

exception zarr.errors.ContainsArrayAndGroupError(*args: object)[source]#

Bases: BaseZarrError

Raised when both array and group metadata are found at the same path.

exception zarr.errors.ContainsArrayError(*args: object)[source]#

Bases: BaseZarrError

Raised when an array already exists at a certain path.

exception zarr.errors.ContainsGroupError(*args: object)[source]#

Bases: BaseZarrError

Raised when a group already exists at a certain path.

exception zarr.errors.GroupNotFoundError(*args: object)[source]#

Bases: NodeNotFoundError

Raised when a group isn’t found at a certain path.

exception zarr.errors.MetadataValidationError(*args: object)[source]#

Bases: BaseZarrError

Raised when the Zarr metadata is invalid in some way

exception zarr.errors.NegativeStepError[source]#

Bases: IndexError

Sequence index out of range.

exception zarr.errors.NodeTypeValidationError(*args: object)[source]#

Bases: MetadataValidationError

Specialized exception when the node_type of the metadata document is incorrect.

This can be raised when the value is invalid or unexpected given the context, for example an ‘array’ node when we expected a ‘group’.

exception zarr.errors.UnstableSpecificationWarning[source]#

Bases: ZarrFutureWarning

A warning raised to indicate that a feature is outside the Zarr specification.

exception zarr.errors.VindexInvalidSelectionError[source]#

Bases: IndexError

Sequence index out of range.

exception zarr.errors.ZarrDeprecationWarning[source]#

Bases: DeprecationWarning

A warning raised to indicate that a feature will be removed in a future release.

exception zarr.errors.ZarrFutureWarning[source]#

Bases: FutureWarning

A warning intended for end users raised to indicate deprecated features.

exception zarr.errors.ZarrRuntimeWarning[source]#

Bases: RuntimeWarning

A warning for dubious runtime behavior.