leaspy.exceptions module

Define custom Leaspy exceptions for better downstream handling.

Exceptions classes are nested so to handle in the most convenient way for users:

                Exception
                    |
                    |
              LeaspyException        RuntimeError
                    |         \            |
                    |           LeaspyConvergenceError
                   / \
     TypeError    /   \     ValueError
         |       /     \        |
  LeaspyTypeError      LeaspyInputError
                      /    |    |      \
                     /     |    |  LeaspyIndividualParamsInputError
                    /      |    |
LeaspyDataInputError       |  LeaspyAlgoInputError
                           |
                LeaspyModelInputError

For I/O operations, non-Leaspy specific errors may be raised, in particular:

• FileNotFoundError

• NotADirectoryError

exception LeaspyException

Bases: Exception

Base of all Leaspy exceptions.

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 LeaspyConvergenceError

Bases: LeaspyException, RuntimeError

Leaspy Exception for errors relative to convergence.

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 LeaspyTypeError

Bases: LeaspyException, TypeError

Leaspy Exception, deriving from TypeError.

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 LeaspyInputError

Bases: LeaspyException, ValueError

Leaspy Exception, deriving from ValueError.

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 LeaspyDataInputError

Bases: LeaspyInputError

Leaspy Input Error for data related issues.

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 LeaspyModelInputError

Bases: LeaspyInputError

Leaspy Input Error for model related issues.

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 LeaspyAlgoInputError

Bases: LeaspyInputError

Leaspy Input Error for algorithm related issues.

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 LeaspyIndividualParamsInputError

Bases: LeaspyInputError

Leaspy Input Error for individual parameters related issues.

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.