File size: 3,297 Bytes
5b76e0f | 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 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 | from __future__ import annotations
import sys
import inspect
from typing import Callable, TYPE_CHECKING
import rich.repr
from rich.console import RenderableType
__all__ = ["log", "panic"]
from ._context import active_app
from ._log import LogGroup, LogVerbosity
if TYPE_CHECKING:
from .app import App
if sys.version_info >= (3, 10):
from typing import TypeAlias
else: # pragma: no cover
from typing_extensions import TypeAlias
LogCallable: TypeAlias = "Callable"
class LoggerError(Exception):
"""Raised when the logger failed."""
@rich.repr.auto
class Logger:
"""A Textual logger."""
def __init__(
self,
log_callable: LogCallable | None,
group: LogGroup = LogGroup.INFO,
verbosity: LogVerbosity = LogVerbosity.NORMAL,
) -> None:
self._log = log_callable
self._group = group
self._verbosity = verbosity
@property
def log(self) -> LogCallable:
if self._log is None:
try:
app = active_app.get()
except LookupError:
raise LoggerError("Unable to log without an active app.") from None
return app._log
return self._log
def __rich_repr__(self) -> rich.repr.Result:
yield self._group, LogGroup.INFO
yield self._verbosity, LogVerbosity.NORMAL
def __call__(self, *args: object, **kwargs) -> None:
caller = inspect.stack()[1]
try:
self.log(
self._group,
self._verbosity,
*args,
_textual_calling_frame=caller,
**kwargs,
)
except LoggerError:
# If there is not active app, try printing
print_args = (*args, *[f"{key}={value!r}" for key, value in kwargs.items()])
print(*print_args)
def verbosity(self, verbose: bool) -> Logger:
"""Get a new logger with selective verbosity.
Args:
verbose (bool): True to use HIGH verbosity, otherwise NORMAL.
Returns:
Logger: New logger.
"""
verbosity = LogVerbosity.HIGH if verbose else LogVerbosity.NORMAL
return Logger(self._log, self._group, verbosity)
@property
def verbose(self) -> Logger:
"""A verbose logger."""
return Logger(self._log, self._group, LogVerbosity.HIGH)
@property
def event(self) -> Logger:
"""Logs events."""
return Logger(self._log, LogGroup.EVENT)
@property
def debug(self) -> Logger:
"""Logs debug messages."""
return Logger(self._log, LogGroup.DEBUG)
@property
def info(self) -> Logger:
"""Logs information."""
return Logger(self._log, LogGroup.INFO)
@property
def warning(self) -> Logger:
"""Logs warnings."""
return Logger(self._log, LogGroup.WARNING)
@property
def error(self) -> Logger:
"""Logs errors."""
return Logger(self._log, LogGroup.ERROR)
@property
def system(self) -> Logger:
"""Logs system information."""
return Logger(self._log, LogGroup.SYSTEM)
log = Logger(None)
def panic(*args: RenderableType) -> None:
from ._context import active_app
app = active_app.get()
app.panic(*args)
|