.. _iris.exceptions:

===============
iris.exceptions
===============



.. currentmodule:: iris

.. automodule:: iris.exceptions

In this module:

 * :py:obj:`AncillaryVariableNotFoundError`
 * :py:obj:`CannotAddError`
 * :py:obj:`CellMeasureNotFoundError`
 * :py:obj:`ConcatenateError`
 * :py:obj:`ConnectivityNotFoundError`
 * :py:obj:`ConstraintMismatchError`
 * :py:obj:`CoordinateCollapseError`
 * :py:obj:`CoordinateMultiDimError`
 * :py:obj:`CoordinateNotFoundError`
 * :py:obj:`CoordinateNotRegularError`
 * :py:obj:`DuplicateDataError`
 * :py:obj:`IgnoreCubeException`
 * :py:obj:`InvalidCubeError`
 * :py:obj:`IrisError`
 * :py:obj:`LazyAggregatorError`
 * :py:obj:`MergeError`
 * :py:obj:`NotYetImplementedError`
 * :py:obj:`TranslationError`
 * :py:obj:`UnitConversionError`


Raised when a search yields no ancillary variables.

..

    .. autoclass:: iris.exceptions.AncillaryVariableNotFoundError
        :members:
        :undoc-members:
        :inherited-members:


.. raw:: html

    <p class="hr_p"><a href="#">&uarr;&#32&#32 top &#32&#32&uarr;</a></p>
    <!--

-----------

.. raw:: html

    -->


Raised when an object (e.g. coord) cannot be added to a :class:`~iris.cube.Cube`.

..

    .. autoclass:: iris.exceptions.CannotAddError
        :members:
        :undoc-members:
        :inherited-members:


.. raw:: html

    <p class="hr_p"><a href="#">&uarr;&#32&#32 top &#32&#32&uarr;</a></p>
    <!--

-----------

.. raw:: html

    -->


Raised when a search yields no cell measures.

..

    .. autoclass:: iris.exceptions.CellMeasureNotFoundError
        :members:
        :undoc-members:
        :inherited-members:


.. raw:: html

    <p class="hr_p"><a href="#">&uarr;&#32&#32 top &#32&#32&uarr;</a></p>
    <!--

-----------

.. raw:: html

    -->


Raised when concatenate is expected to produce a single cube, but fails to
do so.

..

    .. autoclass:: iris.exceptions.ConcatenateError
        :members:
        :undoc-members:
        :inherited-members:


.. raw:: html

    <p class="hr_p"><a href="#">&uarr;&#32&#32 top &#32&#32&uarr;</a></p>
    <!--

-----------

.. raw:: html

    -->


Raised when a search yields no connectivities.

..

    .. autoclass:: iris.exceptions.ConnectivityNotFoundError
        :members:
        :undoc-members:
        :inherited-members:


.. raw:: html

    <p class="hr_p"><a href="#">&uarr;&#32&#32 top &#32&#32&uarr;</a></p>
    <!--

-----------

.. raw:: html

    -->


Raised when a constraint operation has failed to find the correct number
of results.

..

    .. autoclass:: iris.exceptions.ConstraintMismatchError
        :members:
        :undoc-members:
        :inherited-members:


.. raw:: html

    <p class="hr_p"><a href="#">&uarr;&#32&#32 top &#32&#32&uarr;</a></p>
    <!--

-----------

.. raw:: html

    -->


Raised when a requested coordinate cannot be collapsed.

..

    .. autoclass:: iris.exceptions.CoordinateCollapseError
        :members:
        :undoc-members:
        :inherited-members:


.. raw:: html

    <p class="hr_p"><a href="#">&uarr;&#32&#32 top &#32&#32&uarr;</a></p>
    <!--

-----------

.. raw:: html

    -->


Raised when a routine doesn't support multi-dimensional coordinates.

..

    .. autoclass:: iris.exceptions.CoordinateMultiDimError
        :members:
        :undoc-members:
        :inherited-members:


.. raw:: html

    <p class="hr_p"><a href="#">&uarr;&#32&#32 top &#32&#32&uarr;</a></p>
    <!--

-----------

.. raw:: html

    -->


Raised when a search yields no coordinates.

..

    .. autoclass:: iris.exceptions.CoordinateNotFoundError
        :members:
        :undoc-members:
        :inherited-members:


.. raw:: html

    <p class="hr_p"><a href="#">&uarr;&#32&#32 top &#32&#32&uarr;</a></p>
    <!--

-----------

.. raw:: html

    -->


Raised when a coordinate is unexpectedly irregular.

..

    .. autoclass:: iris.exceptions.CoordinateNotRegularError
        :members:
        :undoc-members:
        :inherited-members:


.. raw:: html

    <p class="hr_p"><a href="#">&uarr;&#32&#32 top &#32&#32&uarr;</a></p>
    <!--

-----------

.. raw:: html

    -->


Raised when merging two or more cubes that have identical metadata.

..

    .. autoclass:: iris.exceptions.DuplicateDataError
        :members:
        :undoc-members:
        :inherited-members:


.. raw:: html

    <p class="hr_p"><a href="#">&uarr;&#32&#32 top &#32&#32&uarr;</a></p>
    <!--

-----------

.. raw:: html

    -->


Raised from a callback function when a cube should be ignored on load.

..

    .. autoclass:: iris.exceptions.IgnoreCubeException
        :members:
        :undoc-members:
        :inherited-members:


.. raw:: html

    <p class="hr_p"><a href="#">&uarr;&#32&#32 top &#32&#32&uarr;</a></p>
    <!--

-----------

.. raw:: html

    -->


Raised when a Cube validation check fails.

..

    .. autoclass:: iris.exceptions.InvalidCubeError
        :members:
        :undoc-members:
        :inherited-members:


.. raw:: html

    <p class="hr_p"><a href="#">&uarr;&#32&#32 top &#32&#32&uarr;</a></p>
    <!--

-----------

.. raw:: html

    -->


Base class for errors in the Iris package.

..

    .. autoclass:: iris.exceptions.IrisError
        :members:
        :undoc-members:
        :inherited-members:


.. raw:: html

    <p class="hr_p"><a href="#">&uarr;&#32&#32 top &#32&#32&uarr;</a></p>
    <!--

-----------

.. raw:: html

    -->


Common base class for all non-exit exceptions.

..

    .. autoclass:: iris.exceptions.LazyAggregatorError
        :members:
        :undoc-members:
        :inherited-members:


.. raw:: html

    <p class="hr_p"><a href="#">&uarr;&#32&#32 top &#32&#32&uarr;</a></p>
    <!--

-----------

.. raw:: html

    -->


Raised when merge is expected to produce a single cube, but fails to
do so.

..

    .. autoclass:: iris.exceptions.MergeError
        :members:
        :undoc-members:
        :inherited-members:


.. raw:: html

    <p class="hr_p"><a href="#">&uarr;&#32&#32 top &#32&#32&uarr;</a></p>
    <!--

-----------

.. raw:: html

    -->


Raised by missing functionality.

Different meaning to NotImplementedError, which is for abstract methods.

..

    .. autoclass:: iris.exceptions.NotYetImplementedError
        :members:
        :undoc-members:
        :inherited-members:


.. raw:: html

    <p class="hr_p"><a href="#">&uarr;&#32&#32 top &#32&#32&uarr;</a></p>
    <!--

-----------

.. raw:: html

    -->


Raised when Iris is unable to translate format-specific codes.

..

    .. autoclass:: iris.exceptions.TranslationError
        :members:
        :undoc-members:
        :inherited-members:


.. raw:: html

    <p class="hr_p"><a href="#">&uarr;&#32&#32 top &#32&#32&uarr;</a></p>
    <!--

-----------

.. raw:: html

    -->


Raised when Iris is unable to convert a unit.

..

    .. autoclass:: iris.exceptions.UnitConversionError
        :members:
        :undoc-members:
        :inherited-members: