1.7. errors

This module provides the custom exceptions that are used throughout the package.

1.7.1. Exceptions

exception KingPhisherError(message='')

Bases: Exception

The base exception that is inherited by all custom King Phisher error classes.

exception KingPhisherAbortError(message='')

Bases: king_phisher.errors.KingPhisherError

An exception that can be raised to indicate that an arbitrary operation needs to be aborted when no better method can be used.

exception KingPhisherAbortRequestError(response_sent=False)

Bases: king_phisher.errors.KingPhisherAbortError

An exception that can be raised which when caught will cause the handler to immediately stop processing the current request.

__init__(response_sent=False)

Parameters:response_sent (bool) – Whether or not a response has already been sent to the client.

exception KingPhisherDatabaseError(message='')

Bases: king_phisher.errors.KingPhisherError

An exception that can be raised by King Phisher when there is any error relating to the database, it’s configuration or any action involving it. The underlying database API will raise exceptions of it’s own kind.

exception KingPhisherDatabaseAuthenticationError(message, username=None)

Bases: king_phisher.errors.KingPhisherDatabaseError

An exception that is raised when King Phisher can not authenticate to the database. This is usually due to the configured password being incorrect.

exception KingPhisherGraphQLQueryError(message='', errors=None, query=None, query_vars=None)

Bases: king_phisher.errors.KingPhisherError

An exception raised when a GraphQL query fails to execute correctly.

exception KingPhisherInputValidationError(message='')

Bases: king_phisher.errors.KingPhisherError

An exception that is raised when any kind of input into King Phisher fails to be properly validated.

exception KingPhisherPermissionError(message='')

Bases: king_phisher.errors.KingPhisherError

An exception that is raised by King Phisher when some form of a request can not be satisfied due to the configured level of access.

exception KingPhisherPluginError(plugin_name, *args, **kwargs)

Bases: king_phisher.errors.KingPhisherError

An exception that is raised by King Phisher to indicate an error regarding a particular plugin.

__init__(plugin_name, *args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

exception KingPhisherResourceError(message='')

Bases: king_phisher.errors.KingPhisherError

An exception that is raised by King Phisher when there is a problem relating to a resource such as it is missing, locked, inaccessible or otherwise invalid.

exception KingPhisherTimeoutError(message='')

Bases: king_phisher.errors.KingPhisherError

An exception that is raised by King Phisher when some form of a request fails to complete within a specified time period.