err ¤

Bases: Enum

Describes which error occured.

Feel free to add a new one.

Attributes:

• SUCCESS –
• FAILURE –

  Generic failure

• NO_STRUCTURE_FILE –

  We tried to load a structure, but the associated structure file doesn't exist.

SUCCESS = 0

FAILURE = 1

NO_STRUCTURE_FILE = 2

An error handling object.

Passing no arguments (i.e. doing Status()) represents a success.

Methods:

• is_success –

  Returns True if the Status object denotes a success.

• is_failure –

  Returns True if the Status object denotes a failure.

• succeed –

  Create a Status object that represents a success.

• fail –

  Create a Status object that represents a generic failure.

• coded_fail –

  Create a Status object that represents a failure.

Attributes:

• code (ErrorCode) –

  An error code associated with this error.

• message (str) –

  If is_failure() returns True, this attribute contains the error message.

code: ErrorCode = code

message: str = message

is_success() -> bool

is_failure() -> bool

succeed() -> Status

fail(message: str = '') -> Status

coded_fail(code: ErrorCode, message: str = '') -> Status

Bases: Exception

We tried to recover (i.e. look up in the debugger and craft ourselves) the type name but failed because of msg.

Attributes:

• name –

name = name

Bases: Exception

The type is not in the debugger.