exceptions

exception advanced_alchemy.exceptions.AdvancedAlchemyError

Bases: Exception

Base exception class from which all Advanced Alchemy exceptions inherit.

__init__(*args, detail='')

Initialize AdvancedAlchemyException.

Parameters:

• *args (Any) – args are converted to str before passing to Exception

• detail (str) – detail of the exception.

• args (Any)

• detail (str)

Return type:

None

exception advanced_alchemy.exceptions.DuplicateKeyError

Bases: IntegrityError

Duplicate key error.

Parameters:

• *args (Any) – Variable length argument list passed to parent class.

• detail (str) – Detailed error message.

class advanced_alchemy.exceptions.ErrorMessages

Bases: TypedDict

exception advanced_alchemy.exceptions.ForeignKeyError

Bases: IntegrityError

Foreign key error.

Parameters:

• *args (Any) – Variable length argument list passed to parent class.

• detail (str) – Detailed error message.

exception advanced_alchemy.exceptions.ImproperConfigurationError

Bases: AdvancedAlchemyError

Improper Configuration error.

This exception is raised when there is an issue with the configuration of a module.

Parameters:

• *args (Any) – Variable length argument list passed to parent class.

• detail (str) – Detailed error message.

exception advanced_alchemy.exceptions.IntegrityError

Bases: RepositoryError

Data integrity error.

Parameters:

• *args (Any) – Variable length argument list passed to parent class.

• detail (str) – Detailed error message.

exception advanced_alchemy.exceptions.MissingDependencyError

Bases: AdvancedAlchemyError, ImportError

Missing optional dependency.

This exception is raised when a module depends on a dependency that has not been installed.

Parameters:

• package (str) – Name of the missing package.

• install_package (Optional[str]) – Optional alternative package name to install.

__init__(package, install_package=None)

Initialize AdvancedAlchemyException.

Parameters:

• *args – args are converted to str before passing to Exception

• detail – detail of the exception.

• package (str)

• install_package (str | None)

Return type:

None

exception advanced_alchemy.exceptions.MultipleResultsFoundError

Bases: RepositoryError

Multiple results found error.

This exception is raised when a single result was expected but multiple were found.

Parameters:

• *args (Any) – Variable length argument list passed to parent class.

• detail (str) – Detailed error message.

exception advanced_alchemy.exceptions.NotFoundError

Bases: RepositoryError

Not found error.

This exception is raised when a requested resource is not found.

Parameters:

• *args (Any) – Variable length argument list passed to parent class.

• detail (str) – Detailed error message.

exception advanced_alchemy.exceptions.RepositoryError

Bases: AdvancedAlchemyError

Base repository exception type.

Parameters:

• *args (Any) – Variable length argument list passed to parent class.

• detail (str) – Detailed error message.

exception advanced_alchemy.exceptions.SerializationError

Bases: AdvancedAlchemyError

Encoding or decoding error.

This exception is raised when serialization or deserialization of an object fails.

Parameters:

• *args (Any) – Variable length argument list passed to parent class.

• detail (str) – Detailed error message.

advanced_alchemy.exceptions.wrap_sqlalchemy_exception(error_messages=None, dialect_name=None, wrap_exceptions=True)

Do something within context to raise a RepositoryError chained from an original SQLAlchemyError.

>>> try:
...     with wrap_sqlalchemy_exception():
...         raise SQLAlchemyError("Original Exception")
... except RepositoryError as exc:
...     print(
...         f"caught repository exception from {type(exc.__context__)}"
...     )
caught repository exception from <class 'sqlalchemy.exc.SQLAlchemyError'>

Parameters:

• error_messages (Optional[ErrorMessages]) – Error messages to use for the exception.

• dialect_name (Optional[str]) – The name of the dialect to use for the exception.

• wrap_exceptions (bool) – Wrap SQLAlchemy exceptions in a RepositoryError. When set to False, the original exception will be raised.

• error_messages (ErrorMessages | None)

• dialect_name (str | None)

• wrap_exceptions (bool)

Raises:

• NotFoundError – Raised when no rows matched the specified data.

• MultipleResultsFound – Raised when multiple rows matched the specified data.

• IntegrityError – Raised when an integrity error occurs.

• InvalidRequestError – Raised when an invalid request was made to SQLAlchemy.

• RepositoryError – Raised for other SQLAlchemy errors.

• AttributeError – Raised when an attribute error occurs during processing.

• SQLAlchemyError – Raised for general SQLAlchemy errors.

• StatementError – Raised when there is an issue processing the statement.

• MultipleResultsFoundError – Raised when multiple rows matched the specified data.

Return type:

Generator[None, None, None]