Skip to content

Exceptions

litestar_auth.exceptions

Custom exception hierarchy for litestar-auth.

AuthenticationError(message=None, code=None)

Bases: LitestarAuthError

Raised when authentication fails.

Source code in litestar_auth/exceptions.py 
46
47
48
49
50
def __init__(self, message: str | None = None, code: str | None = None) -> None:
    """Initialize the exception with a default or custom message and optional code."""
    msg = message or self.default_message
    self.code = code if code is not None else getattr(type(self), "default_code", LitestarAuthError.default_code)
    super().__init__(msg)

AuthorizationError(message=None, code=None)

Bases: LitestarAuthError

Raised when an authenticated user is not allowed to perform an action.

Source code in litestar_auth/exceptions.py 
46
47
48
49
50
def __init__(self, message: str | None = None, code: str | None = None) -> None:
    """Initialize the exception with a default or custom message and optional code."""
    msg = message or self.default_message
    self.code = code if code is not None else getattr(type(self), "default_code", LitestarAuthError.default_code)
    super().__init__(msg)

ConfigurationError(message=None, code=None)

Bases: LitestarAuthError

Raised when the library is configured incorrectly.

Source code in litestar_auth/exceptions.py 
46
47
48
49
50
def __init__(self, message: str | None = None, code: str | None = None) -> None:
    """Initialize the exception with a default or custom message and optional code."""
    msg = message or self.default_message
    self.code = code if code is not None else getattr(type(self), "default_code", LitestarAuthError.default_code)
    super().__init__(msg)

ErrorCode

String constants for machine-readable error responses.

InactiveUserError(message=None, code=None)

Bases: AuthenticationError

Raised when an operation requires an active account.

Source code in litestar_auth/exceptions.py 
46
47
48
49
50
def __init__(self, message: str | None = None, code: str | None = None) -> None:
    """Initialize the exception with a default or custom message and optional code."""
    msg = message or self.default_message
    self.code = code if code is not None else getattr(type(self), "default_code", LitestarAuthError.default_code)
    super().__init__(msg)

InvalidPasswordError(message=None, code=None)

Bases: AuthenticationError

Raised when a password does not match the stored credentials.

Source code in litestar_auth/exceptions.py 
46
47
48
49
50
def __init__(self, message: str | None = None, code: str | None = None) -> None:
    """Initialize the exception with a default or custom message and optional code."""
    msg = message or self.default_message
    self.code = code if code is not None else getattr(type(self), "default_code", LitestarAuthError.default_code)
    super().__init__(msg)

InvalidResetPasswordTokenError(message=None, code=None)

Bases: TokenError

Raised when a password reset token is invalid or expired.

Source code in litestar_auth/exceptions.py 
46
47
48
49
50
def __init__(self, message: str | None = None, code: str | None = None) -> None:
    """Initialize the exception with a default or custom message and optional code."""
    msg = message or self.default_message
    self.code = code if code is not None else getattr(type(self), "default_code", LitestarAuthError.default_code)
    super().__init__(msg)

InvalidVerifyTokenError(message=None, code=None)

Bases: TokenError

Raised when an email verification token is invalid or expired.

Source code in litestar_auth/exceptions.py 
46
47
48
49
50
def __init__(self, message: str | None = None, code: str | None = None) -> None:
    """Initialize the exception with a default or custom message and optional code."""
    msg = message or self.default_message
    self.code = code if code is not None else getattr(type(self), "default_code", LitestarAuthError.default_code)
    super().__init__(msg)

LitestarAuthError(message=None, code=None)

Bases: Exception

Base exception for all library-specific errors.

Initialize the exception with a default or custom message and optional code.

Source code in litestar_auth/exceptions.py 
46
47
48
49
50
def __init__(self, message: str | None = None, code: str | None = None) -> None:
    """Initialize the exception with a default or custom message and optional code."""
    msg = message or self.default_message
    self.code = code if code is not None else getattr(type(self), "default_code", LitestarAuthError.default_code)
    super().__init__(msg)

OAuthAccountAlreadyLinkedError(message=None, code=None)

Bases: AuthenticationError

Raised when an OAuth provider identity is already linked to another user.

Persistence layer refuses cross-user rebinding: one provider identity (oauth_name, account_id) can only be linked to a single local user.

Source code in litestar_auth/exceptions.py 
46
47
48
49
50
def __init__(self, message: str | None = None, code: str | None = None) -> None:
    """Initialize the exception with a default or custom message and optional code."""
    msg = message or self.default_message
    self.code = code if code is not None else getattr(type(self), "default_code", LitestarAuthError.default_code)
    super().__init__(msg)

TokenError(message=None, code=None)

Bases: LitestarAuthError

Raised when token operations fail.

Source code in litestar_auth/exceptions.py 
46
47
48
49
50
def __init__(self, message: str | None = None, code: str | None = None) -> None:
    """Initialize the exception with a default or custom message and optional code."""
    msg = message or self.default_message
    self.code = code if code is not None else getattr(type(self), "default_code", LitestarAuthError.default_code)
    super().__init__(msg)

UnverifiedUserError(message=None, code=None)

Bases: AuthenticationError

Raised when an operation requires a verified account.

Source code in litestar_auth/exceptions.py 
46
47
48
49
50
def __init__(self, message: str | None = None, code: str | None = None) -> None:
    """Initialize the exception with a default or custom message and optional code."""
    msg = message or self.default_message
    self.code = code if code is not None else getattr(type(self), "default_code", LitestarAuthError.default_code)
    super().__init__(msg)

UserAlreadyExistsError(message=None, code=None)

Bases: AuthenticationError

Raised when creating a user that already exists.

Source code in litestar_auth/exceptions.py 
46
47
48
49
50
def __init__(self, message: str | None = None, code: str | None = None) -> None:
    """Initialize the exception with a default or custom message and optional code."""
    msg = message or self.default_message
    self.code = code if code is not None else getattr(type(self), "default_code", LitestarAuthError.default_code)
    super().__init__(msg)

UserNotExistsError(message=None, code=None)

Bases: AuthenticationError

Raised when a requested user cannot be found.

Source code in litestar_auth/exceptions.py 
46
47
48
49
50
def __init__(self, message: str | None = None, code: str | None = None) -> None:
    """Initialize the exception with a default or custom message and optional code."""
    msg = message or self.default_message
    self.code = code if code is not None else getattr(type(self), "default_code", LitestarAuthError.default_code)
    super().__init__(msg)