Skip to content

sake.errors#

The standard error bases which Sake implementations will be raising.

Note

These supplement python's builtin exceptions but do not replace them.

BackendError #

Bases: SakeException, ValueError

Error that's raised when communicating with the backend fails.

This may be a sign of underlying network or database issues.

base_exception instance-attribute #

base_exception = exception

The exception which caused this exception if applicable else None.

message instance-attribute #

message = message

The exception's message, this may be an empty string if there is no message.

__init__ #

__init__(message, *, exception=None)

Initialise a sake exception instance.

Parameters:

  • message (str) –

    The exception's message.

  • exception (Optional[Exception], default: None ) –

    The exception which caused this exception if applicable else None.

CannotDelete #

Bases: SakeException, ValueError

Error that's raised in response to an attempt to delete an entry which can't be deleted.

This most likely reason for this to be raised would be due to an attempt to deleted a entry that's being kept alive by references without specifying to cascade references in a referential database.

base_exception instance-attribute #

base_exception = exception

The exception which caused this exception if applicable else None.

message instance-attribute #

message = message

The exception's message, this may be an empty string if there is no message.

__init__ #

__init__(message, *, exception=None)

Initialise a sake exception instance.

Parameters:

  • message (str) –

    The exception's message.

  • exception (Optional[Exception], default: None ) –

    The exception which caused this exception if applicable else None.

ClosedClient #

Bases: SakeException

Error that's raised when an attempt to use an inactive client is made.

base_exception instance-attribute #

base_exception = exception

The exception which caused this exception if applicable else None.

message instance-attribute #

message = message

The exception's message, this may be an empty string if there is no message.

__init__ #

__init__(message, *, exception=None)

Initialise a sake exception instance.

Parameters:

  • message (str) –

    The exception's message.

  • exception (Optional[Exception], default: None ) –

    The exception which caused this exception if applicable else None.

EntryNotFound #

Bases: SakeException, LookupError

Error that's raised in response to an attempt to get an entry which doesn't exist.

Note

This shouldn't ever be raised by a delete method or iter method.

base_exception instance-attribute #

base_exception = exception

The exception which caused this exception if applicable else None.

message instance-attribute #

message = message

The exception's message, this may be an empty string if there is no message.

__init__ #

__init__(message, *, exception=None)

Initialise a sake exception instance.

Parameters:

  • message (str) –

    The exception's message.

  • exception (Optional[Exception], default: None ) –

    The exception which caused this exception if applicable else None.

InvalidDataFound #

Bases: SakeException, LookupError

Error that's raised when the retrieved data is in an unexpected format.

This may indicate that you are running different versions of a Sake implementation with the same database.

base_exception instance-attribute #

base_exception = exception

The exception which caused this exception if applicable else None.

message instance-attribute #

message = message

The exception's message, this may be an empty string if there is no message.

__init__ #

__init__(message, *, exception=None)

Initialise a sake exception instance.

Parameters:

  • message (str) –

    The exception's message.

  • exception (Optional[Exception], default: None ) –

    The exception which caused this exception if applicable else None.

SakeException #

Bases: Exception

Base exception for the expected exceptions raised by Sake implementations.

base_exception instance-attribute #

base_exception = exception

The exception which caused this exception if applicable else None.

message instance-attribute #

message = message

The exception's message, this may be an empty string if there is no message.

__init__ #

__init__(message, *, exception=None)

Initialise a sake exception instance.

Parameters:

  • message (str) –

    The exception's message.

  • exception (Optional[Exception], default: None ) –

    The exception which caused this exception if applicable else None.