aboutsummaryrefslogtreecommitdiff
path: root/tools/cru-py/cru/_error.py
blob: e4bf3d6f2da74b7f7f7680ddf6e377218f6f97fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
from typing import NoReturn


class CruException(Exception):
    """Base exception class of all exceptions in cru."""


class CruUnreachableError(CruException):
    """Raised when a code path is unreachable."""


def cru_unreachable() -> NoReturn:
    raise CruUnreachableError()


class CruInternalError(CruException):
    """Raised when an internal logic error occurs."""


class CruUserFriendlyException(CruException):
    def __init__(
        self, message: str, user_message: str | None = None, *args, **kwargs
    ) -> None:
        super().__init__(message, *args, **kwargs)
        self._user_message = user_message or message

    @property
    def user_message(self) -> str:
        return self._user_message