Errors¶

The models/errors subpackage defines the custom exception hierarchy for ArchiPy. All errors subclass BaseError and are organized by domain: authentication, authorization, validation, resource management, networking, database, system, Keycloak, and Temporal.

Base Error¶

The root BaseError class that all ArchiPy exceptions inherit from, providing structured error codes and context.

Classes:

Name	Description
`BaseError`	Base exception class for all custom errors.

BaseError ¶

Base exception class for all custom errors.

This class provides a standardized way to handle errors with support for: - Localization of error messages - Additional context data - Integration with HTTP and gRPC status codes - Template string formatting for dynamic message formatting (using {variable} placeholders) - Text normalization and Persian number conversion

Subclasses should define the following class attributes

code (ClassVar[str]): Error code identifier message_en (ClassVar[str]): English error message (can use {variable} placeholders) message_fa (ClassVar[str]): Persian error message (can use {variable} placeholders) http_status (ClassVar[int]): HTTP status code grpc_status (ClassVar[int]): gRPC status code

Methods:

Name	Description
`get_message`	Gets the localized error message based on the language setting.
`to_dict`	Converts the exception to a dictionary format for API responses.
`abort_grpc_async`	Aborts an async gRPC call with the appropriate status code and message.
`abort_grpc_sync`	Aborts a sync gRPC call with the appropriate status code and message.
`abort_with_error_async`	Creates an error instance and immediately aborts the async gRPC context.
`abort_with_error_sync`	Creates an error instance and immediately aborts the sync gRPC context.

Attributes:

Name	Type	Description
`message`	`str`	Gets the current language message.

Source code in archipy/models/errors/base_error.py

class BaseError(Exception):
    """Base exception class for all custom errors.

    This class provides a standardized way to handle errors with support for:
    - Localization of error messages
    - Additional context data
    - Integration with HTTP and gRPC status codes
    - Template string formatting for dynamic message formatting (using {variable} placeholders)
    - Text normalization and Persian number conversion

    Subclasses should define the following class attributes:
        code (ClassVar[str]): Error code identifier
        message_en (ClassVar[str]): English error message (can use {variable} placeholders)
        message_fa (ClassVar[str]): Persian error message (can use {variable} placeholders)
        http_status (ClassVar[int]): HTTP status code
        grpc_status (ClassVar[int]): gRPC status code

    """

    # Default error details - subclasses should override these
    code: ClassVar[str] = "UNKNOWN_ERROR"
    message_en: ClassVar[str] = "An unknown error occurred"
    message_fa: ClassVar[str] = "خطای ناشناخته‌ای رخ داده است."
    http_status: ClassVar[int] = (
        HTTPStatus.INTERNAL_SERVER_ERROR.value
        if HTTP_AVAILABLE and HTTPStatus is not None and HTTPStatus is not None
        else 500
    )
    grpc_status: ClassVar[int] = (
        grpc.StatusCode.INTERNAL.value[0]
        if GRPC_AVAILABLE and grpc is not None and isinstance(grpc.StatusCode.INTERNAL.value, tuple)
        else (grpc.StatusCode.INTERNAL.value if GRPC_AVAILABLE and grpc is not None else 13)
    )

    def __init__(
        self,
        lang: LanguageType | None = None,
        additional_data: dict[str, Any] | None = None,
        *args: object,
    ) -> None:
        """Initialize the error with message and optional context.

        Args:
            lang: Language code for the error message (defaults to Persian).
            additional_data: Additional context data for the error.
            *args: Additional arguments for the base Exception class.
        """
        if lang is None:
            try:
                from archipy.configs.base_config import BaseConfig

                self.lang = BaseConfig.global_config().LANGUAGE
            except ImportError, AssertionError:
                self.lang = LanguageType.FA
        else:
            self.lang = lang

        self.additional_data = additional_data or {}

        # Initialize base Exception with the message
        super().__init__(self.get_message(), *args)

    def get_message(self) -> str:
        """Gets the localized error message based on the language setting.

        Returns:
            str: The error message in the current language.
        """
        return self.message_fa if self.lang == LanguageType.FA else self.message_en

    def to_dict(self) -> dict:
        """Converts the exception to a dictionary format for API responses.

        Returns:
            dict: A dictionary containing error details and additional data.
        """
        # Get the processed message (not the template)
        processed_message = self.get_message()

        response = {
            "error": self.code,
            "detail": {
                "code": self.code,
                "message": processed_message,
                "http_status": self.http_status,
                "grpc_status": self.grpc_status,
            },
        }

        # Add additional data if present
        if self.additional_data:
            detail = response["detail"]
            if isinstance(detail, dict):
                detail.update(self.additional_data)

        return response

    def __str__(self) -> str:
        """String representation of the exception.

        Returns:
            str: A formatted string containing the error code and message.
        """
        return (
            f"{self.__class__.__name__}("
            f"code='{self.code}', "
            f"message='{self.get_message()}', "
            f"http_status={self.http_status}, "
            f"grpc_status={self.grpc_status}, "
            f"additional_data={self.additional_data}"
            f")"
        )

    def __repr__(self) -> str:
        """Detailed string representation of the exception.

        Returns:
            str: A detailed string representation including all error details.
        """
        return (
            f"{self.__class__.__name__}("
            f"code='{self.code}', "
            f"message='{self.get_message()}', "
            f"http_status={self.http_status}, "
            f"grpc_status={self.grpc_status}, "
            f"additional_data={self.additional_data}"
            f")"
        )

    @property
    def message(self) -> str:
        """Gets the current language message.

        Returns:
            str: The error message in the current language.
        """
        return self.get_message()

    @staticmethod
    def _convert_int_to_grpc_status(status_int: int) -> grpc.StatusCode:
        """Convert integer status code to gRPC StatusCode enum.

        Args:
            status_int: Integer status code

        Returns:
            grpc.StatusCode: Corresponding StatusCode enum member

        Raises:
            ValueError: If gRPC is not available.
        """
        if not GRPC_AVAILABLE or grpc is None:
            raise ValueError("gRPC is not available")

        status_map = {
            0: grpc.StatusCode.OK,
            1: grpc.StatusCode.CANCELLED,
            2: grpc.StatusCode.UNKNOWN,
            3: grpc.StatusCode.INVALID_ARGUMENT,
            4: grpc.StatusCode.DEADLINE_EXCEEDED,
            5: grpc.StatusCode.NOT_FOUND,
            6: grpc.StatusCode.ALREADY_EXISTS,
            7: grpc.StatusCode.PERMISSION_DENIED,
            8: grpc.StatusCode.RESOURCE_EXHAUSTED,
            9: grpc.StatusCode.FAILED_PRECONDITION,
            10: grpc.StatusCode.ABORTED,
            11: grpc.StatusCode.OUT_OF_RANGE,
            12: grpc.StatusCode.UNIMPLEMENTED,
            13: grpc.StatusCode.INTERNAL,
            14: grpc.StatusCode.UNAVAILABLE,
            15: grpc.StatusCode.DATA_LOSS,
            16: grpc.StatusCode.UNAUTHENTICATED,
        }

        return status_map.get(status_int, grpc.StatusCode.INTERNAL)

    async def abort_grpc_async(self, context: AsyncServicerContext) -> None:
        """Aborts an async gRPC call with the appropriate status code and message.

        Args:
            context: The gRPC ServicerContext to abort.

        Raises:
            ValueError: If context is None or doesn't have abort method.
        """
        if context is None:
            raise ValueError("gRPC context cannot be None")

        if not GRPC_AVAILABLE or not hasattr(context, "abort"):
            raise ValueError("Invalid gRPC context: missing abort method")

        status_code: grpc.StatusCode = self._convert_int_to_grpc_status(self.grpc_status)
        message = self.get_message()

        if self.additional_data and hasattr(context, "set_trailing_metadata"):
            context.set_trailing_metadata((("additional_data", json.dumps(self.additional_data)),))

        if hasattr(context, "abort") and callable(context.abort):
            await context.abort(status_code, message)
        else:
            raise ValueError("gRPC context abort method not available or not callable")

    def abort_grpc_sync(self, context: ServicerContext) -> None:
        """Aborts a sync gRPC call with the appropriate status code and message.

        Args:
            context: The gRPC ServicerContext to abort.

        Raises:
            ValueError: If context is None or doesn't have abort method.
        """
        if context is None:
            raise ValueError("gRPC context cannot be None")

        if not GRPC_AVAILABLE or not hasattr(context, "abort"):
            raise ValueError("Invalid gRPC context: missing abort method")

        status_code: grpc.StatusCode = self._convert_int_to_grpc_status(self.grpc_status)
        message = self.get_message()

        if self.additional_data and hasattr(context, "set_trailing_metadata"):
            context.set_trailing_metadata((("additional_data", json.dumps(self.additional_data)),))

        if hasattr(context, "abort") and callable(context.abort):
            context.abort(status_code, message)
        else:
            raise ValueError("gRPC context abort method not available or not callable")

    @classmethod
    async def abort_with_error_async(
        cls,
        context: AsyncServicerContext,
        lang: LanguageType | None = None,
        additional_data: dict[str, Any] | None = None,
    ) -> None:
        """Creates an error instance and immediately aborts the async gRPC context.

        Args:
            context: The async gRPC ServicerContext to abort.
            lang: Language code for the error message.
            additional_data: Additional context data for the error.

        Raises:
            ValueError: If context is None or invalid.
        """
        instance = cls(lang=lang, additional_data=additional_data)
        await instance.abort_grpc_async(context)

    @classmethod
    def abort_with_error_sync(
        cls,
        context: ServicerContext,
        lang: LanguageType | None = None,
        additional_data: dict[str, Any] | None = None,
    ) -> None:
        """Creates an error instance and immediately aborts the sync gRPC context.

        Args:
            context: The sync gRPC ServicerContext to abort.
            lang: Language code for the error message.
            additional_data: Additional context data for the error.

        Raises:
            ValueError: If context is None or invalid.
        """
        instance = cls(lang=lang, additional_data=additional_data)
        instance.abort_grpc_sync(context)

message `property` ¶

message: str

Gets the current language message.

Returns:

Name	Type	Description
`str`	`str`	The error message in the current language.

get_message ¶

get_message() -> str

Gets the localized error message based on the language setting.

Returns:

Name	Type	Description
`str`	`str`	The error message in the current language.

Source code in archipy/models/errors/base_error.py

def get_message(self) -> str:
    """Gets the localized error message based on the language setting.

    Returns:
        str: The error message in the current language.
    """
    return self.message_fa if self.lang == LanguageType.FA else self.message_en

to_dict ¶

to_dict() -> dict

Converts the exception to a dictionary format for API responses.

Returns:

Name	Type	Description
`dict`	`dict`	A dictionary containing error details and additional data.

Source code in archipy/models/errors/base_error.py

def to_dict(self) -> dict:
    """Converts the exception to a dictionary format for API responses.

    Returns:
        dict: A dictionary containing error details and additional data.
    """
    # Get the processed message (not the template)
    processed_message = self.get_message()

    response = {
        "error": self.code,
        "detail": {
            "code": self.code,
            "message": processed_message,
            "http_status": self.http_status,
            "grpc_status": self.grpc_status,
        },
    }

    # Add additional data if present
    if self.additional_data:
        detail = response["detail"]
        if isinstance(detail, dict):
            detail.update(self.additional_data)

    return response

abort_grpc_async `async` ¶

abort_grpc_async(context: ServicerContext) -> None

Aborts an async gRPC call with the appropriate status code and message.

Parameters:

Name	Type	Description	Default
`context`	`ServicerContext`	The gRPC ServicerContext to abort.	required

Raises:

Type	Description
`ValueError`	If context is None or doesn't have abort method.

Source code in archipy/models/errors/base_error.py

async def abort_grpc_async(self, context: AsyncServicerContext) -> None:
    """Aborts an async gRPC call with the appropriate status code and message.

    Args:
        context: The gRPC ServicerContext to abort.

    Raises:
        ValueError: If context is None or doesn't have abort method.
    """
    if context is None:
        raise ValueError("gRPC context cannot be None")

    if not GRPC_AVAILABLE or not hasattr(context, "abort"):
        raise ValueError("Invalid gRPC context: missing abort method")

    status_code: grpc.StatusCode = self._convert_int_to_grpc_status(self.grpc_status)
    message = self.get_message()

    if self.additional_data and hasattr(context, "set_trailing_metadata"):
        context.set_trailing_metadata((("additional_data", json.dumps(self.additional_data)),))

    if hasattr(context, "abort") and callable(context.abort):
        await context.abort(status_code, message)
    else:
        raise ValueError("gRPC context abort method not available or not callable")

abort_grpc_sync ¶

abort_grpc_sync(context: ServicerContext) -> None

Aborts a sync gRPC call with the appropriate status code and message.

Parameters:

Name	Type	Description	Default
`context`	`ServicerContext`	The gRPC ServicerContext to abort.	required

Raises:

Type	Description
`ValueError`	If context is None or doesn't have abort method.

Source code in archipy/models/errors/base_error.py

def abort_grpc_sync(self, context: ServicerContext) -> None:
    """Aborts a sync gRPC call with the appropriate status code and message.

    Args:
        context: The gRPC ServicerContext to abort.

    Raises:
        ValueError: If context is None or doesn't have abort method.
    """
    if context is None:
        raise ValueError("gRPC context cannot be None")

    if not GRPC_AVAILABLE or not hasattr(context, "abort"):
        raise ValueError("Invalid gRPC context: missing abort method")

    status_code: grpc.StatusCode = self._convert_int_to_grpc_status(self.grpc_status)
    message = self.get_message()

    if self.additional_data and hasattr(context, "set_trailing_metadata"):
        context.set_trailing_metadata((("additional_data", json.dumps(self.additional_data)),))

    if hasattr(context, "abort") and callable(context.abort):
        context.abort(status_code, message)
    else:
        raise ValueError("gRPC context abort method not available or not callable")

abort_with_error_async `async` `classmethod` ¶

abort_with_error_async(
    context: ServicerContext,
    lang: LanguageType | None = None,
    additional_data: dict[str, Any] | None = None,
) -> None

Creates an error instance and immediately aborts the async gRPC context.

Parameters:

Name	Type	Description	Default
`context`	`ServicerContext`	The async gRPC ServicerContext to abort.	required
`lang`	`LanguageType \| None`	Language code for the error message.	`None`
`additional_data`	`dict[str, Any] \| None`	Additional context data for the error.	`None`

Raises:

Type	Description
`ValueError`	If context is None or invalid.

Source code in archipy/models/errors/base_error.py

@classmethod
async def abort_with_error_async(
    cls,
    context: AsyncServicerContext,
    lang: LanguageType | None = None,
    additional_data: dict[str, Any] | None = None,
) -> None:
    """Creates an error instance and immediately aborts the async gRPC context.

    Args:
        context: The async gRPC ServicerContext to abort.
        lang: Language code for the error message.
        additional_data: Additional context data for the error.

    Raises:
        ValueError: If context is None or invalid.
    """
    instance = cls(lang=lang, additional_data=additional_data)
    await instance.abort_grpc_async(context)

abort_with_error_sync `classmethod` ¶

abort_with_error_sync(
    context: ServicerContext,
    lang: LanguageType | None = None,
    additional_data: dict[str, Any] | None = None,
) -> None

Creates an error instance and immediately aborts the sync gRPC context.

Parameters:

Name	Type	Description	Default
`context`	`ServicerContext`	The sync gRPC ServicerContext to abort.	required
`lang`	`LanguageType \| None`	Language code for the error message.	`None`
`additional_data`	`dict[str, Any] \| None`	Additional context data for the error.	`None`

Raises:

Type	Description
`ValueError`	If context is None or invalid.

Source code in archipy/models/errors/base_error.py

@classmethod
def abort_with_error_sync(
    cls,
    context: ServicerContext,
    lang: LanguageType | None = None,
    additional_data: dict[str, Any] | None = None,
) -> None:
    """Creates an error instance and immediately aborts the sync gRPC context.

    Args:
        context: The sync gRPC ServicerContext to abort.
        lang: Language code for the error message.
        additional_data: Additional context data for the error.

    Raises:
        ValueError: If context is None or invalid.
    """
    instance = cls(lang=lang, additional_data=additional_data)
    instance.abort_grpc_sync(context)

options: show_root_toc_entry: false heading_level: 3

Auth Errors¶

Exceptions for authentication and authorization failures.

Classes:

Name	Description
`UnauthenticatedError`	Exception raised when a user is unauthenticated.
`InvalidCredentialsError`	Exception raised for invalid credentials.
`TokenExpiredError`	Exception raised when a token has expired.
`InvalidTokenError`	Exception raised when a token is invalid.
`SessionExpiredError`	Exception raised when a session has expired.
`PermissionDeniedError`	Exception raised when permission is denied.
`AccountLockedError`	Exception raised when an account is locked.
`AccountDisabledError`	Exception raised when an account is disabled.
`InvalidVerificationCodeError`	Exception raised when a verification code is invalid.

UnauthenticatedError ¶

Exception raised when a user is unauthenticated.

Source code in archipy/models/errors/auth_errors.py

class UnauthenticatedError(BaseError):
    """Exception raised when a user is unauthenticated."""

    code: ClassVar[str] = "UNAUTHENTICATED"
    message_en: ClassVar[str] = "You are not authorized to perform this action."
    message_fa: ClassVar[str] = "شما مجوز انجام این عمل را ندارید."
    http_status: ClassVar[int] = HTTPStatus.UNAUTHORIZED.value if HTTP_AVAILABLE and HTTPStatus is not None else 401
    grpc_status: ClassVar[int] = (
        StatusCode.UNAUTHENTICATED.value[0]
        if GRPC_AVAILABLE and StatusCode is not None and isinstance(StatusCode.UNAUTHENTICATED.value, tuple)
        else (
            StatusCode.UNAUTHENTICATED.value
            if GRPC_AVAILABLE and StatusCode is not None and StatusCode is not None
            else 16
        )
    )

InvalidCredentialsError ¶

Exception raised for invalid credentials.

Methods:

Name	Description
`get_message`	Gets the localized error message with username.

Source code in archipy/models/errors/auth_errors.py

class InvalidCredentialsError(BaseError):
    """Exception raised for invalid credentials."""

    code: ClassVar[str] = "INVALID_CREDENTIALS"
    message_en: ClassVar[str] = "Invalid username or password: {username}"
    message_fa: ClassVar[str] = "نام کاربری یا رمز عبور نامعتبر است: {username}"
    http_status: ClassVar[int] = HTTPStatus.UNAUTHORIZED.value if HTTP_AVAILABLE and HTTPStatus is not None else 401
    grpc_status: ClassVar[int] = (
        StatusCode.UNAUTHENTICATED.value[0]
        if GRPC_AVAILABLE and StatusCode is not None and isinstance(StatusCode.UNAUTHENTICATED.value, tuple)
        else (
            StatusCode.UNAUTHENTICATED.value
            if GRPC_AVAILABLE and StatusCode is not None and StatusCode is not None
            else 16
        )
    )

    def __init__(
        self,
        username: str | None = None,
        lang: LanguageType | None = None,
        additional_data: dict | None = None,
    ) -> None:
        data = {"username": username} if username else {}
        if additional_data:
            data.update(additional_data)
        super().__init__(lang=lang, additional_data=data or None)

    def get_message(self) -> str:
        """Gets the localized error message with username."""
        template = self.message_fa if self.lang == LanguageType.FA else self.message_en
        username = self.additional_data.get("username", "username")
        return template.format(username=username)

get_message ¶

get_message() -> str

Gets the localized error message with username.

Source code in archipy/models/errors/auth_errors.py

def get_message(self) -> str:
    """Gets the localized error message with username."""
    template = self.message_fa if self.lang == LanguageType.FA else self.message_en
    username = self.additional_data.get("username", "username")
    return template.format(username=username)

TokenExpiredError ¶

Exception raised when a token has expired.

Source code in archipy/models/errors/auth_errors.py

class TokenExpiredError(BaseError):
    """Exception raised when a token has expired."""

    code: ClassVar[str] = "TOKEN_EXPIRED"
    message_en: ClassVar[str] = "Authentication token has expired"
    message_fa: ClassVar[str] = "توکن احراز هویت منقضی شده است."
    http_status: ClassVar[int] = HTTPStatus.UNAUTHORIZED.value if HTTP_AVAILABLE and HTTPStatus is not None else 401
    grpc_status: ClassVar[int] = (
        StatusCode.UNAUTHENTICATED.value[0]
        if GRPC_AVAILABLE and StatusCode is not None and isinstance(StatusCode.UNAUTHENTICATED.value, tuple)
        else (
            StatusCode.UNAUTHENTICATED.value
            if GRPC_AVAILABLE and StatusCode is not None and StatusCode is not None
            else 16
        )
    )

InvalidTokenError ¶

Exception raised when a token is invalid.

Source code in archipy/models/errors/auth_errors.py

class InvalidTokenError(BaseError):
    """Exception raised when a token is invalid."""

    code: ClassVar[str] = "INVALID_TOKEN"
    message_en: ClassVar[str] = "Invalid authentication token"
    message_fa: ClassVar[str] = "توکن احراز هویت نامعتبر است."
    http_status: ClassVar[int] = HTTPStatus.UNAUTHORIZED.value if HTTP_AVAILABLE and HTTPStatus is not None else 401
    grpc_status: ClassVar[int] = (
        StatusCode.UNAUTHENTICATED.value[0]
        if GRPC_AVAILABLE and StatusCode is not None and isinstance(StatusCode.UNAUTHENTICATED.value, tuple)
        else (
            StatusCode.UNAUTHENTICATED.value
            if GRPC_AVAILABLE and StatusCode is not None and StatusCode is not None
            else 16
        )
    )

SessionExpiredError ¶

Exception raised when a session has expired.

Methods:

Name	Description
`get_message`	Gets the localized error message with session ID.

Source code in archipy/models/errors/auth_errors.py

class SessionExpiredError(BaseError):
    """Exception raised when a session has expired."""

    code: ClassVar[str] = "SESSION_EXPIRED"
    message_en: ClassVar[str] = "Session has expired: {session_id}"
    message_fa: ClassVar[str] = "نشست کاربری منقضی شده است: {session_id}"
    http_status: ClassVar[int] = HTTPStatus.UNAUTHORIZED.value if HTTP_AVAILABLE and HTTPStatus is not None else 401
    grpc_status: ClassVar[int] = (
        StatusCode.UNAUTHENTICATED.value[0]
        if GRPC_AVAILABLE and StatusCode is not None and isinstance(StatusCode.UNAUTHENTICATED.value, tuple)
        else (
            StatusCode.UNAUTHENTICATED.value
            if GRPC_AVAILABLE and StatusCode is not None and StatusCode is not None
            else 16
        )
    )

    def __init__(
        self,
        session_id: str | None = None,
        lang: LanguageType | None = None,
        additional_data: dict | None = None,
    ) -> None:
        data = {"session_id": session_id} if session_id else {}
        if additional_data:
            data.update(additional_data)
        super().__init__(lang=lang, additional_data=data or None)

    def get_message(self) -> str:
        """Gets the localized error message with session ID."""
        template = self.message_fa if self.lang == LanguageType.FA else self.message_en
        session_id = self.additional_data.get("session_id", "session_id")
        return template.format(session_id=session_id)

get_message ¶

get_message() -> str

Gets the localized error message with session ID.

Source code in archipy/models/errors/auth_errors.py

def get_message(self) -> str:
    """Gets the localized error message with session ID."""
    template = self.message_fa if self.lang == LanguageType.FA else self.message_en
    session_id = self.additional_data.get("session_id", "session_id")
    return template.format(session_id=session_id)

PermissionDeniedError ¶

Exception raised when permission is denied.

Source code in archipy/models/errors/auth_errors.py

class PermissionDeniedError(BaseError):
    """Exception raised when permission is denied."""

    code: ClassVar[str] = "PERMISSION_DENIED"
    message_en: ClassVar[str] = "Permission denied for this operation"
    message_fa: ClassVar[str] = "دسترسی برای انجام این عملیات وجود ندارد."
    http_status: ClassVar[int] = (
        HTTPStatus.FORBIDDEN.value if HTTP_AVAILABLE and HTTPStatus is not None and HTTPStatus is not None else 403
    )
    grpc_status: ClassVar[int] = (
        StatusCode.PERMISSION_DENIED.value[0]
        if GRPC_AVAILABLE and StatusCode is not None and isinstance(StatusCode.PERMISSION_DENIED.value, tuple)
        else (
            StatusCode.PERMISSION_DENIED.value
            if GRPC_AVAILABLE and StatusCode is not None and StatusCode is not None
            else 7
        )
    )

AccountLockedError ¶

Exception raised when an account is locked.

Source code in archipy/models/errors/auth_errors.py

class AccountLockedError(BaseError):
    """Exception raised when an account is locked."""

    code: ClassVar[str] = "ACCOUNT_LOCKED"
    message_en: ClassVar[str] = "Account has been locked due to too many failed attempts"
    message_fa: ClassVar[str] = "حساب کاربری به دلیل تلاش‌های ناموفق متعدد قفل شده است"
    http_status: ClassVar[int] = (
        HTTPStatus.FORBIDDEN.value if HTTP_AVAILABLE and HTTPStatus is not None and HTTPStatus is not None else 403
    )
    grpc_status: ClassVar[int] = (
        StatusCode.PERMISSION_DENIED.value[0]
        if GRPC_AVAILABLE and StatusCode is not None and isinstance(StatusCode.PERMISSION_DENIED.value, tuple)
        else (
            StatusCode.PERMISSION_DENIED.value
            if GRPC_AVAILABLE and StatusCode is not None and StatusCode is not None
            else 7
        )
    )

    def __init__(
        self,
        username: str | None = None,
        lockout_duration: int | None = None,
        lang: LanguageType | None = None,
        additional_data: dict | None = None,
    ) -> None:
        data = {}
        if username:
            data["username"] = username
        if lockout_duration:
            data["lockout_duration"] = lockout_duration
        if additional_data:
            data.update(additional_data)
        super().__init__(lang=lang, additional_data=data or None)

AccountDisabledError ¶

Exception raised when an account is disabled.

Source code in archipy/models/errors/auth_errors.py

class AccountDisabledError(BaseError):
    """Exception raised when an account is disabled."""

    code: ClassVar[str] = "ACCOUNT_DISABLED"
    message_en: ClassVar[str] = "Account has been disabled"
    message_fa: ClassVar[str] = "حساب کاربری غیرفعال شده است"
    http_status: ClassVar[int] = (
        HTTPStatus.FORBIDDEN.value if HTTP_AVAILABLE and HTTPStatus is not None and HTTPStatus is not None else 403
    )
    grpc_status: ClassVar[int] = (
        StatusCode.PERMISSION_DENIED.value[0]
        if GRPC_AVAILABLE and StatusCode is not None and isinstance(StatusCode.PERMISSION_DENIED.value, tuple)
        else (
            StatusCode.PERMISSION_DENIED.value
            if GRPC_AVAILABLE and StatusCode is not None and StatusCode is not None
            else 7
        )
    )

    def __init__(
        self,
        username: str | None = None,
        reason: str | None = None,
        lang: LanguageType | None = None,
        additional_data: dict | None = None,
    ) -> None:
        data = {}
        if username:
            data["username"] = username
        if reason:
            data["reason"] = reason
        if additional_data:
            data.update(additional_data)
        super().__init__(lang=lang, additional_data=data or None)

InvalidVerificationCodeError ¶

Exception raised when a verification code is invalid.

Source code in archipy/models/errors/auth_errors.py

class InvalidVerificationCodeError(BaseError):
    """Exception raised when a verification code is invalid."""

    code: ClassVar[str] = "INVALID_VERIFICATION_CODE"
    message_en: ClassVar[str] = "Invalid verification code"
    message_fa: ClassVar[str] = "کد تایید نامعتبر است"
    http_status: ClassVar[int] = (
        HTTPStatus.BAD_REQUEST.value if HTTP_AVAILABLE and HTTPStatus is not None and HTTPStatus is not None else 400
    )
    grpc_status: ClassVar[int] = (
        StatusCode.INVALID_ARGUMENT.value[0]
        if GRPC_AVAILABLE and StatusCode is not None and isinstance(StatusCode.INVALID_ARGUMENT.value, tuple)
        else (
            StatusCode.INVALID_ARGUMENT.value
            if GRPC_AVAILABLE and StatusCode is not None and StatusCode is not None
            else 3
        )
    )

    def __init__(
        self,
        code: str | None = None,
        remaining_attempts: int | None = None,
        lang: LanguageType | None = None,
        additional_data: dict | None = None,
    ) -> None:
        data = {}
        if code:
            data["code"] = code
        if remaining_attempts is not None:
            data["remaining_attempts"] = remaining_attempts
        if additional_data:
            data.update(additional_data)
        super().__init__(lang=lang, additional_data=data or None)

options: show_root_toc_entry: false heading_level: 3

Validation Errors¶

Exceptions for input validation and data integrity failures.

Classes:

Name	Description
`InvalidArgumentError`	Exception raised for invalid arguments.
`InvalidFormatError`	Exception raised for invalid data formats.
`InvalidEmailError`	Exception raised for invalid email formats.
`InvalidPhoneNumberError`	Exception raised for invalid phone numbers.
`InvalidLandlineNumberError`	Exception raised for invalid landline numbers.
`InvalidNationalCodeError`	Exception raised for invalid national codes.
`InvalidPasswordError`	Exception raised when a password does not meet the security requirements.
`InvalidDateError`	Exception raised for invalid date formats.
`InvalidUrlError`	Exception raised for invalid URL formats.
`InvalidIpError`	Exception raised for invalid IP address formats.
`InvalidJsonError`	Exception raised for invalid JSON formats.
`InvalidTimestampError`	Exception raised when a timestamp format is invalid.
`OutOfRangeError`	Exception raised when a value is out of range.