You are viewing the latest unreleased documentation 3.10.0.dev20. You can switch to a stable version.

iris.exceptions#

Exceptions specific to the Iris package.

exception iris.exceptions.AncillaryVariableNotFoundError[source]#

Bases: KeyError

Raised when a search yields no ancillary variables.

add_note()#

Exception.add_note(note) – add a note to the exception

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception iris.exceptions.CannotAddError[source]#

Bases: ValueError

Raised when an object (e.g. coord) cannot be added to a Cube.

add_note()#

Exception.add_note(note) – add a note to the exception

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception iris.exceptions.CellMeasureNotFoundError[source]#

Bases: KeyError

Raised when a search yields no cell measures.

add_note()#

Exception.add_note(note) – add a note to the exception

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception iris.exceptions.ConcatenateError(differences)[source]#

Bases: IrisError

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

Create a ConcatenateError with a list of textual descriptions of differences.

Create a ConcatenateError with a list of textual descriptions of the differences which prevented a concatenate.

Parameters:

differences (list of str) – The list of strings which describe the differences.

add_note()#

Exception.add_note(note) – add a note to the exception

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception iris.exceptions.ConnectivityNotFoundError[source]#

Bases: KeyError

Raised when a search yields no connectivities.

add_note()#

Exception.add_note(note) – add a note to the exception

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception iris.exceptions.ConstraintMismatchError[source]#

Bases: IrisError

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

add_note()#

Exception.add_note(note) – add a note to the exception

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception iris.exceptions.CoordinateCollapseError[source]#

Bases: IrisError

Raised when a requested coordinate cannot be collapsed.

add_note()#

Exception.add_note(note) – add a note to the exception

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception iris.exceptions.CoordinateMultiDimError(msg)[source]#

Bases: ValueError

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

add_note()#

Exception.add_note(note) – add a note to the exception

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception iris.exceptions.CoordinateNotFoundError[source]#

Bases: KeyError

Raised when a search yields no coordinates.

add_note()#

Exception.add_note(note) – add a note to the exception

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception iris.exceptions.CoordinateNotRegularError[source]#

Bases: ValueError

Raised when a coordinate is unexpectedly irregular.

add_note()#

Exception.add_note(note) – add a note to the exception

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception iris.exceptions.DuplicateDataError(msg)[source]#

Bases: MergeError

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

Create a MergeError with a list of textual descriptions of the differences.

Creates a MergeError with a list of textual descriptions of the differences which prevented a merge.

Parameters:

differences (list of str) – The list of strings which describe the differences.

add_note()#

Exception.add_note(note) – add a note to the exception

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception iris.exceptions.IgnoreCubeException[source]#

Bases: IrisError

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

add_note()#

Exception.add_note(note) – add a note to the exception

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception iris.exceptions.InvalidCubeError[source]#

Bases: IrisError

Raised when a Cube validation check fails.

add_note()#

Exception.add_note(note) – add a note to the exception

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception iris.exceptions.IrisError[source]#

Bases: Exception

Base class for errors in the Iris package.

add_note()#

Exception.add_note(note) – add a note to the exception

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception iris.exceptions.LazyAggregatorError[source]#

Bases: Exception

add_note()#

Exception.add_note(note) – add a note to the exception

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception iris.exceptions.MergeError(differences)[source]#

Bases: IrisError

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

Create a MergeError with a list of textual descriptions of the differences.

Creates a MergeError with a list of textual descriptions of the differences which prevented a merge.

Parameters:

differences (list of str) – The list of strings which describe the differences.

add_note()#

Exception.add_note(note) – add a note to the exception

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception iris.exceptions.NotYetImplementedError[source]#

Bases: IrisError

Raised by missing functionality.

Different meaning to NotImplementedError, which is for abstract methods.

add_note()#

Exception.add_note(note) – add a note to the exception

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception iris.exceptions.TranslationError[source]#

Bases: IrisError

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

add_note()#

Exception.add_note(note) – add a note to the exception

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception iris.exceptions.UnitConversionError[source]#

Bases: IrisError

Raised when Iris is unable to convert a unit.

add_note()#

Exception.add_note(note) – add a note to the exception

args#
with_traceback()#

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.