zarr.errors
===========

.. py:module:: zarr.errors


Exceptions
----------

.. autoapisummary::

   zarr.errors.ArrayNotFoundError
   zarr.errors.BaseZarrError
   zarr.errors.ContainsArrayAndGroupError
   zarr.errors.ContainsArrayError
   zarr.errors.ContainsGroupError
   zarr.errors.GroupNotFoundError
   zarr.errors.MetadataValidationError
   zarr.errors.NodeTypeValidationError
   zarr.errors.UnstableSpecificationWarning
   zarr.errors.ZarrDeprecationWarning
   zarr.errors.ZarrFutureWarning
   zarr.errors.ZarrRuntimeWarning


Module Contents
---------------

.. py:exception:: ArrayNotFoundError(*args: Any)

   Bases: :py:obj:`NodeNotFoundError`


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
















   ..
       !! processed by numpydoc !!

.. py:exception:: BaseZarrError(*args: Any)

   Bases: :py:obj:`ValueError`


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
















   ..
       !! processed by numpydoc !!

.. py:exception:: ContainsArrayAndGroupError(*args: Any)

   Bases: :py:obj:`BaseZarrError`


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
















   ..
       !! processed by numpydoc !!

.. py:exception:: ContainsArrayError(*args: Any)

   Bases: :py:obj:`BaseZarrError`


   
   Raised when an array already exists at a certain path.
















   ..
       !! processed by numpydoc !!

.. py:exception:: ContainsGroupError(*args: Any)

   Bases: :py:obj:`BaseZarrError`


   
   Raised when a group already exists at a certain path.
















   ..
       !! processed by numpydoc !!

.. py:exception:: GroupNotFoundError(*args: Any)

   Bases: :py:obj:`NodeNotFoundError`


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
















   ..
       !! processed by numpydoc !!

.. py:exception:: MetadataValidationError(*args: Any)

   Bases: :py:obj:`BaseZarrError`


   
   Raised when the Zarr metadata is invalid in some way
















   ..
       !! processed by numpydoc !!

.. py:exception:: NodeTypeValidationError(*args: Any)

   Bases: :py:obj:`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'.















   ..
       !! processed by numpydoc !!

.. py:exception:: UnstableSpecificationWarning

   Bases: :py:obj:`ZarrFutureWarning`


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
















   ..
       !! processed by numpydoc !!

.. py:exception:: ZarrDeprecationWarning

   Bases: :py:obj:`DeprecationWarning`


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
















   ..
       !! processed by numpydoc !!

.. py:exception:: ZarrFutureWarning

   Bases: :py:obj:`FutureWarning`


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
















   ..
       !! processed by numpydoc !!

.. py:exception:: ZarrRuntimeWarning

   Bases: :py:obj:`RuntimeWarning`


   
   A warning for dubious runtime behavior.
















   ..
       !! processed by numpydoc !!