blob: bbd4040f5bec0cd22a6fc1ccfb9aa1538720df66 (
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
from __future__ import annotations
from typing import Any
__all__ = ("MissingDependencyException", "SerializationException", "LitestarException", "LitestarWarning")
class LitestarException(Exception):
"""Base exception class from which all Litestar exceptions inherit."""
detail: str
def __init__(self, *args: Any, detail: str = "") -> None:
"""Initialize ``LitestarException``.
Args:
*args: args are converted to :class:`str` before passing to :class:`Exception`
detail: detail of the exception.
"""
str_args = [str(arg) for arg in args if arg]
if not detail:
if str_args:
detail, *str_args = str_args
elif hasattr(self, "detail"):
detail = self.detail
self.detail = detail
super().__init__(*str_args)
def __repr__(self) -> str:
if self.detail:
return f"{self.__class__.__name__} - {self.detail}"
return self.__class__.__name__
def __str__(self) -> str:
return " ".join((*self.args, self.detail)).strip()
class MissingDependencyException(LitestarException, ImportError):
"""Missing optional dependency.
This exception is raised only when a module depends on a dependency that has not been installed.
"""
def __init__(self, package: str, install_package: str | None = None, extra: str | None = None) -> None:
super().__init__(
f"Package {package!r} is not installed but required. You can install it by running "
f"'pip install litestar[{extra or install_package or package}]' to install litestar with the required extra "
f"or 'pip install {install_package or package}' to install the package separately"
)
class SerializationException(LitestarException):
"""Encoding or decoding of an object failed."""
class LitestarWarning(UserWarning):
"""Base class for Litestar warnings"""
|
