committee_actions.py

"""Custom exception classes for committee-action tracking."""

from typing import TYPE_CHECKING, override

from typed_classproperties import classproperty

from .base import BaseTeXBotError

if TYPE_CHECKING:
    from collections.abc import Sequence

__all__: "Sequence[str]" = ("InvalidActionDescriptionError", "InvalidActionTargetError")


class InvalidActionTargetError(BaseTeXBotError, RuntimeError):
    """
    Exception class to raise when the desired target of a committee action is invalid.

    This could be that the target user is not in the server.
    """

    @classproperty
    @override
    def DEFAULT_MESSAGE(cls) -> str:
        return "The target of the action is invalid."


class InvalidActionDescriptionError(BaseTeXBotError, RuntimeError):
    """
    Exception class to raise when the description of a committee action is invalid.

    This could be due to it being too long, or some other validation issue.
    """

    @classproperty
    @override
    def DEFAULT_MESSAGE(cls) -> str:
        return "The description of the action is invalid."