Pular para conteúdo

tucoopy.base.exceptions

Shared exception types for tucoopy.

The project aims to raise a small set of well-named exceptions from core layers instead of leaking ValueError/RuntimeError everywhere. This makes it easier for users to catch and handle errors consistently.

Examples:

>>> from tucoopy.base.exceptions import InvalidGameError
>>> try:
...     raise InvalidGameError("bad game")
... except InvalidGameError as e:
...     str(e)
'bad game'

BackendError

Bases: tucoopyError, RuntimeError

Raised when a backend fails or violates its contract.

This is typically used for failures in optional backends (LP, NumPy helpers), or when a backend returns an incomplete/invalid result structure.

Examples:

>>> from tucoopy.base.exceptions import BackendError
>>> try:
...     raise BackendError("backend failed")
... except BackendError as e:
...     str(e)
'backend failed'

ConvergenceError

Bases: tucoopyError, RuntimeError

Raised when an iterative algorithm fails to converge within limits.

Examples:

>>> from tucoopy.base.exceptions import ConvergenceError
>>> try:
...     raise ConvergenceError("did not converge")
... except ConvergenceError as e:
...     str(e)
'did not converge'

InvalidCoalitionError

Bases: tucoopyError, ValueError

Raised when coalition inputs (bitmasks, player indices) are invalid.

Examples:

>>> from tucoopy.base.exceptions import InvalidCoalitionError
>>> try:
...     raise InvalidCoalitionError("invalid coalition mask")
... except InvalidCoalitionError as e:
...     str(e)
'invalid coalition mask'

InvalidGameError

Bases: tucoopyError, ValueError

Raised when a game object is invalid or inconsistent.

Examples:

>>> try:
...     raise InvalidGameError("Invalid game")
... except InvalidGameError as e:
...     print(type(e))
<class 'tucoopy.base.exceptions.InvalidGameError'>

InvalidParameterError

Bases: tucoopyError, ValueError

Raised when an API parameter is invalid (wrong value/range/shape).

Examples:

>>> from tucoopy.base.exceptions import InvalidParameterError
>>> try:
...     raise InvalidParameterError("bad parameter")
... except InvalidParameterError as e:
...     str(e)
'bad parameter'

InvalidSpecError

Bases: tucoopyError, ValueError

Raised when a JSON/spec-like object is invalid or inconsistent.

This is typically raised by :mod:tucoopy.io.

Examples:

>>> from tucoopy.base.exceptions import InvalidSpecError
>>> try:
...     raise InvalidSpecError("invalid spec")
... except InvalidSpecError as e:
...     str(e)
'invalid spec'

MissingOptionalDependencyError

Bases: tucoopyError, ImportError

Raised when an optional dependency is required but not installed.

The error message should typically include the corresponding extra, e.g. pip install "tucoopy[lp]" or pip install "tucoopy[viz]".

Examples:

>>> from tucoopy.base.exceptions import MissingOptionalDependencyError
>>> try:
...     raise MissingOptionalDependencyError("install tucoopy[lp]")
... except MissingOptionalDependencyError as e:
...     str(e)
'install tucoopy[lp]'

NotSupportedError

Bases: tucoopyError, ValueError, NotImplementedError

Raised when a requested operation is not supported by the implementation.

Examples:

>>> from tucoopy.base.exceptions import NotSupportedError
>>> try:
...     raise NotSupportedError("not implemented")
... except NotSupportedError as e:
...     str(e)
'not implemented'

tucoopyError

Bases: Exception

Base error for tucoopy.

This is the root exception for all errors raised by the tucoopy package.

Examples:

>>> try:
...     raise tucoopyError("Generic Error")
... except tucoopyError as e:
...     print(type(e))
<class 'tucoopy.base.exceptions.tucoopyError'>