Wala shell

Advanced PHP File Manager

Server IP: 127.0.0.1 | PHP Version: 8.3.30 | Domains Hosted: 54

Name	Size	Last Modified
📁 ..	-	2026-03-27 02:58
📄 __init__.py """ The Loguru library provides a pre-instanced logger to facilitate dealing with logging in Python. Just ``from loguru import logger``. """ import atexit as _atexit import sys as _sys from . import _defaults from ._logger import Core as _Core from ._logger import Logger as _Logger __version__ = "0.7.3" __all__ = ["logger"] logger = _Logger( core=_Core(), exception=None, depth=0, record=False, lazy=False, colors=False, raw=False, capture=True, patchers=[], extra={}, ) if _defaults.LOGURU_AUTOINIT and _sys.stderr: logger.add(_sys.stderr) _atexit.register(logger.remove)	627 B	2025-05-25 12:26
📄 __init__.pyi import sys from asyncio import AbstractEventLoop from datetime import datetime, time, timedelta from logging import Handler from multiprocessing.context import BaseContext from types import TracebackType from typing import ( Any, BinaryIO, Callable, Dict, Generator, Generic, List, NamedTuple, NewType, Optional, Pattern, Sequence, TextIO, Tuple, Type, TypeVar, Union, overload, ) if sys.version_info >= (3, 6): from typing import Awaitable else: from typing_extensions import Awaitable if sys.version_info >= (3, 6): from os import PathLike from typing import ContextManager PathLikeStr = PathLike[str] else: from pathlib import PurePath as PathLikeStr from typing_extensions import ContextManager if sys.version_info >= (3, 8): from typing import Protocol, TypedDict else: from typing_extensions import Protocol, TypedDict _T = TypeVar("_T") _F = TypeVar("_F", bound=Callable[..., Any]) ExcInfo = Tuple[Optional[Type[BaseException]], Optional[BaseException], Optional[TracebackType]] class _GeneratorContextManager(ContextManager[_T], Generic[_T]): def __call__(self, func: _F) -> _F: ... def __exit__( self, typ: Optional[Type[BaseException]], value: Optional[BaseException], traceback: Optional[TracebackType], ) -> Optional[bool]: ... Catcher = NewType("Catcher", _GeneratorContextManager[None]) Contextualizer = NewType("Contextualizer", _GeneratorContextManager[None]) AwaitableCompleter = Awaitable[None] class Level(NamedTuple): name: str no: int color: str icon: str class _RecordAttribute: def __format__(self, spec: str) -> str: ... class RecordFile(_RecordAttribute): name: str path: str class RecordLevel(_RecordAttribute): name: str no: int icon: str class RecordThread(_RecordAttribute): id: int name: str class RecordProcess(_RecordAttribute): id: int name: str class RecordException(NamedTuple): type: Optional[Type[BaseException]] value: Optional[BaseException] traceback: Optional[TracebackType] class Record(TypedDict): elapsed: timedelta exception: Optional[RecordException] extra: Dict[Any, Any] file: RecordFile function: str level: RecordLevel line: int message: str module: str name: Optional[str] process: RecordProcess thread: RecordThread time: datetime class Message(str): record: Record class Writable(Protocol): def write(self, message: Message) -> None: ... FilterDict = Dict[Optional[str], Union[str, int, bool]] FilterFunction = Callable[[Record], bool] FormatFunction = Callable[[Record], str] PatcherFunction = Callable[[Record], None] RotationFunction = Callable[[Message, TextIO], bool] RetentionFunction = Callable[[List[str]], None] CompressionFunction = Callable[[str], None] StandardOpener = Callable[[str, int], int] class BasicHandlerConfig(TypedDict, total=False): sink: Union[TextIO, Writable, Callable[[Message], None], Handler] level: Union[str, int] format: Union[str, FormatFunction] filter: Optional[Union[str, FilterFunction, FilterDict]] colorize: Optional[bool] serialize: bool backtrace: bool diagnose: bool enqueue: bool catch: bool class FileHandlerConfig(TypedDict, total=False): sink: Union[str, PathLikeStr] level: Union[str, int] format: Union[str, FormatFunction] filter: Optional[Union[str, FilterFunction, FilterDict]] colorize: Optional[bool] serialize: bool backtrace: bool diagnose: bool enqueue: bool catch: bool rotation: Optional[Union[str, int, time, timedelta, RotationFunction]] retention: Optional[Union[str, int, timedelta, RetentionFunction]] compression: Optional[Union[str, CompressionFunction]] delay: bool watch: bool mode: str buffering: int encoding: str errors: Optional[str] newline: Optional[str] closefd: bool opener: Optional[StandardOpener] class AsyncHandlerConfig(TypedDict, total=False): sink: Callable[[Message], Awaitable[None]] level: Union[str, int] format: Union[str, FormatFunction] filter: Optional[Union[str, FilterFunction, FilterDict]] colorize: Optional[bool] serialize: bool backtrace: bool diagnose: bool enqueue: bool catch: bool context: Optional[Union[str, BaseContext]] loop: Optional[AbstractEventLoop] HandlerConfig = Union[BasicHandlerConfig, FileHandlerConfig, AsyncHandlerConfig] class LevelConfig(TypedDict, total=False): name: str no: int color: str icon: str ActivationConfig = Tuple[Optional[str], bool] class Logger: @overload def add( self, sink: Union[TextIO, Writable, Callable[[Message], None], Handler], , level: Union[str, int] = ..., format: Union[str, FormatFunction] = ..., filter: Optional[Union[str, FilterFunction, FilterDict]] = ..., colorize: Optional[bool] = ..., serialize: bool = ..., backtrace: bool = ..., diagnose: bool = ..., enqueue: bool = ..., context: Optional[Union[str, BaseContext]] = ..., catch: bool = ... ) -> int: ... @overload def add( self, sink: Callable[[Message], Awaitable[None]], , level: Union[str, int] = ..., format: Union[str, FormatFunction] = ..., filter: Optional[Union[str, FilterFunction, FilterDict]] = ..., colorize: Optional[bool] = ..., serialize: bool = ..., backtrace: bool = ..., diagnose: bool = ..., enqueue: bool = ..., catch: bool = ..., context: Optional[Union[str, BaseContext]] = ..., loop: Optional[AbstractEventLoop] = ... ) -> int: ... @overload def add( self, sink: Union[str, PathLikeStr], , level: Union[str, int] = ..., format: Union[str, FormatFunction] = ..., filter: Optional[Union[str, FilterFunction, FilterDict]] = ..., colorize: Optional[bool] = ..., serialize: bool = ..., backtrace: bool = ..., diagnose: bool = ..., enqueue: bool = ..., context: Optional[Union[str, BaseContext]] = ..., catch: bool = ..., rotation: Optional[Union[str, int, time, timedelta, RotationFunction]] = ..., retention: Optional[Union[str, int, timedelta, RetentionFunction]] = ..., compression: Optional[Union[str, CompressionFunction]] = ..., delay: bool = ..., watch: bool = ..., mode: str = ..., buffering: int = ..., encoding: str = ..., errors: Optional[str] = ..., newline: Optional[str] = ..., closefd: bool = ..., opener: Optional[StandardOpener] = ..., ) -> int: ... def remove(self, handler_id: Optional[int] = ...) -> None: ... def complete(self) -> AwaitableCompleter: ... @overload def catch( self, exception: Union[Type[BaseException], Tuple[Type[BaseException], ...]] = ..., , level: Union[str, int] = ..., reraise: bool = ..., onerror: Optional[Callable[[BaseException], None]] = ..., exclude: Optional[Union[Type[BaseException], Tuple[Type[BaseException], ...]]] = ..., default: Any = ..., message: str = ... ) -> Catcher: ... @overload def catch(self, function: _F) -> _F: ... def opt( self, , exception: Optional[Union[bool, ExcInfo, BaseException]] = ..., record: bool = ..., lazy: bool = ..., colors: bool = ..., raw: bool = ..., capture: bool = ..., depth: int = ..., ansi: bool = ... ) -> Logger: ... def bind(__self, kwargs: Any) -> Logger: ... # noqa: N805 def contextualize(__self, kwargs: Any) -> Contextualizer: ... # noqa: N805 def patch(self, patcher: PatcherFunction) -> Logger: ... @overload def level(self, name: str) -> Level: ... @overload def level( self, name: str, no: int = ..., color: Optional[str] = ..., icon: Optional[str] = ... ) -> Level: ... @overload def level( self, name: str, no: Optional[int] = ..., color: Optional[str] = ..., icon: Optional[str] = ..., ) -> Level: ... def disable(self, name: Optional[str]) -> None: ... def enable(self, name: Optional[str]) -> None: ... def configure( self, , handlers: Optional[Sequence[HandlerConfig]] = ..., levels: Optional[Sequence[LevelConfig]] = ..., extra: Optional[Dict[Any, Any]] = ..., patcher: Optional[PatcherFunction] = ..., activation: Optional[Sequence[ActivationConfig]] = ... ) -> List[int]: ... # @staticmethod cannot be used with @overload in mypy (python/mypy#7781). # However Logger is not exposed and logger is an instance of Logger # so for type checkers it is all the same whether it is defined here # as a static method or an instance method. @overload def parse( self, file: Union[str, PathLikeStr, TextIO], pattern: Union[str, Pattern[str]], , cast: Union[Dict[str, Callable[[str], Any]], Callable[[Dict[str, str]], None]] = ..., chunk: int = ... ) -> Generator[Dict[str, Any], None, None]: ... @overload def parse( self, file: BinaryIO, pattern: Union[bytes, Pattern[bytes]], , cast: Union[Dict[str, Callable[[bytes], Any]], Callable[[Dict[str, bytes]], None]] = ..., chunk: int = ... ) -> Generator[Dict[str, Any], None, None]: ... @overload def trace(__self, __message: str, args: Any, kwargs: Any) -> None: ... # noqa: N805 @overload def trace(__self, __message: Any) -> None: ... # noqa: N805 @overload def debug(__self, __message: str, args: Any, *kwargs: Any) -> None: ... # noqa: N805 @overload def debug(__self, __message: Any) -> None: ... # noqa: N805 @overload def info(__self, __message: str, args: Any, *kwargs: Any) -> None: ... # noqa: N805 @overload def info(__self, __message: Any) -> None: ... # noqa: N805 @overload def success(__self, __message: str, args: Any, *kwargs: Any) -> None: ... # noqa: N805 @overload def success(__self, __message: Any) -> None: ... # noqa: N805 @overload def warning(__self, __message: str, args: Any, *kwargs: Any) -> None: ... # noqa: N805 @overload def warning(__self, __message: Any) -> None: ... # noqa: N805 @overload def error(__self, __message: str, args: Any, *kwargs: Any) -> None: ... # noqa: N805 @overload def error(__self, __message: Any) -> None: ... # noqa: N805 @overload def critical(__self, __message: str, args: Any, *kwargs: Any) -> None: ... # noqa: N805 @overload def critical(__self, __message: Any) -> None: ... # noqa: N805 @overload def exception(__self, __message: str, args: Any, *kwargs: Any) -> None: ... # noqa: N805 @overload def exception(__self, __message: Any) -> None: ... # noqa: N805 @overload def log( __self, __level: Union[int, str], __message: str, args: Any, *kwargs: Any # noqa: N805 ) -> None: ... @overload def log(__self, __level: Union[int, str], __message: Any) -> None: ... # noqa: N805 def start(self, args: Any, *kwargs: Any) -> int: ... def stop(self, args: Any, **kwargs: Any) -> None: ... logger: Logger	11.38 KB	2025-05-25 12:26
📁 __pycache__	-	2025-05-25 12:26
📄 _asyncio_loop.py import asyncio import sys def load_loop_functions(): if sys.version_info >= (3, 7): def get_task_loop(task): return task.get_loop() get_running_loop = asyncio.get_running_loop else: def get_task_loop(task): return task._loop def get_running_loop(): loop = asyncio.get_event_loop() if not loop.is_running(): raise RuntimeError("There is no running event loop") return loop return get_task_loop, get_running_loop get_task_loop, get_running_loop = load_loop_functions()	597 B	2025-05-25 12:26
📄 _better_exceptions.py import builtins import inspect import io import keyword import linecache import os import re import sys import sysconfig import tokenize import traceback if sys.version_info >= (3, 11): def is_exception_group(exc): return isinstance(exc, ExceptionGroup) else: try: from exceptiongroup import ExceptionGroup except ImportError: def is_exception_group(exc): return False else: def is_exception_group(exc): return isinstance(exc, ExceptionGroup) class SyntaxHighlighter: _default_style = frozenset( { "comment": "\x1b[30m\x1b[1m{}\x1b[0m", "keyword": "\x1b[35m\x1b[1m{}\x1b[0m", "builtin": "\x1b[1m{}\x1b[0m", "string": "\x1b[36m{}\x1b[0m", "number": "\x1b[34m\x1b[1m{}\x1b[0m", "operator": "\x1b[35m\x1b[1m{}\x1b[0m", "punctuation": "\x1b[1m{}\x1b[0m", "constant": "\x1b[36m\x1b[1m{}\x1b[0m", "identifier": "\x1b[1m{}\x1b[0m", "other": "{}", }.items() ) _builtins = frozenset(dir(builtins)) _constants = frozenset({"True", "False", "None"}) _punctuation = frozenset({"(", ")", "[", "]", "{", "}", ":", ",", ";"}) if sys.version_info >= (3, 12): _strings = frozenset( {tokenize.STRING, tokenize.FSTRING_START, tokenize.FSTRING_MIDDLE, tokenize.FSTRING_END} ) _fstring_middle = tokenize.FSTRING_MIDDLE else: _strings = frozenset({tokenize.STRING}) _fstring_middle = None def __init__(self, style=None): self._style = style or dict(self._default_style) def highlight(self, source): style = self._style row, column = 0, 0 output = "" for token in self.tokenize(source): type_, string, (start_row, start_column), (_, end_column), line = token if type_ == self._fstring_middle: # When an f-string contains "{{" or "}}", they appear as "{" or "}" in the "string" # attribute of the token. However, they do not count in the column position. end_column += string.count("{") + string.count("}") if type_ == tokenize.NAME: if string in self._constants: color = style["constant"] elif keyword.iskeyword(string): color = style["keyword"] elif string in self._builtins: color = style["builtin"] else: color = style["identifier"] elif type_ == tokenize.OP: if string in self._punctuation: color = style["punctuation"] else: color = style["operator"] elif type_ == tokenize.NUMBER: color = style["number"] elif type_ in self._strings: color = style["string"] elif type_ == tokenize.COMMENT: color = style["comment"] else: color = style["other"] if start_row != row: source = source[column:] row, column = start_row, 0 if type_ != tokenize.ENCODING: output += line[column:start_column] output += color.format(line[start_column:end_column]) column = end_column output += source[column:] return output @staticmethod def tokenize(source): # Worth reading: https://www.asmeurer.com/brown-water-python/ source = source.encode("utf-8") source = io.BytesIO(source) try: yield from tokenize.tokenize(source.readline) except tokenize.TokenError: return class ExceptionFormatter: _default_theme = frozenset( { "introduction": "\x1b[33m\x1b[1m{}\x1b[0m", "cause": "\x1b[1m{}\x1b[0m", "context": "\x1b[1m{}\x1b[0m", "dirname": "\x1b[32m{}\x1b[0m", "basename": "\x1b[32m\x1b[1m{}\x1b[0m", "line": "\x1b[33m{}\x1b[0m", "function": "\x1b[35m{}\x1b[0m", "exception_type": "\x1b[31m\x1b[1m{}\x1b[0m", "exception_value": "\x1b[1m{}\x1b[0m", "arrows": "\x1b[36m{}\x1b[0m", "value": "\x1b[36m\x1b[1m{}\x1b[0m", }.items() ) def __init__( self, colorize=False, backtrace=False, diagnose=True, theme=None, style=None, max_length=128, encoding="ascii", hidden_frames_filename=None, prefix="", ): self._colorize = colorize self._diagnose = diagnose self._theme = theme or dict(self._default_theme) self._backtrace = backtrace self._syntax_highlighter = SyntaxHighlighter(style) self._max_length = max_length self._encoding = encoding self._hidden_frames_filename = hidden_frames_filename self._prefix = prefix self._lib_dirs = self._get_lib_dirs() self._pipe_char = self._get_char("\u2502", "\|") self._cap_char = self._get_char("\u2514", "->") self._catch_point_identifier = " <Loguru catch point here>" @staticmethod def _get_lib_dirs(): schemes = sysconfig.get_scheme_names() names = ["stdlib", "platstdlib", "platlib", "purelib"] paths = {sysconfig.get_path(name, scheme) for scheme in schemes for name in names} return [os.path.abspath(path).lower() + os.sep for path in paths if path in sys.path] @staticmethod def _indent(text, count, , prefix="\| "): if count == 0: yield text return for line in text.splitlines(True): indented = " " count + prefix + line yield indented.rstrip() + "\n" def _get_char(self, char, default): try: char.encode(self._encoding) except (UnicodeEncodeError, LookupError): return default else: return char def _is_file_mine(self, file): filepath = os.path.abspath(file).lower() if not filepath.endswith(".py"): return False return not any(filepath.startswith(d) for d in self._lib_dirs) def _extract_frames(self, tb, is_first, , limit=None, from_decorator=False): frames, final_source = [], None if tb is None or (limit is not None and limit <= 0): return frames, final_source def is_valid(frame): return frame.f_code.co_filename != self._hidden_frames_filename def get_info(frame, lineno): filename = frame.f_code.co_filename function = frame.f_code.co_name source = linecache.getline(filename, lineno).strip() return filename, lineno, function, source infos = [] if is_valid(tb.tb_frame): infos.append((get_info(tb.tb_frame, tb.tb_lineno), tb.tb_frame)) get_parent_only = from_decorator and not self._backtrace if (self._backtrace and is_first) or get_parent_only: frame = tb.tb_frame.f_back while frame: if is_valid(frame): infos.insert(0, (get_info(frame, frame.f_lineno), frame)) if get_parent_only: break frame = frame.f_back if infos and not get_parent_only: (filename, lineno, function, source), frame = infos[-1] function += self._catch_point_identifier infos[-1] = ((filename, lineno, function, source), frame) tb = tb.tb_next while tb: if is_valid(tb.tb_frame): infos.append((get_info(tb.tb_frame, tb.tb_lineno), tb.tb_frame)) tb = tb.tb_next if limit is not None: infos = infos[-limit:] for (filename, lineno, function, source), frame in infos: final_source = source if source: colorize = self._colorize and self._is_file_mine(filename) lines = [] if colorize: lines.append(self._syntax_highlighter.highlight(source)) else: lines.append(source) if self._diagnose: relevant_values = self._get_relevant_values(source, frame) values = self._format_relevant_values(list(relevant_values), colorize) lines += list(values) source = "\n ".join(lines) frames.append((filename, lineno, function, source)) return frames, final_source def _get_relevant_values(self, source, frame): value = None pending = None is_attribute = False is_valid_value = False is_assignment = True for token in self._syntax_highlighter.tokenize(source): type_, string, (_, col), _ = token if pending is not None: # Keyword arguments are ignored if type_ != tokenize.OP or string != "=" or is_assignment: yield pending pending = None if type_ == tokenize.NAME and not keyword.iskeyword(string): if not is_attribute: for variables in (frame.f_locals, frame.f_globals): try: value = variables[string] except KeyError: continue else: is_valid_value = True pending = (col, self._format_value(value)) break elif is_valid_value: try: value = inspect.getattr_static(value, string) except AttributeError: is_valid_value = False else: yield (col, self._format_value(value)) elif type_ == tokenize.OP and string == ".": is_attribute = True is_assignment = False elif type_ == tokenize.OP and string == ";": is_assignment = True is_attribute = False is_valid_value = False else: is_attribute = False is_valid_value = False is_assignment = False if pending is not None: yield pending def _format_relevant_values(self, relevant_values, colorize): for i in reversed(range(len(relevant_values))): col, value = relevant_values[i] pipe_cols = [pcol for pcol, _ in relevant_values[:i]] pre_line = "" index = 0 for pc in pipe_cols: pre_line += (" " * (pc - index)) + self._pipe_char index = pc + 1 pre_line += " " * (col - index) value_lines = value.split("\n") for n, value_line in enumerate(value_lines): if n == 0: arrows = pre_line + self._cap_char + " " else: arrows = pre_line + " " * (len(self._cap_char) + 1) if colorize: arrows = self._theme["arrows"].format(arrows) value_line = self._theme["value"].format(value_line) yield arrows + value_line def _format_value(self, v): try: v = repr(v) except Exception: v = "<unprintable %s object>" % type(v).__name__ max_length = self._max_length if max_length is not None and len(v) > max_length: v = v[: max_length - 3] + "..." return v def _format_locations(self, frames_lines, , has_introduction): prepend_with_new_line = has_introduction regex = r'^ File "(?P<file>.?)", line (?P<line>[^,]+)(?:, in (?P<function>.))?\n' for frame in frames_lines: match = re.match(regex, frame) if match: file, line, function = match.group("file", "line", "function") is_mine = self._is_file_mine(file) if function is not None: pattern = ' File "{}", line {}, in {}\n' else: pattern = ' File "{}", line {}\n' if self._backtrace and function and function.endswith(self._catch_point_identifier): function = function[: -len(self._catch_point_identifier)] pattern = ">" + pattern[1:] if self._colorize and is_mine: dirname, basename = os.path.split(file) if dirname: dirname += os.sep dirname = self._theme["dirname"].format(dirname) basename = self._theme["basename"].format(basename) file = dirname + basename line = self._theme["line"].format(line) function = self._theme["function"].format(function) if self._diagnose and (is_mine or prepend_with_new_line): pattern = "\n" + pattern location = pattern.format(file, line, function) frame = location + frame[match.end() :] prepend_with_new_line = is_mine yield frame def _format_exception( self, value, tb, , seen=None, is_first=False, from_decorator=False, group_nesting=0 ): # Implemented from built-in traceback module: # https://github.com/python/cpython/blob/a5b76167/Lib/traceback.py#L468 exc_type, exc_value, exc_traceback = type(value), value, tb if seen is None: seen = set() seen.add(id(exc_value)) if exc_value: if exc_value.__cause__ is not None and id(exc_value.__cause__) not in seen: yield from self._format_exception( exc_value.__cause__, exc_value.__cause__.__traceback__, seen=seen, group_nesting=group_nesting, ) cause = "The above exception was the direct cause of the following exception:" if self._colorize: cause = self._theme["cause"].format(cause) if self._diagnose: yield from self._indent("\n\n" + cause + "\n\n\n", group_nesting) else: yield from self._indent("\n" + cause + "\n\n", group_nesting) elif ( exc_value.__context__ is not None and id(exc_value.__context__) not in seen and not exc_value.__suppress_context__ ): yield from self._format_exception( exc_value.__context__, exc_value.__context__.__traceback__, seen=seen, group_nesting=group_nesting, ) context = "During handling of the above exception, another exception occurred:" if self._colorize: context = self._theme["context"].format(context) if self._diagnose: yield from self._indent("\n\n" + context + "\n\n\n", group_nesting) else: yield from self._indent("\n" + context + "\n\n", group_nesting) is_grouped = is_exception_group(value) if is_grouped and group_nesting == 0: yield from self._format_exception( value, tb, seen=seen, group_nesting=1, is_first=is_first, from_decorator=from_decorator, ) return try: traceback_limit = sys.tracebacklimit except AttributeError: traceback_limit = None frames, final_source = self._extract_frames( exc_traceback, is_first, limit=traceback_limit, from_decorator=from_decorator ) exception_only = traceback.format_exception_only(exc_type, exc_value) # Determining the correct index for the "Exception: message" part in the formatted exception # is challenging. This is because it might be preceded by multiple lines specific to # "SyntaxError" or followed by various notes. However, we can make an educated guess based # on the indentation; the preliminary context for "SyntaxError" is always indented, while # the Exception itself is not. This allows us to identify the correct index for the # exception message. no_indented_indexes = (i for i, p in enumerate(exception_only) if not p.startswith(" ")) error_message_index = next(no_indented_indexes, None) if error_message_index is not None: # Remove final new line temporarily. error_message = exception_only[error_message_index][:-1] if self._colorize: if ":" in error_message: exception_type, exception_value = error_message.split(":", 1) exception_type = self._theme["exception_type"].format(exception_type) exception_value = self._theme["exception_value"].format(exception_value) error_message = exception_type + ":" + exception_value else: error_message = self._theme["exception_type"].format(error_message) if self._diagnose and frames: if issubclass(exc_type, AssertionError) and not str(exc_value) and final_source: if self._colorize: final_source = self._syntax_highlighter.highlight(final_source) error_message += ": " + final_source error_message = "\n" + error_message exception_only[error_message_index] = error_message + "\n" if is_first: yield self._prefix has_introduction = bool(frames) if has_introduction: if is_grouped: introduction = "Exception Group Traceback (most recent call last):" else: introduction = "Traceback (most recent call last):" if self._colorize: introduction = self._theme["introduction"].format(introduction) if group_nesting == 1: # Implies we're processing the root ExceptionGroup. yield from self._indent(introduction + "\n", group_nesting, prefix="+ ") else: yield from self._indent(introduction + "\n", group_nesting) frames_lines = self._format_list(frames) + exception_only if self._colorize or self._backtrace or self._diagnose: frames_lines = self._format_locations(frames_lines, has_introduction=has_introduction) yield from self._indent("".join(frames_lines), group_nesting) if is_grouped: exc = None for n, exc in enumerate(value.exceptions, start=1): ruler = "+" + (" %s " % ("..." if n > 15 else n)).center(35, "-") yield from self._indent(ruler, group_nesting, prefix="+-" if n == 1 else " ") if n > 15: message = "and %d more exceptions\n" % (len(value.exceptions) - 15) yield from self._indent(message, group_nesting + 1) break elif group_nesting == 10 and is_exception_group(exc): message = "... (max_group_depth is 10)\n" yield from self._indent(message, group_nesting + 1) else: yield from self._format_exception( exc, exc.__traceback__, seen=seen, group_nesting=group_nesting + 1, ) if not is_exception_group(exc) or group_nesting == 10: yield from self._indent("-" * 35, group_nesting + 1, prefix="+-") def _format_list(self, frames): def source_message(filename, lineno, name, line): message = ' File "%s", line %d, in %s\n' % (filename, lineno, name) if line: message += " %s\n" % line.strip() return message def skip_message(count): plural = "s" if count > 1 else "" return " [Previous line repeated %d more time%s]\n" % (count, plural) result = [] count = 0 last_source = None for source, line in frames: if source != last_source and count > 3: result.append(skip_message(count - 3)) if source == last_source: count += 1 if count > 3: continue else: count = 1 result.append(source_message(source, line)) last_source = source # Add a final skip message if the iteration of frames ended mid-repetition. if count > 3: result.append(skip_message(count - 3)) return result def format_exception(self, type_, value, tb, *, from_decorator=False): yield from self._format_exception(value, tb, is_first=True, from_decorator=from_decorator)	21.01 KB	2025-05-25 12:26
📄 _colorama.py import builtins import os import sys def should_colorize(stream): if stream is None: return False if getattr(builtins, "__IPYTHON__", False) and (stream is sys.stdout or stream is sys.stderr): try: import ipykernel import IPython ipython = IPython.get_ipython() is_jupyter_stream = isinstance(stream, ipykernel.iostream.OutStream) is_jupyter_shell = isinstance(ipython, ipykernel.zmqshell.ZMQInteractiveShell) except Exception: pass else: if is_jupyter_stream and is_jupyter_shell: return True if stream is sys.__stdout__ or stream is sys.__stderr__: if "CI" in os.environ and any( ci in os.environ for ci in ["TRAVIS", "CIRCLECI", "APPVEYOR", "GITLAB_CI", "GITHUB_ACTIONS"] ): return True if "PYCHARM_HOSTED" in os.environ: return True if os.name == "nt" and "TERM" in os.environ: return True try: return stream.isatty() except Exception: return False def should_wrap(stream): if os.name != "nt": return False if stream is not sys.__stdout__ and stream is not sys.__stderr__: return False from colorama.win32 import winapi_test if not winapi_test(): return False try: from colorama.winterm import enable_vt_processing except ImportError: return True try: return not enable_vt_processing(stream.fileno()) except Exception: return True def wrap(stream): from colorama import AnsiToWin32 return AnsiToWin32(stream, convert=True, strip=True, autoreset=False).stream	1.69 KB	2025-05-25 12:26
📄 _colorizer.py import re from string import Formatter class Style: RESET_ALL = 0 BOLD = 1 DIM = 2 ITALIC = 3 UNDERLINE = 4 BLINK = 5 REVERSE = 7 HIDE = 8 STRIKE = 9 NORMAL = 22 class Fore: BLACK = 30 RED = 31 GREEN = 32 YELLOW = 33 BLUE = 34 MAGENTA = 35 CYAN = 36 WHITE = 37 RESET = 39 LIGHTBLACK_EX = 90 LIGHTRED_EX = 91 LIGHTGREEN_EX = 92 LIGHTYELLOW_EX = 93 LIGHTBLUE_EX = 94 LIGHTMAGENTA_EX = 95 LIGHTCYAN_EX = 96 LIGHTWHITE_EX = 97 class Back: BLACK = 40 RED = 41 GREEN = 42 YELLOW = 43 BLUE = 44 MAGENTA = 45 CYAN = 46 WHITE = 47 RESET = 49 LIGHTBLACK_EX = 100 LIGHTRED_EX = 101 LIGHTGREEN_EX = 102 LIGHTYELLOW_EX = 103 LIGHTBLUE_EX = 104 LIGHTMAGENTA_EX = 105 LIGHTCYAN_EX = 106 LIGHTWHITE_EX = 107 def ansi_escape(codes): return {name: "\033[%dm" % code for name, code in codes.items()} class TokenType: TEXT = 1 ANSI = 2 LEVEL = 3 CLOSING = 4 class AnsiParser: _style = ansi_escape( { "b": Style.BOLD, "d": Style.DIM, "n": Style.NORMAL, "h": Style.HIDE, "i": Style.ITALIC, "l": Style.BLINK, "s": Style.STRIKE, "u": Style.UNDERLINE, "v": Style.REVERSE, "bold": Style.BOLD, "dim": Style.DIM, "normal": Style.NORMAL, "hide": Style.HIDE, "italic": Style.ITALIC, "blink": Style.BLINK, "strike": Style.STRIKE, "underline": Style.UNDERLINE, "reverse": Style.REVERSE, } ) _foreground = ansi_escape( { "k": Fore.BLACK, "r": Fore.RED, "g": Fore.GREEN, "y": Fore.YELLOW, "e": Fore.BLUE, "m": Fore.MAGENTA, "c": Fore.CYAN, "w": Fore.WHITE, "lk": Fore.LIGHTBLACK_EX, "lr": Fore.LIGHTRED_EX, "lg": Fore.LIGHTGREEN_EX, "ly": Fore.LIGHTYELLOW_EX, "le": Fore.LIGHTBLUE_EX, "lm": Fore.LIGHTMAGENTA_EX, "lc": Fore.LIGHTCYAN_EX, "lw": Fore.LIGHTWHITE_EX, "black": Fore.BLACK, "red": Fore.RED, "green": Fore.GREEN, "yellow": Fore.YELLOW, "blue": Fore.BLUE, "magenta": Fore.MAGENTA, "cyan": Fore.CYAN, "white": Fore.WHITE, "light-black": Fore.LIGHTBLACK_EX, "light-red": Fore.LIGHTRED_EX, "light-green": Fore.LIGHTGREEN_EX, "light-yellow": Fore.LIGHTYELLOW_EX, "light-blue": Fore.LIGHTBLUE_EX, "light-magenta": Fore.LIGHTMAGENTA_EX, "light-cyan": Fore.LIGHTCYAN_EX, "light-white": Fore.LIGHTWHITE_EX, } ) _background = ansi_escape( { "K": Back.BLACK, "R": Back.RED, "G": Back.GREEN, "Y": Back.YELLOW, "E": Back.BLUE, "M": Back.MAGENTA, "C": Back.CYAN, "W": Back.WHITE, "LK": Back.LIGHTBLACK_EX, "LR": Back.LIGHTRED_EX, "LG": Back.LIGHTGREEN_EX, "LY": Back.LIGHTYELLOW_EX, "LE": Back.LIGHTBLUE_EX, "LM": Back.LIGHTMAGENTA_EX, "LC": Back.LIGHTCYAN_EX, "LW": Back.LIGHTWHITE_EX, "BLACK": Back.BLACK, "RED": Back.RED, "GREEN": Back.GREEN, "YELLOW": Back.YELLOW, "BLUE": Back.BLUE, "MAGENTA": Back.MAGENTA, "CYAN": Back.CYAN, "WHITE": Back.WHITE, "LIGHT-BLACK": Back.LIGHTBLACK_EX, "LIGHT-RED": Back.LIGHTRED_EX, "LIGHT-GREEN": Back.LIGHTGREEN_EX, "LIGHT-YELLOW": Back.LIGHTYELLOW_EX, "LIGHT-BLUE": Back.LIGHTBLUE_EX, "LIGHT-MAGENTA": Back.LIGHTMAGENTA_EX, "LIGHT-CYAN": Back.LIGHTCYAN_EX, "LIGHT-WHITE": Back.LIGHTWHITE_EX, } ) _regex_tag = re.compile(r"(\\)(</?(?:[fb]g\s)?[^<>\s]>)") def __init__(self): self._tokens = [] self._tags = [] self._color_tokens = [] @staticmethod def strip(tokens): output = "" for type_, value in tokens: if type_ == TokenType.TEXT: output += value return output @staticmethod def colorize(tokens, ansi_level): output = "" for type_, value in tokens: if type_ == TokenType.LEVEL: if ansi_level is None: raise ValueError( "The '<level>' color tag is not allowed in this context, " "it has not yet been associated to any color value." ) value = ansi_level output += value return output @staticmethod def wrap(tokens, , ansi_level, color_tokens): output = "" for type_, value in tokens: if type_ == TokenType.LEVEL: value = ansi_level output += value if type_ == TokenType.CLOSING: for subtype, subvalue in color_tokens: if subtype == TokenType.LEVEL: subvalue = ansi_level output += subvalue return output def feed(self, text, , raw=False): if raw: self._tokens.append((TokenType.TEXT, text)) return position = 0 for match in self._regex_tag.finditer(text): escaping, markup = match.group(1), match.group(2) self._tokens.append((TokenType.TEXT, text[position : match.start()])) position = match.end() escaping_count = len(escaping) backslashes = "\\" * (escaping_count // 2) if escaping_count % 2 == 1: self._tokens.append((TokenType.TEXT, backslashes + markup)) continue if escaping_count > 0: self._tokens.append((TokenType.TEXT, backslashes)) is_closing = markup[1] == "/" tag = markup[2:-1] if is_closing else markup[1:-1] if is_closing: if self._tags and (tag == "" or tag == self._tags[-1]): self._tags.pop() self._color_tokens.pop() self._tokens.append((TokenType.CLOSING, "\033[0m")) self._tokens.extend(self._color_tokens) continue if tag in self._tags: raise ValueError('Closing tag "%s" violates nesting rules' % markup) raise ValueError('Closing tag "%s" has no corresponding opening tag' % markup) if tag in {"lvl", "level"}: token = (TokenType.LEVEL, None) else: ansi = self._get_ansicode(tag) if ansi is None: raise ValueError( 'Tag "%s" does not correspond to any known color directive, ' "make sure you did not misspelled it (or prepend '\\' to escape it)" % markup ) token = (TokenType.ANSI, ansi) self._tags.append(tag) self._color_tokens.append(token) self._tokens.append(token) self._tokens.append((TokenType.TEXT, text[position:])) def done(self, , strict=True): if strict and self._tags: faulty_tag = self._tags.pop(0) raise ValueError('Opening tag "<%s>" has no corresponding closing tag' % faulty_tag) return self._tokens def current_color_tokens(self): return list(self._color_tokens) def _get_ansicode(self, tag): style = self._style foreground = self._foreground background = self._background # Substitute on a direct match. if tag in style: return style[tag] if tag in foreground: return foreground[tag] if tag in background: return background[tag] # An alternative syntax for setting the color (e.g. <fg red>, <bg red>). if tag.startswith("fg ") or tag.startswith("bg "): st, color = tag[:2], tag[3:] code = "38" if st == "fg" else "48" if st == "fg" and color.lower() in foreground: return foreground[color.lower()] if st == "bg" and color.upper() in background: return background[color.upper()] if color.isdigit() and int(color) <= 255: return "\033[%s;5;%sm" % (code, color) if re.match(r"#(?:[a-fA-F0-9]{3}){1,2}$", color): hex_color = color[1:] if len(hex_color) == 3: hex_color = 2 rgb = tuple(int(hex_color[i : i + 2], 16) for i in (0, 2, 4)) return "\033[%s;2;%s;%s;%sm" % ((code, rgb)) if color.count(",") == 2: colors = tuple(color.split(",")) if all(x.isdigit() and int(x) <= 255 for x in colors): return "\033[%s;2;%s;%s;%sm" % ((code, colors)) return None class ColoringMessage(str): __fields__ = ("_messages",) def __format__(self, spec): return next(self._messages).__format__(spec) class ColoredMessage: def __init__(self, tokens): self.tokens = tokens self.stripped = AnsiParser.strip(tokens) def colorize(self, ansi_level): return AnsiParser.colorize(self.tokens, ansi_level) class ColoredFormat: def __init__(self, tokens, messages_color_tokens): self._tokens = tokens self._messages_color_tokens = messages_color_tokens def strip(self): return AnsiParser.strip(self._tokens) def colorize(self, ansi_level): return AnsiParser.colorize(self._tokens, ansi_level) def make_coloring_message(self, message, , ansi_level, colored_message): messages = [ ( message if color_tokens is None else AnsiParser.wrap( colored_message.tokens, ansi_level=ansi_level, color_tokens=color_tokens ) ) for color_tokens in self._messages_color_tokens ] coloring = ColoringMessage(message) coloring._messages = iter(messages) return coloring class Colorizer: @staticmethod def prepare_format(string): tokens, messages_color_tokens = Colorizer._parse_without_formatting(string) return ColoredFormat(tokens, messages_color_tokens) @staticmethod def prepare_message(string, args=(), kwargs={}): # noqa: B006 tokens = Colorizer._parse_with_formatting(string, args, kwargs) return ColoredMessage(tokens) @staticmethod def prepare_simple_message(string): parser = AnsiParser() parser.feed(string) tokens = parser.done() return ColoredMessage(tokens) @staticmethod def ansify(text): parser = AnsiParser() parser.feed(text.strip()) tokens = parser.done(strict=False) return AnsiParser.colorize(tokens, None) @staticmethod def _parse_with_formatting( string, args, kwargs, , recursion_depth=2, auto_arg_index=0, recursive=False ): # This function re-implements Formatter._vformat() if recursion_depth < 0: raise ValueError("Max string recursion exceeded") formatter = Formatter() parser = AnsiParser() for literal_text, field_name, format_spec, conversion in formatter.parse(string): parser.feed(literal_text, raw=recursive) if field_name is not None: if field_name == "": if auto_arg_index is False: raise ValueError( "cannot switch from manual field " "specification to automatic field " "numbering" ) field_name = str(auto_arg_index) auto_arg_index += 1 elif field_name.isdigit(): if auto_arg_index: raise ValueError( "cannot switch from manual field " "specification to automatic field " "numbering" ) auto_arg_index = False obj, _ = formatter.get_field(field_name, args, kwargs) obj = formatter.convert_field(obj, conversion) format_spec, auto_arg_index = Colorizer._parse_with_formatting( format_spec, args, kwargs, recursion_depth=recursion_depth - 1, auto_arg_index=auto_arg_index, recursive=True, ) formatted = formatter.format_field(obj, format_spec) parser.feed(formatted, raw=True) tokens = parser.done() if recursive: return AnsiParser.strip(tokens), auto_arg_index return tokens @staticmethod def _parse_without_formatting(string, *, recursion_depth=2, recursive=False): if recursion_depth < 0: raise ValueError("Max string recursion exceeded") formatter = Formatter() parser = AnsiParser() messages_color_tokens = [] for literal_text, field_name, format_spec, conversion in formatter.parse(string): if literal_text and literal_text[-1] in "{}": literal_text += literal_text[-1] parser.feed(literal_text, raw=recursive) if field_name is not None: if field_name == "message": if recursive: messages_color_tokens.append(None) else: color_tokens = parser.current_color_tokens() messages_color_tokens.append(color_tokens) field = "{%s" % field_name if conversion: field += "!%s" % conversion if format_spec: field += ":%s" % format_spec field += "}" parser.feed(field, raw=True) _, color_tokens = Colorizer._parse_without_formatting( format_spec, recursion_depth=recursion_depth - 1, recursive=True ) messages_color_tokens.extend(color_tokens) return parser.done(), messages_color_tokens	14.58 KB	2025-05-25 12:26
📄 _contextvars.py import sys def load_contextvar_class(): if sys.version_info >= (3, 7): from contextvars import ContextVar elif sys.version_info >= (3, 5, 3): from aiocontextvars import ContextVar else: from contextvars import ContextVar return ContextVar ContextVar = load_contextvar_class()	321 B	2025-05-25 12:26
📄 _ctime_functions.py import os def load_ctime_functions(): if os.name == "nt": import win32_setctime def get_ctime_windows(filepath): return os.stat(filepath).st_ctime def set_ctime_windows(filepath, timestamp): if not win32_setctime.SUPPORTED: return try: win32_setctime.setctime(filepath, timestamp) except (OSError, ValueError): pass return get_ctime_windows, set_ctime_windows if hasattr(os.stat_result, "st_birthtime"): def get_ctime_macos(filepath): return os.stat(filepath).st_birthtime def set_ctime_macos(filepath, timestamp): pass return get_ctime_macos, set_ctime_macos if hasattr(os, "getxattr") and hasattr(os, "setxattr"): def get_ctime_linux(filepath): try: return float(os.getxattr(filepath, b"user.loguru_crtime")) except OSError: return os.stat(filepath).st_mtime def set_ctime_linux(filepath, timestamp): try: os.setxattr(filepath, b"user.loguru_crtime", str(timestamp).encode("ascii")) except OSError: pass return get_ctime_linux, set_ctime_linux def get_ctime_fallback(filepath): return os.stat(filepath).st_mtime def set_ctime_fallback(filepath, timestamp): pass return get_ctime_fallback, set_ctime_fallback get_ctime, set_ctime = load_ctime_functions()	1.49 KB	2025-05-25 12:26
📄 _datetime.py import re from calendar import day_abbr, day_name, month_abbr, month_name from datetime import datetime as datetime_ from datetime import timedelta, timezone from functools import lru_cache, partial from time import localtime, strftime tokens = r"H{1,2}\|h{1,2}\|m{1,2}\|s{1,2}\|S+\|YYYY\|YY\|M{1,4}\|D{1,4}\|Z{1,2}\|zz\|A\|X\|x\|E\|Q\|dddd\|ddd\|d" pattern = re.compile(r"(?:{0})\|\[(?:{0}\|!UTC\|)\]".format(tokens)) def _builtin_datetime_formatter(is_utc, format_string, dt): if is_utc: dt = dt.astimezone(timezone.utc) return dt.strftime(format_string) def _loguru_datetime_formatter(is_utc, format_string, formatters, dt): if is_utc: dt = dt.astimezone(timezone.utc) t = dt.timetuple() args = tuple(f(t, dt) for f in formatters) return format_string % args def _default_datetime_formatter(dt): return "%04d-%02d-%02d %02d:%02d:%02d.%03d" % ( dt.year, dt.month, dt.day, dt.hour, dt.minute, dt.second, dt.microsecond // 1000, ) def _format_timezone(tzinfo, , sep): offset = tzinfo.utcoffset(None).total_seconds() sign = "+" if offset >= 0 else "-" (h, m), s = divmod(abs(offset // 60), 60), abs(offset) % 60 z = "%s%02d%s%02d" % (sign, h, sep, m) if s > 0: if s.is_integer(): z += "%s%02d" % (sep, s) else: z += "%s%09.06f" % (sep, s) return z @lru_cache(maxsize=32) def _compile_format(spec): if spec == "YYYY-MM-DD HH:mm:ss.SSS": return _default_datetime_formatter is_utc = spec.endswith("!UTC") if is_utc: spec = spec[:-4] if not spec: spec = "%Y-%m-%dT%H:%M:%S.%f%z" if "%" in spec: return partial(_builtin_datetime_formatter, is_utc, spec) if "SSSSSSS" in spec: raise ValueError( "Invalid time format: the provided format string contains more than six successive " "'S' characters. This may be due to an attempt to use nanosecond precision, which " "is not supported." ) rep = { "YYYY": ("%04d", lambda t, dt: t.tm_year), "YY": ("%02d", lambda t, dt: t.tm_year % 100), "Q": ("%d", lambda t, dt: (t.tm_mon - 1) // 3 + 1), "MMMM": ("%s", lambda t, dt: month_name[t.tm_mon]), "MMM": ("%s", lambda t, dt: month_abbr[t.tm_mon]), "MM": ("%02d", lambda t, dt: t.tm_mon), "M": ("%d", lambda t, dt: t.tm_mon), "DDDD": ("%03d", lambda t, dt: t.tm_yday), "DDD": ("%d", lambda t, dt: t.tm_yday), "DD": ("%02d", lambda t, dt: t.tm_mday), "D": ("%d", lambda t, dt: t.tm_mday), "dddd": ("%s", lambda t, dt: day_name[t.tm_wday]), "ddd": ("%s", lambda t, dt: day_abbr[t.tm_wday]), "d": ("%d", lambda t, dt: t.tm_wday), "E": ("%d", lambda t, dt: t.tm_wday + 1), "HH": ("%02d", lambda t, dt: t.tm_hour), "H": ("%d", lambda t, dt: t.tm_hour), "hh": ("%02d", lambda t, dt: (t.tm_hour - 1) % 12 + 1), "h": ("%d", lambda t, dt: (t.tm_hour - 1) % 12 + 1), "mm": ("%02d", lambda t, dt: t.tm_min), "m": ("%d", lambda t, dt: t.tm_min), "ss": ("%02d", lambda t, dt: t.tm_sec), "s": ("%d", lambda t, dt: t.tm_sec), "S": ("%d", lambda t, dt: dt.microsecond // 100000), "SS": ("%02d", lambda t, dt: dt.microsecond // 10000), "SSS": ("%03d", lambda t, dt: dt.microsecond // 1000), "SSSS": ("%04d", lambda t, dt: dt.microsecond // 100), "SSSSS": ("%05d", lambda t, dt: dt.microsecond // 10), "SSSSSS": ("%06d", lambda t, dt: dt.microsecond), "A": ("%s", lambda t, dt: "AM" if t.tm_hour < 12 else "PM"), "Z": ("%s", lambda t, dt: _format_timezone(dt.tzinfo or timezone.utc, sep=":")), "ZZ": ("%s", lambda t, dt: _format_timezone(dt.tzinfo or timezone.utc, sep="")), "zz": ("%s", lambda t, dt: (dt.tzinfo or timezone.utc).tzname(dt) or ""), "X": ("%d", lambda t, dt: dt.timestamp()), "x": ("%d", lambda t, dt: int(dt.timestamp() 1000000 + dt.microsecond)), } format_string = "" formatters = [] pos = 0 for match in pattern.finditer(spec): start, end = match.span() format_string += spec[pos:start] pos = end token = match.group(0) try: specifier, formatter = rep[token] except KeyError: format_string += token[1:-1] else: format_string += specifier formatters.append(formatter) format_string += spec[pos:] return partial(_loguru_datetime_formatter, is_utc, format_string, formatters) class datetime(datetime_): # noqa: N801 def __format__(self, fmt): return _compile_format(fmt)(self) def aware_now(): now = datetime_.now() timestamp = now.timestamp() local = localtime(timestamp) try: seconds = local.tm_gmtoff zone = local.tm_zone except AttributeError: # Workaround for Python 3.5. utc_naive = datetime_.fromtimestamp(timestamp, tz=timezone.utc).replace(tzinfo=None) offset = datetime_.fromtimestamp(timestamp) - utc_naive seconds = offset.total_seconds() zone = strftime("%Z") tzinfo = timezone(timedelta(seconds=seconds), zone) return datetime.combine(now.date(), now.time().replace(tzinfo=tzinfo))	5.25 KB	2025-05-25 12:26
📄 _defaults.py from os import environ def env(key, type_, default=None): if key not in environ: return default val = environ[key] if type_ is str: return val if type_ is bool: if val.lower() in ["1", "true", "yes", "y", "ok", "on"]: return True if val.lower() in ["0", "false", "no", "n", "nok", "off"]: return False raise ValueError( "Invalid environment variable '%s' (expected a boolean): '%s'" % (key, val) ) if type_ is int: try: return int(val) except ValueError: raise ValueError( "Invalid environment variable '%s' (expected an integer): '%s'" % (key, val) ) from None raise ValueError("The requested type '%s' is not supported" % type_.__name__) LOGURU_AUTOINIT = env("LOGURU_AUTOINIT", bool, True) LOGURU_FORMAT = env( "LOGURU_FORMAT", str, "<green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green> \| " "<level>{level: <8}</level> \| " "<cyan>{name}</cyan>:<cyan>{function}</cyan>:<cyan>{line}</cyan> - <level>{message}</level>", ) LOGURU_FILTER = env("LOGURU_FILTER", str, None) LOGURU_LEVEL = env("LOGURU_LEVEL", str, "DEBUG") LOGURU_COLORIZE = env("LOGURU_COLORIZE", bool, None) LOGURU_SERIALIZE = env("LOGURU_SERIALIZE", bool, False) LOGURU_BACKTRACE = env("LOGURU_BACKTRACE", bool, True) LOGURU_DIAGNOSE = env("LOGURU_DIAGNOSE", bool, True) LOGURU_ENQUEUE = env("LOGURU_ENQUEUE", bool, False) LOGURU_CONTEXT = env("LOGURU_CONTEXT", str, None) LOGURU_CATCH = env("LOGURU_CATCH", bool, True) LOGURU_TRACE_NO = env("LOGURU_TRACE_NO", int, 5) LOGURU_TRACE_COLOR = env("LOGURU_TRACE_COLOR", str, "<cyan><bold>") LOGURU_TRACE_ICON = env("LOGURU_TRACE_ICON", str, "\u270F\uFE0F") # Pencil LOGURU_DEBUG_NO = env("LOGURU_DEBUG_NO", int, 10) LOGURU_DEBUG_COLOR = env("LOGURU_DEBUG_COLOR", str, "<blue><bold>") LOGURU_DEBUG_ICON = env("LOGURU_DEBUG_ICON", str, "\U0001F41E") # Lady Beetle LOGURU_INFO_NO = env("LOGURU_INFO_NO", int, 20) LOGURU_INFO_COLOR = env("LOGURU_INFO_COLOR", str, "<bold>") LOGURU_INFO_ICON = env("LOGURU_INFO_ICON", str, "\u2139\uFE0F") # Information LOGURU_SUCCESS_NO = env("LOGURU_SUCCESS_NO", int, 25) LOGURU_SUCCESS_COLOR = env("LOGURU_SUCCESS_COLOR", str, "<green><bold>") LOGURU_SUCCESS_ICON = env("LOGURU_SUCCESS_ICON", str, "\u2705") # White Heavy Check Mark LOGURU_WARNING_NO = env("LOGURU_WARNING_NO", int, 30) LOGURU_WARNING_COLOR = env("LOGURU_WARNING_COLOR", str, "<yellow><bold>") LOGURU_WARNING_ICON = env("LOGURU_WARNING_ICON", str, "\u26A0\uFE0F") # Warning LOGURU_ERROR_NO = env("LOGURU_ERROR_NO", int, 40) LOGURU_ERROR_COLOR = env("LOGURU_ERROR_COLOR", str, "<red><bold>") LOGURU_ERROR_ICON = env("LOGURU_ERROR_ICON", str, "\u274C") # Cross Mark LOGURU_CRITICAL_NO = env("LOGURU_CRITICAL_NO", int, 50) LOGURU_CRITICAL_COLOR = env("LOGURU_CRITICAL_COLOR", str, "<RED><bold>") LOGURU_CRITICAL_ICON = env("LOGURU_CRITICAL_ICON", str, "\u2620\uFE0F") # Skull and Crossbones	2.94 KB	2025-05-25 12:26
📄 _error_interceptor.py import sys import traceback class ErrorInterceptor: def __init__(self, should_catch, handler_id): self._should_catch = should_catch self._handler_id = handler_id def should_catch(self): return self._should_catch def print(self, record=None, *, exception=None): if not sys.stderr: return if exception is None: type_, value, traceback_ = sys.exc_info() else: type_, value, traceback_ = (type(exception), exception, exception.__traceback__) try: sys.stderr.write("--- Logging error in Loguru Handler #%d ---\n" % self._handler_id) try: record_repr = str(record) except Exception: record_repr = "/!\\ Unprintable record /!\\" sys.stderr.write("Record was: %s\n" % record_repr) traceback.print_exception(type_, value, traceback_, None, sys.stderr) sys.stderr.write("--- End of logging error ---\n") except OSError: pass finally: del type_, value, traceback_	1.08 KB	2025-05-25 12:26
📄 _file_sink.py import datetime import decimal import glob import numbers import os import shutil import string from functools import partial from stat import ST_DEV, ST_INO from . import _string_parsers as string_parsers from ._ctime_functions import get_ctime, set_ctime from ._datetime import aware_now def generate_rename_path(root, ext, creation_time): creation_datetime = datetime.datetime.fromtimestamp(creation_time) date = FileDateFormatter(creation_datetime) renamed_path = "{}.{}{}".format(root, date, ext) counter = 1 while os.path.exists(renamed_path): counter += 1 renamed_path = "{}.{}.{}{}".format(root, date, counter, ext) return renamed_path class FileDateFormatter: def __init__(self, datetime=None): self.datetime = datetime or aware_now() def __format__(self, spec): if not spec: spec = "%Y-%m-%d_%H-%M-%S_%f" return self.datetime.__format__(spec) class Compression: @staticmethod def add_compress(path_in, path_out, opener, kwargs): with opener(path_out, kwargs) as f_comp: f_comp.add(path_in, os.path.basename(path_in)) @staticmethod def write_compress(path_in, path_out, opener, kwargs): with opener(path_out, kwargs) as f_comp: f_comp.write(path_in, os.path.basename(path_in)) @staticmethod def copy_compress(path_in, path_out, opener, kwargs): with open(path_in, "rb") as f_in: with opener(path_out, kwargs) as f_out: shutil.copyfileobj(f_in, f_out) @staticmethod def compression(path_in, ext, compress_function): path_out = "{}{}".format(path_in, ext) if os.path.exists(path_out): creation_time = get_ctime(path_out) root, ext_before = os.path.splitext(path_in) renamed_path = generate_rename_path(root, ext_before + ext, creation_time) os.rename(path_out, renamed_path) compress_function(path_in, path_out) os.remove(path_in) class Retention: @staticmethod def retention_count(logs, number): def key_log(log): return (-os.stat(log).st_mtime, log) for log in sorted(logs, key=key_log)[number:]: os.remove(log) @staticmethod def retention_age(logs, seconds): t = datetime.datetime.now().timestamp() for log in logs: if os.stat(log).st_mtime <= t - seconds: os.remove(log) class Rotation: @staticmethod def forward_day(t): return t + datetime.timedelta(days=1) @staticmethod def forward_weekday(t, weekday): while True: t += datetime.timedelta(days=1) if t.weekday() == weekday: return t @staticmethod def forward_interval(t, interval): return t + interval @staticmethod def rotation_size(message, file, size_limit): file.seek(0, 2) return file.tell() + len(message) > size_limit class RotationTime: def __init__(self, step_forward, time_init=None): self._step_forward = step_forward self._time_init = time_init self._limit = None def __call__(self, message, file): record_time = message.record["time"] if self._limit is None: filepath = os.path.realpath(file.name) creation_time = get_ctime(filepath) set_ctime(filepath, creation_time) start_time = datetime.datetime.fromtimestamp( creation_time, tz=datetime.timezone.utc ) time_init = self._time_init if time_init is None: limit = start_time.astimezone(record_time.tzinfo).replace(tzinfo=None) limit = self._step_forward(limit) else: tzinfo = record_time.tzinfo if time_init.tzinfo is None else time_init.tzinfo limit = start_time.astimezone(tzinfo).replace( hour=time_init.hour, minute=time_init.minute, second=time_init.second, microsecond=time_init.microsecond, ) if limit <= start_time: limit = self._step_forward(limit) if time_init.tzinfo is None: limit = limit.replace(tzinfo=None) self._limit = limit if self._limit.tzinfo is None: record_time = record_time.replace(tzinfo=None) if record_time >= self._limit: while self._limit <= record_time: self._limit = self._step_forward(self._limit) return True return False class FileSink: def __init__( self, path, , rotation=None, retention=None, compression=None, delay=False, watch=False, mode="a", buffering=1, encoding="utf8", kwargs ): self.encoding = encoding self._kwargs = {kwargs, "mode": mode, "buffering": buffering, "encoding": self.encoding} self._path = str(path) self._glob_patterns = self._make_glob_patterns(self._path) self._rotation_function = self._make_rotation_function(rotation) self._retention_function = self._make_retention_function(retention) self._compression_function = self._make_compression_function(compression) self._file = None self._file_path = None self._watch = watch self._file_dev = -1 self._file_ino = -1 if not delay: path = self._create_path() self._create_dirs(path) self._create_file(path) def write(self, message): if self._file is None: path = self._create_path() self._create_dirs(path) self._create_file(path) if self._watch: self._reopen_if_needed() if self._rotation_function is not None and self._rotation_function(message, self._file): self._terminate_file(is_rotating=True) self._file.write(message) def stop(self): if self._watch: self._reopen_if_needed() self._terminate_file(is_rotating=False) def tasks_to_complete(self): return [] def _create_path(self): path = self._path.format_map({"time": FileDateFormatter()}) return os.path.abspath(path) def _create_dirs(self, path): dirname = os.path.dirname(path) os.makedirs(dirname, exist_ok=True) def _create_file(self, path): self._file = open(path, self._kwargs) self._file_path = path if self._watch: fileno = self._file.fileno() result = os.fstat(fileno) self._file_dev = result[ST_DEV] self._file_ino = result[ST_INO] def _close_file(self): self._file.flush() self._file.close() self._file = None self._file_path = None self._file_dev = -1 self._file_ino = -1 def _reopen_if_needed(self): # Implemented based on standard library: # https://github.com/python/cpython/blob/cb589d1b/Lib/logging/handlers.py#L486 if not self._file: return filepath = self._file_path try: result = os.stat(filepath) except FileNotFoundError: result = None if not result or result[ST_DEV] != self._file_dev or result[ST_INO] != self._file_ino: self._close_file() self._create_dirs(filepath) self._create_file(filepath) def _terminate_file(self, , is_rotating=False): old_path = self._file_path if self._file is not None: self._close_file() if is_rotating: new_path = self._create_path() self._create_dirs(new_path) if new_path == old_path: creation_time = get_ctime(old_path) root, ext = os.path.splitext(old_path) renamed_path = generate_rename_path(root, ext, creation_time) os.rename(old_path, renamed_path) old_path = renamed_path if is_rotating or self._rotation_function is None: if self._compression_function is not None and old_path is not None: self._compression_function(old_path) if self._retention_function is not None: logs = { file for pattern in self._glob_patterns for file in glob.glob(pattern) if os.path.isfile(file) } self._retention_function(list(logs)) if is_rotating: self._create_file(new_path) set_ctime(new_path, datetime.datetime.now().timestamp()) @staticmethod def _make_glob_patterns(path): formatter = string.Formatter() tokens = formatter.parse(path) escaped = "".join(glob.escape(text) + "" (name is not None) for text, name, _ in tokens) root, ext = os.path.splitext(escaped) if not ext: return [escaped, escaped + "."] return [escaped, escaped + ".", root + "." + ext, root + "." + ext + "."] @staticmethod def _make_rotation_function(rotation): if rotation is None: return None if isinstance(rotation, str): size = string_parsers.parse_size(rotation) if size is not None: return FileSink._make_rotation_function(size) interval = string_parsers.parse_duration(rotation) if interval is not None: return FileSink._make_rotation_function(interval) frequency = string_parsers.parse_frequency(rotation) if frequency is not None: return Rotation.RotationTime(frequency) daytime = string_parsers.parse_daytime(rotation) if daytime is not None: day, time = daytime if day is None: return FileSink._make_rotation_function(time) if time is None: time = datetime.time(0, 0, 0) step_forward = partial(Rotation.forward_weekday, weekday=day) return Rotation.RotationTime(step_forward, time) raise ValueError("Cannot parse rotation from: '%s'" % rotation) if isinstance(rotation, (numbers.Real, decimal.Decimal)): return partial(Rotation.rotation_size, size_limit=rotation) if isinstance(rotation, datetime.time): return Rotation.RotationTime(Rotation.forward_day, rotation) if isinstance(rotation, datetime.timedelta): step_forward = partial(Rotation.forward_interval, interval=rotation) return Rotation.RotationTime(step_forward) if callable(rotation): return rotation raise TypeError("Cannot infer rotation for objects of type: '%s'" % type(rotation).__name__) @staticmethod def _make_retention_function(retention): if retention is None: return None if isinstance(retention, str): interval = string_parsers.parse_duration(retention) if interval is None: raise ValueError("Cannot parse retention from: '%s'" % retention) return FileSink._make_retention_function(interval) if isinstance(retention, int): return partial(Retention.retention_count, number=retention) if isinstance(retention, datetime.timedelta): return partial(Retention.retention_age, seconds=retention.total_seconds()) if callable(retention): return retention raise TypeError( "Cannot infer retention for objects of type: '%s'" % type(retention).__name__ ) @staticmethod def _make_compression_function(compression): if compression is None: return None if isinstance(compression, str): ext = compression.strip().lstrip(".") if ext == "gz": import gzip compress = partial(Compression.copy_compress, opener=gzip.open, mode="wb") elif ext == "bz2": import bz2 compress = partial(Compression.copy_compress, opener=bz2.open, mode="wb") elif ext == "xz": import lzma compress = partial( Compression.copy_compress, opener=lzma.open, mode="wb", format=lzma.FORMAT_XZ ) elif ext == "lzma": import lzma compress = partial( Compression.copy_compress, opener=lzma.open, mode="wb", format=lzma.FORMAT_ALONE ) elif ext == "tar": import tarfile compress = partial(Compression.add_compress, opener=tarfile.open, mode="w:") elif ext == "tar.gz": import gzip import tarfile compress = partial(Compression.add_compress, opener=tarfile.open, mode="w:gz") elif ext == "tar.bz2": import bz2 import tarfile compress = partial(Compression.add_compress, opener=tarfile.open, mode="w:bz2") elif ext == "tar.xz": import lzma import tarfile compress = partial(Compression.add_compress, opener=tarfile.open, mode="w:xz") elif ext == "zip": import zipfile compress = partial( Compression.write_compress, opener=zipfile.ZipFile, mode="w", compression=zipfile.ZIP_DEFLATED, ) else: raise ValueError("Invalid compression format: '%s'" % ext) return partial(Compression.compression, ext="." + ext, compress_function=compress) if callable(compression): return compression raise TypeError( "Cannot infer compression for objects of type: '%s'" % type(compression).__name__ )	14.07 KB	2025-05-25 12:26
📄 _filters.py def filter_none(record): return record["name"] is not None def filter_by_name(record, parent, length): name = record["name"] if name is None: return False return (name + ".")[:length] == parent def filter_by_level(record, level_per_module): name = record["name"] while True: level = level_per_module.get(name, None) if level is False: return False if level is not None: return record["level"].no >= level if not name: return True index = name.rfind(".") name = name[:index] if index != -1 else ""	618 B	2025-05-25 12:26
📄 _get_frame.py import sys from sys import exc_info def get_frame_fallback(n): try: raise Exception except Exception: frame = exc_info()[2].tb_frame.f_back for _ in range(n): frame = frame.f_back return frame def load_get_frame_function(): if hasattr(sys, "_getframe"): get_frame = sys._getframe else: get_frame = get_frame_fallback return get_frame get_frame = load_get_frame_function()	458 B	2025-05-25 12:26
📄 _handler.py import functools import json import multiprocessing import os import threading from contextlib import contextmanager from threading import Thread from ._colorizer import Colorizer from ._locks_machinery import create_handler_lock def prepare_colored_format(format_, ansi_level): colored = Colorizer.prepare_format(format_) return colored, colored.colorize(ansi_level) def prepare_stripped_format(format_): colored = Colorizer.prepare_format(format_) return colored.strip() def memoize(function): return functools.lru_cache(maxsize=64)(function) class Message(str): __slots__ = ("record",) class Handler: def __init__( self, *, sink, name, levelno, formatter, is_formatter_dynamic, filter_, colorize, serialize, enqueue, multiprocessing_context, error_interceptor, exception_formatter, id_, levels_ansi_codes ): self._name = name self._sink = sink self._levelno = levelno self._formatter = formatter self._is_formatter_dynamic = is_formatter_dynamic self._filter = filter_ self._colorize = colorize self._serialize = serialize self._enqueue = enqueue self._multiprocessing_context = multiprocessing_context self._error_interceptor = error_interceptor self._exception_formatter = exception_formatter self._id = id_ self._levels_ansi_codes = levels_ansi_codes # Warning, reference shared among handlers self._decolorized_format = None self._precolorized_formats = {} self._memoize_dynamic_format = None self._stopped = False self._lock = create_handler_lock() self._lock_acquired = threading.local() self._queue = None self._queue_lock = None self._confirmation_event = None self._confirmation_lock = None self._owner_process_pid = None self._thread = None if self._is_formatter_dynamic: if self._colorize: self._memoize_dynamic_format = memoize(prepare_colored_format) else: self._memoize_dynamic_format = memoize(prepare_stripped_format) else: if self._colorize: for level_name in self._levels_ansi_codes: self.update_format(level_name) else: self._decolorized_format = self._formatter.strip() if self._enqueue: if self._multiprocessing_context is None: self._queue = multiprocessing.SimpleQueue() self._confirmation_event = multiprocessing.Event() self._confirmation_lock = multiprocessing.Lock() else: self._queue = self._multiprocessing_context.SimpleQueue() self._confirmation_event = self._multiprocessing_context.Event() self._confirmation_lock = self._multiprocessing_context.Lock() self._queue_lock = create_handler_lock() self._owner_process_pid = os.getpid() self._thread = Thread( target=self._queued_writer, daemon=True, name="loguru-writer-%d" % self._id ) self._thread.start() def __repr__(self): return "(id=%d, level=%d, sink=%s)" % (self._id, self._levelno, self._name) @contextmanager def _protected_lock(self): """Acquire the lock, but fail fast if its already acquired by the current thread.""" if getattr(self._lock_acquired, "acquired", False): raise RuntimeError( "Could not acquire internal lock because it was already in use (deadlock avoided). " "This likely happened because the logger was re-used inside a sink, a signal " "handler or a '__del__' method. This is not permitted because the logger and its " "handlers are not re-entrant." ) self._lock_acquired.acquired = True try: with self._lock: yield finally: self._lock_acquired.acquired = False def emit(self, record, level_id, from_decorator, is_raw, colored_message): try: if self._levelno > record["level"].no: return if self._filter is not None: if not self._filter(record): return if self._is_formatter_dynamic: dynamic_format = self._formatter(record) formatter_record = record.copy() if not record["exception"]: formatter_record["exception"] = "" else: type_, value, tb = record["exception"] formatter = self._exception_formatter lines = formatter.format_exception(type_, value, tb, from_decorator=from_decorator) formatter_record["exception"] = "".join(lines) if colored_message is not None and colored_message.stripped != record["message"]: colored_message = None if is_raw: if colored_message is None or not self._colorize: formatted = record["message"] else: ansi_level = self._levels_ansi_codes[level_id] formatted = colored_message.colorize(ansi_level) elif self._is_formatter_dynamic: if not self._colorize: precomputed_format = self._memoize_dynamic_format(dynamic_format) formatted = precomputed_format.format_map(formatter_record) elif colored_message is None: ansi_level = self._levels_ansi_codes[level_id] _, precomputed_format = self._memoize_dynamic_format(dynamic_format, ansi_level) formatted = precomputed_format.format_map(formatter_record) else: ansi_level = self._levels_ansi_codes[level_id] formatter, precomputed_format = self._memoize_dynamic_format( dynamic_format, ansi_level ) coloring_message = formatter.make_coloring_message( record["message"], ansi_level=ansi_level, colored_message=colored_message ) formatter_record["message"] = coloring_message formatted = precomputed_format.format_map(formatter_record) else: if not self._colorize: precomputed_format = self._decolorized_format formatted = precomputed_format.format_map(formatter_record) elif colored_message is None: ansi_level = self._levels_ansi_codes[level_id] precomputed_format = self._precolorized_formats[level_id] formatted = precomputed_format.format_map(formatter_record) else: ansi_level = self._levels_ansi_codes[level_id] precomputed_format = self._precolorized_formats[level_id] coloring_message = self._formatter.make_coloring_message( record["message"], ansi_level=ansi_level, colored_message=colored_message ) formatter_record["message"] = coloring_message formatted = precomputed_format.format_map(formatter_record) if self._serialize: formatted = self._serialize_record(formatted, record) str_record = Message(formatted) str_record.record = record with self._protected_lock(): if self._stopped: return if self._enqueue: self._queue.put(str_record) else: self._sink.write(str_record) except Exception: if not self._error_interceptor.should_catch(): raise self._error_interceptor.print(record) def stop(self): with self._protected_lock(): self._stopped = True if self._enqueue: if self._owner_process_pid != os.getpid(): return self._queue.put(None) self._thread.join() if hasattr(self._queue, "close"): self._queue.close() self._sink.stop() def complete_queue(self): if not self._enqueue: return with self._confirmation_lock: self._queue.put(True) self._confirmation_event.wait() self._confirmation_event.clear() def tasks_to_complete(self): if self._enqueue and self._owner_process_pid != os.getpid(): return [] lock = self._queue_lock if self._enqueue else self._protected_lock() with lock: return self._sink.tasks_to_complete() def update_format(self, level_id): if not self._colorize or self._is_formatter_dynamic: return ansi_code = self._levels_ansi_codes[level_id] self._precolorized_formats[level_id] = self._formatter.colorize(ansi_code) @property def levelno(self): return self._levelno @staticmethod def _serialize_record(text, record): exception = record["exception"] if exception is not None: exception = { "type": None if exception.type is None else exception.type.__name__, "value": exception.value, "traceback": bool(exception.traceback), } serializable = { "text": text, "record": { "elapsed": { "repr": record["elapsed"], "seconds": record["elapsed"].total_seconds(), }, "exception": exception, "extra": record["extra"], "file": {"name": record["file"].name, "path": record["file"].path}, "function": record["function"], "level": { "icon": record["level"].icon, "name": record["level"].name, "no": record["level"].no, }, "line": record["line"], "message": record["message"], "module": record["module"], "name": record["name"], "process": {"id": record["process"].id, "name": record["process"].name}, "thread": {"id": record["thread"].id, "name": record["thread"].name}, "time": {"repr": record["time"], "timestamp": record["time"].timestamp()}, }, } return json.dumps(serializable, default=str, ensure_ascii=False) + "\n" def _queued_writer(self): message = None queue = self._queue # We need to use a lock to protect sink during fork. # Particularly, writing to stderr may lead to deadlock in child process. lock = self._queue_lock while True: try: message = queue.get() except Exception: with lock: self._error_interceptor.print(None) continue if message is None: break if message is True: self._confirmation_event.set() continue with lock: try: self._sink.write(message) except Exception: self._error_interceptor.print(message.record) def __getstate__(self): state = self.__dict__.copy() state["_lock"] = None state["_lock_acquired"] = None state["_memoize_dynamic_format"] = None if self._enqueue: state["_sink"] = None state["_thread"] = None state["_owner_process"] = None state["_queue_lock"] = None return state def __setstate__(self, state): self.__dict__.update(state) self._lock = create_handler_lock() self._lock_acquired = threading.local() if self._enqueue: self._queue_lock = create_handler_lock() if self._is_formatter_dynamic: if self._colorize: self._memoize_dynamic_format = memoize(prepare_colored_format) else: self._memoize_dynamic_format = memoize(prepare_stripped_format)	12.34 KB	2025-05-25 12:26
📄 _locks_machinery.py import os import threading import weakref if not hasattr(os, "register_at_fork"): def create_logger_lock(): return threading.Lock() def create_handler_lock(): return threading.Lock() else: # While forking, we need to sanitize all locks to make sure the child process doesn't run into # a deadlock (if a lock already acquired is inherited) and to protect sink from corrupted state. # It's very important to acquire logger locks before handlers one to prevent possible deadlock # while 'remove()' is called for example. logger_locks = weakref.WeakSet() handler_locks = weakref.WeakSet() def acquire_locks(): for lock in logger_locks: lock.acquire() for lock in handler_locks: lock.acquire() def release_locks(): for lock in logger_locks: lock.release() for lock in handler_locks: lock.release() os.register_at_fork( before=acquire_locks, after_in_parent=release_locks, after_in_child=release_locks, ) def create_logger_lock(): lock = threading.Lock() logger_locks.add(lock) return lock def create_handler_lock(): lock = threading.Lock() handler_locks.add(lock) return lock	1.28 KB	2025-05-25 12:26
📄 _logger.py """Core logging functionalities of the `Loguru` library. .. References and links rendered by Sphinx are kept here as "module documentation" so that they can be used in the ``Logger`` docstrings but do not pollute ``help(logger)`` output. .. \|Logger\| replace:: :class:`~Logger` .. \|add\| replace:: :meth:`~Logger.add()` .. \|remove\| replace:: :meth:`~Logger.remove()` .. \|complete\| replace:: :meth:`~Logger.complete()` .. \|catch\| replace:: :meth:`~Logger.catch()` .. \|bind\| replace:: :meth:`~Logger.bind()` .. \|contextualize\| replace:: :meth:`~Logger.contextualize()` .. \|patch\| replace:: :meth:`~Logger.patch()` .. \|opt\| replace:: :meth:`~Logger.opt()` .. \|log\| replace:: :meth:`~Logger.log()` .. \|level\| replace:: :meth:`~Logger.level()` .. \|enable\| replace:: :meth:`~Logger.enable()` .. \|disable\| replace:: :meth:`~Logger.disable()` .. \|Any\| replace:: :obj:`~typing.Any` .. \|str\| replace:: :class:`str` .. \|int\| replace:: :class:`int` .. \|bool\| replace:: :class:`bool` .. \|tuple\| replace:: :class:`tuple` .. \|namedtuple\| replace:: :func:`namedtuple<collections.namedtuple>` .. \|list\| replace:: :class:`list` .. \|dict\| replace:: :class:`dict` .. \|str.format\| replace:: :meth:`str.format()` .. \|Path\| replace:: :class:`pathlib.Path` .. \|match.groupdict\| replace:: :meth:`re.Match.groupdict()` .. \|Handler\| replace:: :class:`logging.Handler` .. \|sys.stderr\| replace:: :data:`sys.stderr` .. \|sys.exc_info\| replace:: :func:`sys.exc_info()` .. \|time\| replace:: :class:`datetime.time` .. \|datetime\| replace:: :class:`datetime.datetime` .. \|timedelta\| replace:: :class:`datetime.timedelta` .. \|open\| replace:: :func:`open()` .. \|logging\| replace:: :mod:`logging` .. \|signal\| replace:: :mod:`signal` .. \|contextvars\| replace:: :mod:`contextvars` .. \|multiprocessing\| replace:: :mod:`multiprocessing` .. \|Thread.run\| replace:: :meth:`Thread.run()<threading.Thread.run()>` .. \|Exception\| replace:: :class:`Exception` .. \|AbstractEventLoop\| replace:: :class:`AbstractEventLoop<asyncio.AbstractEventLoop>` .. \|asyncio.get_running_loop\| replace:: :func:`asyncio.get_running_loop()` .. \|asyncio.run\| replace:: :func:`asyncio.run()` .. \|loop.run_until_complete\| replace:: :meth:`loop.run_until_complete()<asyncio.loop.run_until_complete()>` .. \|loop.create_task\| replace:: :meth:`loop.create_task()<asyncio.loop.create_task()>` .. \|logger.trace\| replace:: :meth:`logger.trace()<Logger.trace()>` .. \|logger.debug\| replace:: :meth:`logger.debug()<Logger.debug()>` .. \|logger.info\| replace:: :meth:`logger.info()<Logger.info()>` .. \|logger.success\| replace:: :meth:`logger.success()<Logger.success()>` .. \|logger.warning\| replace:: :meth:`logger.warning()<Logger.warning()>` .. \|logger.error\| replace:: :meth:`logger.error()<Logger.error()>` .. \|logger.critical\| replace:: :meth:`logger.critical()<Logger.critical()>` .. \|file-like object\| replace:: ``file-like object`` .. _file-like object: https://docs.python.org/3/glossary.html#term-file-object .. \|callable\| replace:: ``callable`` .. _callable: https://docs.python.org/3/library/functions.html#callable .. \|coroutine function\| replace:: ``coroutine function`` .. _coroutine function: https://docs.python.org/3/glossary.html#term-coroutine-function .. \|re.Pattern\| replace:: ``re.Pattern`` .. _re.Pattern: https://docs.python.org/3/library/re.html#re-objects .. \|multiprocessing.Context\| replace:: ``multiprocessing.Context`` .. _multiprocessing.Context: https://docs.python.org/3/library/multiprocessing.html#contexts-and-start-methods .. \|better_exceptions\| replace:: ``better_exceptions`` .. _better_exceptions: https://github.com/Qix-/better-exceptions .. \|loguru-config\| replace:: ``loguru-config`` .. _loguru-config: https://github.com/erezinman/loguru-config .. _Pendulum: https://pendulum.eustace.io/docs/#tokens .. _@Qix-: https://github.com/Qix- .. _@erezinman: https://github.com/erezinman .. _@sdispater: https://github.com/sdispater .. _formatting directives: https://docs.python.org/3/library/string.html#format-string-syntax .. _reentrant: https://en.wikipedia.org/wiki/Reentrancy_(computing) """ import builtins import contextlib import functools import logging import re import sys import threading import warnings from collections import namedtuple from inspect import isclass, iscoroutinefunction, isgeneratorfunction from multiprocessing import current_process, get_context from multiprocessing.context import BaseContext from os.path import basename, splitext from threading import current_thread from . import _asyncio_loop, _colorama, _defaults, _filters from ._better_exceptions import ExceptionFormatter from ._colorizer import Colorizer from ._contextvars import ContextVar from ._datetime import aware_now from ._error_interceptor import ErrorInterceptor from ._file_sink import FileSink from ._get_frame import get_frame from ._handler import Handler from ._locks_machinery import create_logger_lock from ._recattrs import RecordException, RecordFile, RecordLevel, RecordProcess, RecordThread from ._simple_sinks import AsyncSink, CallableSink, StandardSink, StreamSink if sys.version_info >= (3, 6): from os import PathLike else: from pathlib import PurePath as PathLike Level = namedtuple("Level", ["name", "no", "color", "icon"]) # noqa: PYI024 start_time = aware_now() context = ContextVar("loguru_context", default={}) class Core: def __init__(self): levels = [ Level( "TRACE", _defaults.LOGURU_TRACE_NO, _defaults.LOGURU_TRACE_COLOR, _defaults.LOGURU_TRACE_ICON, ), Level( "DEBUG", _defaults.LOGURU_DEBUG_NO, _defaults.LOGURU_DEBUG_COLOR, _defaults.LOGURU_DEBUG_ICON, ), Level( "INFO", _defaults.LOGURU_INFO_NO, _defaults.LOGURU_INFO_COLOR, _defaults.LOGURU_INFO_ICON, ), Level( "SUCCESS", _defaults.LOGURU_SUCCESS_NO, _defaults.LOGURU_SUCCESS_COLOR, _defaults.LOGURU_SUCCESS_ICON, ), Level( "WARNING", _defaults.LOGURU_WARNING_NO, _defaults.LOGURU_WARNING_COLOR, _defaults.LOGURU_WARNING_ICON, ), Level( "ERROR", _defaults.LOGURU_ERROR_NO, _defaults.LOGURU_ERROR_COLOR, _defaults.LOGURU_ERROR_ICON, ), Level( "CRITICAL", _defaults.LOGURU_CRITICAL_NO, _defaults.LOGURU_CRITICAL_COLOR, _defaults.LOGURU_CRITICAL_ICON, ), ] self.levels = {level.name: level for level in levels} self.levels_ansi_codes = { *{name: Colorizer.ansify(level.color) for name, level in self.levels.items()}, None: "", } # Cache used internally to quickly access level attributes based on their name or severity. # It can also contain integers as keys, it serves to avoid calling "isinstance()" repeatedly # when "logger.log()" is used. self.levels_lookup = { name: (name, name, level.no, level.icon) for name, level in self.levels.items() } self.handlers_count = 0 self.handlers = {} self.extra = {} self.patcher = None self.min_level = float("inf") self.enabled = {} self.activation_list = [] self.activation_none = True self.thread_locals = threading.local() self.lock = create_logger_lock() def __getstate__(self): state = self.__dict__.copy() state["thread_locals"] = None state["lock"] = None return state def __setstate__(self, state): self.__dict__.update(state) self.thread_locals = threading.local() self.lock = create_logger_lock() class Logger: """An object to dispatch logging messages to configured handlers. The \|Logger\| is the core object of ``loguru``, every logging configuration and usage pass through a call to one of its methods. There is only one logger, so there is no need to retrieve one before usage. Once the ``logger`` is imported, it can be used to write messages about events happening in your code. By reading the output logs of your application, you gain a better understanding of the flow of your program and you more easily track and debug unexpected behaviors. Handlers to which the logger sends log messages are added using the \|add\| method. Note that you can use the \|Logger\| right after import as it comes pre-configured (logs are emitted to \|sys.stderr\| by default). Messages can be logged with different severity levels and they can be formatted using curly braces (it uses \|str.format\| under the hood). When a message is logged, a "record" is associated with it. This record is a dict which contains information about the logging context: time, function, file, line, thread, level... It also contains the ``__name__`` of the module, this is why you don't need named loggers. You should not instantiate a \|Logger\| by yourself, use ``from loguru import logger`` instead. """ def __init__(self, core, exception, depth, record, lazy, colors, raw, capture, patchers, extra): self._core = core self._options = (exception, depth, record, lazy, colors, raw, capture, patchers, extra) def __repr__(self): return "<loguru.logger handlers=%r>" % list(self._core.handlers.values()) def add( self, sink, , level=_defaults.LOGURU_LEVEL, format=_defaults.LOGURU_FORMAT, filter=_defaults.LOGURU_FILTER, colorize=_defaults.LOGURU_COLORIZE, serialize=_defaults.LOGURU_SERIALIZE, backtrace=_defaults.LOGURU_BACKTRACE, diagnose=_defaults.LOGURU_DIAGNOSE, enqueue=_defaults.LOGURU_ENQUEUE, context=_defaults.LOGURU_CONTEXT, catch=_defaults.LOGURU_CATCH, kwargs ): r"""Add a handler sending log messages to a sink adequately configured. Parameters ---------- sink : \|file-like object\|_, \|str\|, \|Path\|, \|callable\|_, \|coroutine function\|_ or \|Handler\| An object in charge of receiving formatted logging messages and propagating them to an appropriate endpoint. level : \|int\| or \|str\|, optional The minimum severity level from which logged messages should be sent to the sink. format : \|str\| or \|callable\|_, optional The template used to format logged messages before being sent to the sink. filter : \|callable\|_, \|str\| or \|dict\|, optional A directive optionally used to decide for each logged message whether it should be sent to the sink or not. colorize : \|bool\|, optional Whether the color markups contained in the formatted message should be converted to ansi codes for terminal coloration, or stripped otherwise. If ``None``, the choice is automatically made based on the sink being a tty or not. serialize : \|bool\|, optional Whether the logged message and its records should be first converted to a JSON string before being sent to the sink. backtrace : \|bool\|, optional Whether the exception trace formatted should be extended upward, beyond the catching point, to show the full stacktrace which generated the error. diagnose : \|bool\|, optional Whether the exception trace should display the variables values to eases the debugging. This should be set to ``False`` in production to avoid leaking sensitive data. enqueue : \|bool\|, optional Whether the messages to be logged should first pass through a multiprocessing-safe queue before reaching the sink. This is useful while logging to a file through multiple processes. This also has the advantage of making logging calls non-blocking. context : \|multiprocessing.Context\| or \|str\|, optional A context object or name that will be used for all tasks involving internally the \|multiprocessing\| module, in particular when ``enqueue=True``. If ``None``, the default context is used. catch : \|bool\|, optional Whether errors occurring while sink handles logs messages should be automatically caught. If ``True``, an exception message is displayed on \|sys.stderr\| but the exception is not propagated to the caller, preventing your app to crash. kwargs Additional parameters that are only valid to configure a coroutine or file sink (see below). If and only if the sink is a coroutine function, the following parameter applies: Parameters ---------- loop : \|AbstractEventLoop\|, optional The event loop in which the asynchronous logging task will be scheduled and executed. If ``None``, the loop used is the one returned by \|asyncio.get_running_loop\| at the time of the logging call (task is discarded if there is no loop currently running). If and only if the sink is a file path, the following parameters apply: Parameters ---------- rotation : \|str\|, \|int\|, \|time\|, \|timedelta\| or \|callable\|_, optional A condition indicating whenever the current logged file should be closed and a new one started. retention : \|str\|, \|int\|, \|timedelta\| or \|callable\|_, optional A directive filtering old files that should be removed during rotation or end of program. compression : \|str\| or \|callable\|_, optional A compression or archive format to which log files should be converted at closure. delay : \|bool\|, optional Whether the file should be created as soon as the sink is configured, or delayed until first logged message. It defaults to ``False``. watch : \|bool\|, optional Whether or not the file should be watched and re-opened when deleted or changed (based on its device and inode properties) by an external program. It defaults to ``False``. mode : \|str\|, optional The opening mode as for built-in \|open\| function. It defaults to ``"a"`` (open the file in appending mode). buffering : \|int\|, optional The buffering policy as for built-in \|open\| function. It defaults to ``1`` (line buffered file). encoding : \|str\|, optional The file encoding as for built-in \|open\| function. It defaults to ``"utf8"``. *kwargs Others parameters are passed to the built-in \|open\| function. Returns ------- :class:`int` An identifier associated with the added sink and which should be used to \|remove\| it. Raises ------ ValueError If any of the arguments passed to configure the sink is invalid. Notes ----- Extended summary follows. .. _sink: .. rubric:: The sink parameter The ``sink`` handles incoming log messages and proceed to their writing somewhere and somehow. A sink can take many forms: - A \|file-like object\|_ like ``sys.stderr`` or ``open("file.log", "w")``. Anything with a ``.write()`` method is considered as a file-like object. Custom handlers may also implement ``flush()`` (called after each logged message), ``stop()`` (called at sink termination) and ``complete()`` (awaited by the eponymous method). - A file path as \|str\| or \|Path\|. It can be parametrized with some additional parameters, see below. - A \|callable\|_ (such as a simple function) like ``lambda msg: print(msg)``. This allows for logging procedure entirely defined by user preferences and needs. - A asynchronous \|coroutine function\|_ defined with the ``async def`` statement. The coroutine object returned by such function will be added to the event loop using \|loop.create_task\|. The tasks should be awaited before ending the loop by using \|complete\|. - A built-in \|Handler\| like ``logging.StreamHandler``. In such a case, the `Loguru` records are automatically converted to the structure expected by the \|logging\| module. Note that the logging functions are not `reentrant`_. This means you should avoid using the ``logger`` inside any of your sinks or from within \|signal\| handlers. Otherwise, you may face deadlock if the module's sink was not explicitly disabled. .. _message: .. rubric:: The logged message The logged message passed to all added sinks is nothing more than a string of the formatted log, to which a special attribute is associated: the ``.record`` which is a dict containing all contextual information possibly needed (see below). Logged messages are formatted according to the ``format`` of the added sink. This format is usually a string containing braces fields to display attributes from the record dict. If fine-grained control is needed, the ``format`` can also be a function which takes the record as parameter and return the format template string. However, note that in such a case, you should take care of appending the line ending and exception field to the returned format, while ``"\n{exception}"`` is automatically appended for convenience if ``format`` is a string. The ``filter`` attribute can be used to control which messages are effectively passed to the sink and which one are ignored. A function can be used, accepting the record as an argument, and returning ``True`` if the message should be logged, ``False`` otherwise. If a string is used, only the records with the same ``name`` and its children will be allowed. One can also pass a ``dict`` mapping module names to minimum required level. In such case, each log record will search for it's closest parent in the ``dict`` and use the associated level as the filter. The ``dict`` values can be ``int`` severity, ``str`` level name or ``True`` and ``False`` to respectively authorize and discard all module logs unconditionally. In order to set a default level, the ``""`` module name should be used as it is the parent of all modules (it does not suppress global ``level`` threshold, though). Note that while calling a logging method, the keyword arguments (if any) are automatically added to the ``extra`` dict for convenient contextualization (in addition to being used for formatting). .. _levels: .. rubric:: The severity levels Each logged message is associated with a severity level. These levels make it possible to prioritize messages and to choose the verbosity of the logs according to usages. For example, it allows to display some debugging information to a developer, while hiding it to the end user running the application. The ``level`` attribute of every added sink controls the minimum threshold from which log messages are allowed to be emitted. While using the ``logger``, you are in charge of configuring the appropriate granularity of your logs. It is possible to add even more custom levels by using the \|level\| method. Here are the standard levels with their default severity value, each one is associated with a logging method of the same name: +----------------------+------------------------+------------------------+ \| Level name \| Severity value \| Logger method \| +======================+========================+========================+ \| ``TRACE`` \| 5 \| \|logger.trace\| \| +----------------------+------------------------+------------------------+ \| ``DEBUG`` \| 10 \| \|logger.debug\| \| +----------------------+------------------------+------------------------+ \| ``INFO`` \| 20 \| \|logger.info\| \| +----------------------+------------------------+------------------------+ \| ``SUCCESS`` \| 25 \| \|logger.success\| \| +----------------------+------------------------+------------------------+ \| ``WARNING`` \| 30 \| \|logger.warning\| \| +----------------------+------------------------+------------------------+ \| ``ERROR`` \| 40 \| \|logger.error\| \| +----------------------+------------------------+------------------------+ \| ``CRITICAL`` \| 50 \| \|logger.critical\| \| +----------------------+------------------------+------------------------+ .. _record: .. rubric:: The record dict The record is just a Python dict, accessible from sinks by ``message.record``. It contains all contextual information of the logging call (time, function, file, line, level, etc.). Each of the record keys can be used in the handler's ``format`` so the corresponding value is properly displayed in the logged message (e.g. ``"{level}"`` will return ``"INFO"``). Some records' values are objects with two or more attributes. These can be formatted with ``"{key.attr}"`` (``"{key}"`` would display one by default). Note that you can use any `formatting directives`_ available in Python's ``str.format()`` method (e.g. ``"{key: >3}"`` will right-align and pad to a width of 3 characters). This is particularly useful for time formatting (see below). +------------+---------------------------------+----------------------------+ \| Key \| Description \| Attributes \| +============+=================================+============================+ \| elapsed \| The time elapsed since the \| See \|timedelta\| \| \| \| start of the program \| \| +------------+---------------------------------+----------------------------+ \| exception \| The formatted exception if any, \| ``type``, ``value``, \| \| \| ``None`` otherwise \| ``traceback`` \| +------------+---------------------------------+----------------------------+ \| extra \| The dict of attributes \| None \| \| \| bound by the user (see \|bind\|) \| \| +------------+---------------------------------+----------------------------+ \| file \| The file where the logging call \| ``name`` (default), \| \| \| was made \| ``path`` \| +------------+---------------------------------+----------------------------+ \| function \| The function from which the \| None \| \| \| logging call was made \| \| +------------+---------------------------------+----------------------------+ \| level \| The severity used to log the \| ``name`` (default), \| \| \| message \| ``no``, ``icon`` \| +------------+---------------------------------+----------------------------+ \| line \| The line number in the source \| None \| \| \| code \| \| +------------+---------------------------------+----------------------------+ \| message \| The logged message (not yet \| None \| \| \| formatted) \| \| +------------+---------------------------------+----------------------------+ \| module \| The module where the logging \| None \| \| \| call was made \| \| +------------+---------------------------------+----------------------------+ \| name \| The ``__name__`` where the \| None \| \| \| logging call was made \| \| +------------+---------------------------------+----------------------------+ \| process \| The process in which the \| ``name``, ``id`` (default) \| \| \| logging call was made \| \| +------------+---------------------------------+----------------------------+ \| thread \| The thread in which the \| ``name``, ``id`` (default) \| \| \| logging call was made \| \| +------------+---------------------------------+----------------------------+ \| time \| The aware local time when the \| See \|datetime\| \| \| \| logging call was made \| \| +------------+---------------------------------+----------------------------+ .. _time: .. rubric:: The time formatting To use your favorite time representation, you can set it directly in the time formatter specifier of your handler format, like for example ``format="{time:HH:mm:ss} {message}"``. Note that this datetime represents your local time, and it is also made timezone-aware, so you can display the UTC offset to avoid ambiguities. The time field can be formatted using more human-friendly tokens. These constitute a subset of the one used by the `Pendulum`_ library of `@sdispater`_. To escape a token, just add square brackets around it, for example ``"[YY]"`` would display literally ``"YY"``. If you prefer to display UTC rather than local time, you can add ``"!UTC"`` at the very end of the time format, like ``{time:HH:mm:ss!UTC}``. Doing so will convert the ``datetime`` to UTC before formatting. If no time formatter specifier is used, like for example if ``format="{time} {message}"``, the default one will use ISO 8601. +------------------------+---------+----------------------------------------+ \| \| Token \| Output \| +========================+=========+========================================+ \| Year \| YYYY \| 2000, 2001, 2002 ... 2012, 2013 \| \| +---------+----------------------------------------+ \| \| YY \| 00, 01, 02 ... 12, 13 \| +------------------------+---------+----------------------------------------+ \| Quarter \| Q \| 1 2 3 4 \| +------------------------+---------+----------------------------------------+ \| Month \| MMMM \| January, February, March ... \| \| +---------+----------------------------------------+ \| \| MMM \| Jan, Feb, Mar ... \| \| +---------+----------------------------------------+ \| \| MM \| 01, 02, 03 ... 11, 12 \| \| +---------+----------------------------------------+ \| \| M \| 1, 2, 3 ... 11, 12 \| +------------------------+---------+----------------------------------------+ \| Day of Year \| DDDD \| 001, 002, 003 ... 364, 365 \| \| +---------+----------------------------------------+ \| \| DDD \| 1, 2, 3 ... 364, 365 \| +------------------------+---------+----------------------------------------+ \| Day of Month \| DD \| 01, 02, 03 ... 30, 31 \| \| +---------+----------------------------------------+ \| \| D \| 1, 2, 3 ... 30, 31 \| +------------------------+---------+----------------------------------------+ \| Day of Week \| dddd \| Monday, Tuesday, Wednesday ... \| \| +---------+----------------------------------------+ \| \| ddd \| Mon, Tue, Wed ... \| \| +---------+----------------------------------------+ \| \| d \| 0, 1, 2 ... 6 \| +------------------------+---------+----------------------------------------+ \| Days of ISO Week \| E \| 1, 2, 3 ... 7 \| +------------------------+---------+----------------------------------------+ \| Hour \| HH \| 00, 01, 02 ... 23, 24 \| \| +---------+----------------------------------------+ \| \| H \| 0, 1, 2 ... 23, 24 \| \| +---------+----------------------------------------+ \| \| hh \| 01, 02, 03 ... 11, 12 \| \| +---------+----------------------------------------+ \| \| h \| 1, 2, 3 ... 11, 12 \| +------------------------+---------+----------------------------------------+ \| Minute \| mm \| 00, 01, 02 ... 58, 59 \| \| +---------+----------------------------------------+ \| \| m \| 0, 1, 2 ... 58, 59 \| +------------------------+---------+----------------------------------------+ \| Second \| ss \| 00, 01, 02 ... 58, 59 \| \| +---------+----------------------------------------+ \| \| s \| 0, 1, 2 ... 58, 59 \| +------------------------+---------+----------------------------------------+ \| Fractional Second \| S \| 0 1 ... 8 9 \| \| +---------+----------------------------------------+ \| \| SS \| 00, 01, 02 ... 98, 99 \| \| +---------+----------------------------------------+ \| \| SSS \| 000 001 ... 998 999 \| \| +---------+----------------------------------------+ \| \| SSSS... \| 000[0..] 001[0..] ... 998[0..] 999[0..]\| \| +---------+----------------------------------------+ \| \| SSSSSS \| 000000 000001 ... 999998 999999 \| +------------------------+---------+----------------------------------------+ \| AM / PM \| A \| AM, PM \| +------------------------+---------+----------------------------------------+ \| Timezone \| Z \| -07:00, -06:00 ... +06:00, +07:00 \| \| +---------+----------------------------------------+ \| \| ZZ \| -0700, -0600 ... +0600, +0700 \| \| +---------+----------------------------------------+ \| \| zz \| EST CST ... MST PST \| +------------------------+---------+----------------------------------------+ \| Seconds timestamp \| X \| 1381685817, 1234567890.123 \| +------------------------+---------+----------------------------------------+ \| Microseconds timestamp \| x \| 1234567890123 \| +------------------------+---------+----------------------------------------+ .. _file: .. rubric:: The file sinks If the sink is a \|str\| or a \|Path\|, the corresponding file will be opened for writing logs. The path can also contain a special ``"{time}"`` field that will be formatted with the current date at file creation. The file is closed at sink stop, i.e. when the application ends or the handler is removed. The ``rotation`` check is made before logging each message. If there is already an existing file with the same name that the file to be created, then the existing file is renamed by appending the date to its basename to prevent file overwriting. This parameter accepts: - an \|int\| which corresponds to the maximum file size in bytes before that the current logged file is closed and a new one started over. - a \|timedelta\| which indicates the frequency of each new rotation. - a \|time\| which specifies the hour when the daily rotation should occur. - a \|str\| for human-friendly parametrization of one of the previously enumerated types. Examples: ``"100 MB"``, ``"0.5 GB"``, ``"1 month 2 weeks"``, ``"4 days"``, ``"10h"``, ``"monthly"``, ``"18:00"``, ``"sunday"``, ``"w0"``, ``"monday at 12:00"``, ... - a \|callable\|_ which will be invoked before logging. It should accept two arguments: the logged message and the file object, and it should return ``True`` if the rotation should happen now, ``False`` otherwise. The ``retention`` occurs at rotation or at sink stop if rotation is ``None``. Files resulting from previous sessions or rotations are automatically collected from disk. A file is selected if it matches the pattern ``"basename(.).ext(.)"`` (possible time fields are beforehand replaced with ``.``) based on the configured sink. Afterwards, the list is processed to determine files to be retained. This parameter accepts: - an \|int\| which indicates the number of log files to keep, while older files are deleted. - a \|timedelta\| which specifies the maximum age of files to keep. - a \|str\| for human-friendly parametrization of the maximum age of files to keep. Examples: ``"1 week, 3 days"``, ``"2 months"``, ... - a \|callable\|_ which will be invoked before the retention process. It should accept the list of log files as argument and process to whatever it wants (moving files, removing them, etc.). The ``compression`` happens at rotation or at sink stop if rotation is ``None``. This parameter accepts: - a \|str\| which corresponds to the compressed or archived file extension. This can be one of: ``"gz"``, ``"bz2"``, ``"xz"``, ``"lzma"``, ``"tar"``, ``"tar.gz"``, ``"tar.bz2"``, ``"tar.xz"``, ``"zip"``. - a \|callable\|_ which will be invoked before file termination. It should accept the path of the log file as argument and process to whatever it wants (custom compression, network sending, removing it, etc.). Either way, if you use a custom function designed according to your preferences, you must be very careful not to use the ``logger`` within your function. Otherwise, there is a risk that your program hang because of a deadlock. .. _color: .. rubric:: The color markups To add colors to your logs, you just have to enclose your format string with the appropriate tags (e.g. ``<red>some message</red>``). These tags are automatically removed if the sink doesn't support ansi codes. For convenience, you can use ``</>`` to close the last opening tag without repeating its name (e.g. ``<red>another message</>``). The special tag ``<level>`` (abbreviated with ``<lvl>``) is transformed according to the configured color of the logged message level. Tags which are not recognized will raise an exception during parsing, to inform you about possible misuse. If you wish to display a markup tag literally, you can escape it by prepending a ``\`` like for example ``\<blue>``. To prevent the escaping to occur, you can simply double the ``\`` (e.g. ``\\<blue>`` will print a literal ``\`` before colored text). If, for some reason, you need to escape a string programmatically, note that the regex used internally to parse markup tags is ``r"(\\)(</?(?:[fb]g\s)?[^<>\s]>)"``. Note that when logging a message with ``opt(colors=True)``, color tags present in the formatting arguments (``args`` and ``kwargs``) are completely ignored. This is important if you need to log strings containing markups that might interfere with the color tags (in this case, do not use f-string). Here are the available tags (note that compatibility may vary depending on terminal): +------------------------------------+--------------------------------------+ \| Color (abbr) \| Styles (abbr) \| +====================================+======================================+ \| Black (k) \| Bold (b) \| +------------------------------------+--------------------------------------+ \| Blue (e) \| Dim (d) \| +------------------------------------+--------------------------------------+ \| Cyan (c) \| Normal (n) \| +------------------------------------+--------------------------------------+ \| Green (g) \| Italic (i) \| +------------------------------------+--------------------------------------+ \| Magenta (m) \| Underline (u) \| +------------------------------------+--------------------------------------+ \| Red (r) \| Strike (s) \| +------------------------------------+--------------------------------------+ \| White (w) \| Reverse (v) \| +------------------------------------+--------------------------------------+ \| Yellow (y) \| Blink (l) \| +------------------------------------+--------------------------------------+ \| \| Hide (h) \| +------------------------------------+--------------------------------------+ Usage: +-----------------+-------------------------------------------------------------------+ \| Description \| Examples \| \| +---------------------------------+---------------------------------+ \| \| Foreground \| Background \| +=================+=================================+=================================+ \| Basic colors \| ``<red>``, ``<r>`` \| ``<GREEN>``, ``<G>`` \| +-----------------+---------------------------------+---------------------------------+ \| Light colors \| ``<light-blue>``, ``<le>`` \| ``<LIGHT-CYAN>``, ``<LC>`` \| +-----------------+---------------------------------+---------------------------------+ \| 8-bit colors \| ``<fg 86>``, ``<fg 255>`` \| ``<bg 42>``, ``<bg 9>`` \| +-----------------+---------------------------------+---------------------------------+ \| Hex colors \| ``<fg #00005f>``, ``<fg #EE1>`` \| ``<bg #AF5FD7>``, ``<bg #fff>`` \| +-----------------+---------------------------------+---------------------------------+ \| RGB colors \| ``<fg 0,95,0>`` \| ``<bg 72,119,65>`` \| +-----------------+---------------------------------+---------------------------------+ \| Stylizing \| ``<bold>``, ``<b>``, ``<underline>``, ``<u>`` \| +-----------------+-------------------------------------------------------------------+ .. _env: .. rubric:: The environment variables The default values of sink parameters can be entirely customized. This is particularly useful if you don't like the log format of the pre-configured sink. Each of the \|add\| default parameter can be modified by setting the ``LOGURU_[PARAM]`` environment variable. For example on Linux: ``export LOGURU_FORMAT="{time} - {message}"`` or ``export LOGURU_DIAGNOSE=NO``. The default levels' attributes can also be modified by setting the ``LOGURU_[LEVEL]_[ATTR]`` environment variable. For example, on Windows: ``setx LOGURU_DEBUG_COLOR "<blue>"`` or ``setx LOGURU_TRACE_ICON "🚀"``. If you use the ``set`` command, do not include quotes but escape special symbol as needed, e.g. ``set LOGURU_DEBUG_COLOR=^<blue^>``. If you want to disable the pre-configured sink, you can set the ``LOGURU_AUTOINIT`` variable to ``False``. On Linux, you will probably need to edit the ``~/.profile`` file to make this persistent. On Windows, don't forget to restart your terminal for the change to be taken into account. Examples -------- >>> logger.add(sys.stdout, format="{time} - {level} - {message}", filter="sub.module") >>> logger.add("file_{time}.log", level="TRACE", rotation="100 MB") >>> def debug_only(record): ... return record["level"].name == "DEBUG" ... >>> logger.add("debug.log", filter=debug_only) # Other levels are filtered out >>> def my_sink(message): ... record = message.record ... update_db(message, time=record["time"], level=record["level"]) ... >>> logger.add(my_sink) >>> level_per_module = { ... "": "DEBUG", ... "third.lib": "WARNING", ... "anotherlib": False ... } >>> logger.add(lambda m: print(m, end=""), filter=level_per_module, level=0) >>> async def publish(message): ... await api.post(message) ... >>> logger.add(publish, serialize=True) >>> from logging import StreamHandler >>> logger.add(StreamHandler(sys.stderr), format="{message}") >>> class RandomStream: ... def __init__(self, seed, threshold): ... self.threshold = threshold ... random.seed(seed) ... def write(self, message): ... if random.random() > self.threshold: ... print(message) ... >>> stream_object = RandomStream(seed=12345, threshold=0.25) >>> logger.add(stream_object, level="INFO") """ with self._core.lock: handler_id = self._core.handlers_count self._core.handlers_count += 1 error_interceptor = ErrorInterceptor(catch, handler_id) if colorize is None and serialize: colorize = False if isinstance(sink, (str, PathLike)): path = sink name = "'%s'" % path if colorize is None: colorize = False wrapped_sink = FileSink(path, *kwargs) kwargs = {} encoding = wrapped_sink.encoding terminator = "\n" exception_prefix = "" elif hasattr(sink, "write") and callable(sink.write): name = getattr(sink, "name", None) or repr(sink) if colorize is None: colorize = _colorama.should_colorize(sink) if colorize is True and _colorama.should_wrap(sink): stream = _colorama.wrap(sink) else: stream = sink wrapped_sink = StreamSink(stream) encoding = getattr(sink, "encoding", None) terminator = "\n" exception_prefix = "" elif isinstance(sink, logging.Handler): name = repr(sink) if colorize is None: colorize = False wrapped_sink = StandardSink(sink) encoding = getattr(sink, "encoding", None) terminator = "" exception_prefix = "\n" elif iscoroutinefunction(sink) or iscoroutinefunction( getattr(sink, "__call__", None) # noqa: B004 ): name = getattr(sink, "__name__", None) or repr(sink) if colorize is None: colorize = False loop = kwargs.pop("loop", None) # The worker thread needs an event loop, it can't create a new one internally because it # has to be accessible by the user while calling "complete()", instead we use the global # one when the sink is added. If "enqueue=False" the event loop is dynamically retrieved # at each logging call, which is much more convenient. However, coroutine can't access # running loop in Python 3.5.2 and earlier versions, see python/asyncio#452. if enqueue and loop is None: try: loop = _asyncio_loop.get_running_loop() except RuntimeError as e: raise ValueError( "An event loop is required to add a coroutine sink with `enqueue=True`, " "but none has been passed as argument and none is currently running." ) from e coro = sink if iscoroutinefunction(sink) else sink.__call__ wrapped_sink = AsyncSink(coro, loop, error_interceptor) encoding = "utf8" terminator = "\n" exception_prefix = "" elif callable(sink): name = getattr(sink, "__name__", None) or repr(sink) if colorize is None: colorize = False wrapped_sink = CallableSink(sink) encoding = "utf8" terminator = "\n" exception_prefix = "" else: raise TypeError("Cannot log to objects of type '%s'" % type(sink).__name__) if kwargs: raise TypeError("add() got an unexpected keyword argument '%s'" % next(iter(kwargs))) if filter is None: filter_func = None elif filter == "": filter_func = _filters.filter_none elif isinstance(filter, str): parent = filter + "." length = len(parent) filter_func = functools.partial(_filters.filter_by_name, parent=parent, length=length) elif isinstance(filter, dict): level_per_module = {} for module, level_ in filter.items(): if module is not None and not isinstance(module, str): raise TypeError( "The filter dict contains an invalid module, " "it should be a string (or None), not: '%s'" % type(module).__name__ ) if level_ is False: levelno_ = False elif level_ is True: levelno_ = 0 elif isinstance(level_, str): try: levelno_ = self.level(level_).no except ValueError: raise ValueError( "The filter dict contains a module '%s' associated to a level name " "which does not exist: '%s'" % (module, level_) ) from None elif isinstance(level_, int): levelno_ = level_ else: raise TypeError( "The filter dict contains a module '%s' associated to an invalid level, " "it should be an integer, a string or a boolean, not: '%s'" % (module, type(level_).__name__) ) if levelno_ < 0: raise ValueError( "The filter dict contains a module '%s' associated to an invalid level, " "it should be a positive integer, not: '%d'" % (module, levelno_) ) level_per_module[module] = levelno_ filter_func = functools.partial( _filters.filter_by_level, level_per_module=level_per_module ) elif callable(filter): if filter == builtins.filter: raise ValueError( "The built-in 'filter()' function cannot be used as a 'filter' parameter, " "this is most likely a mistake (please double-check the arguments passed " "to 'logger.add()')." ) filter_func = filter else: raise TypeError( "Invalid filter, it should be a function, a string or a dict, not: '%s'" % type(filter).__name__ ) if isinstance(level, str): levelno = self.level(level).no elif isinstance(level, int): levelno = level else: raise TypeError( "Invalid level, it should be an integer or a string, not: '%s'" % type(level).__name__ ) if levelno < 0: raise ValueError( "Invalid level value, it should be a positive integer, not: %d" % levelno ) if isinstance(format, str): try: formatter = Colorizer.prepare_format(format + terminator + "{exception}") except ValueError as e: raise ValueError( "Invalid format, color markups could not be parsed correctly" ) from e is_formatter_dynamic = False elif callable(format): if format == builtins.format: raise ValueError( "The built-in 'format()' function cannot be used as a 'format' parameter, " "this is most likely a mistake (please double-check the arguments passed " "to 'logger.add()')." ) formatter = format is_formatter_dynamic = True else: raise TypeError( "Invalid format, it should be a string or a function, not: '%s'" % type(format).__name__ ) if not isinstance(encoding, str): encoding = "ascii" if isinstance(context, str): context = get_context(context) elif context is not None and not isinstance(context, BaseContext): raise TypeError( "Invalid context, it should be a string or a multiprocessing context, " "not: '%s'" % type(context).__name__ ) with self._core.lock: exception_formatter = ExceptionFormatter( colorize=colorize, encoding=encoding, diagnose=diagnose, backtrace=backtrace, hidden_frames_filename=self.catch.__code__.co_filename, prefix=exception_prefix, ) handler = Handler( name=name, sink=wrapped_sink, levelno=levelno, formatter=formatter, is_formatter_dynamic=is_formatter_dynamic, filter_=filter_func, colorize=colorize, serialize=serialize, enqueue=enqueue, multiprocessing_context=context, id_=handler_id, error_interceptor=error_interceptor, exception_formatter=exception_formatter, levels_ansi_codes=self._core.levels_ansi_codes, ) handlers = self._core.handlers.copy() handlers[handler_id] = handler self._core.min_level = min(self._core.min_level, levelno) self._core.handlers = handlers return handler_id def remove(self, handler_id=None): """Remove a previously added handler and stop sending logs to its sink. Parameters ---------- handler_id : \|int\| or ``None`` The id of the sink to remove, as it was returned by the \|add\| method. If ``None``, all handlers are removed. The pre-configured handler is guaranteed to have the index ``0``. Raises ------ ValueError If ``handler_id`` is not ``None`` but there is no active handler with such id. Examples -------- >>> i = logger.add(sys.stderr, format="{message}") >>> logger.info("Logging") Logging >>> logger.remove(i) >>> logger.info("No longer logging") """ if not (handler_id is None or isinstance(handler_id, int)): raise TypeError( "Invalid handler id, it should be an integer as returned " "by the 'add()' method (or None), not: '%s'" % type(handler_id).__name__ ) with self._core.lock: if handler_id is not None and handler_id not in self._core.handlers: raise ValueError("There is no existing handler with id %d" % handler_id) from None if handler_id is None: handler_ids = list(self._core.handlers) else: handler_ids = [handler_id] for handler_id in handler_ids: handlers = self._core.handlers.copy() handler = handlers.pop(handler_id) # This needs to be done first in case "stop()" raises an exception levelnos = (h.levelno for h in handlers.values()) self._core.min_level = min(levelnos, default=float("inf")) self._core.handlers = handlers handler.stop() def complete(self): """Wait for the end of enqueued messages and asynchronous tasks scheduled by handlers. This method proceeds in two steps: first it waits for all logging messages added to handlers with ``enqueue=True`` to be processed, then it returns an object that can be awaited to finalize all logging tasks added to the event loop by coroutine sinks. It can be called from non-asynchronous code. This is especially recommended when the ``logger`` is utilized with ``multiprocessing`` to ensure messages put to the internal queue have been properly transmitted before leaving a child process. The returned object should be awaited before the end of a coroutine executed by \|asyncio.run\| or \|loop.run_until_complete\| to ensure all asynchronous logging messages are processed. The function \|asyncio.get_running_loop\| is called beforehand, only tasks scheduled in the same loop that the current one will be awaited by the method. Returns ------- :term:`awaitable` An awaitable object which ensures all asynchronous logging calls are completed when awaited. Examples -------- >>> async def sink(message): ... await asyncio.sleep(0.1) # IO processing... ... print(message, end="") ... >>> async def work(): ... logger.info("Start") ... logger.info("End") ... await logger.complete() ... >>> logger.add(sink) 1 >>> asyncio.run(work()) Start End >>> def process(): ... logger.info("Message sent from the child") ... logger.complete() ... >>> logger.add(sys.stderr, enqueue=True) 1 >>> process = multiprocessing.Process(target=process) >>> process.start() >>> process.join() Message sent from the child """ tasks = [] with self._core.lock: handlers = self._core.handlers.copy() for handler in handlers.values(): handler.complete_queue() tasks.extend(handler.tasks_to_complete()) class AwaitableCompleter: def __await__(self): for task in tasks: yield from task.__await__() return AwaitableCompleter() def catch( self, exception=Exception, , level="ERROR", reraise=False, onerror=None, exclude=None, default=None, message="An error has been caught in function '{record[function]}', " "process '{record[process].name}' ({record[process].id}), " "thread '{record[thread].name}' ({record[thread].id}):" ): """Return a decorator to automatically log possibly caught error in wrapped function. This is useful to ensure unexpected exceptions are logged, the entire program can be wrapped by this method. This is also very useful to decorate \|Thread.run\| methods while using threads to propagate errors to the main logger thread. Note that the visibility of variables values (which uses the great \|better_exceptions\|_ library from `@Qix-`_) depends on the ``diagnose`` option of each configured sink. The returned object can also be used as a context manager. Parameters ---------- exception : \|Exception\|, optional The type of exception to intercept. If several types should be caught, a tuple of exceptions can be used too. level : \|str\| or \|int\|, optional The level name or severity with which the message should be logged. reraise : \|bool\|, optional Whether the exception should be raised again and hence propagated to the caller. onerror : \|callable\|_, optional A function that will be called if an error occurs, once the message has been logged. It should accept the exception instance as it sole argument. exclude : \|Exception\|, optional A type of exception (or a tuple of types) that will be purposely ignored and hence propagated to the caller without being logged. default : \|Any\|, optional The value to be returned by the decorated function if an error occurred without being re-raised. message : \|str\|, optional The message that will be automatically logged if an exception occurs. Note that it will be formatted with the ``record`` attribute. Returns ------- :term:`decorator` / :term:`context manager` An object that can be used to decorate a function or as a context manager to log exceptions possibly caught. Examples -------- >>> @logger.catch ... def f(x): ... 100 / x ... >>> def g(): ... f(10) ... f(0) ... >>> g() ERROR - An error has been caught in function 'g', process 'Main' (367), thread 'ch1' (1398): Traceback (most recent call last): File "program.py", line 12, in <module> g() └ <function g at 0x7f225fe2bc80> > File "program.py", line 10, in g f(0) └ <function f at 0x7f225fe2b9d8> File "program.py", line 6, in f 100 / x └ 0 ZeroDivisionError: division by zero >>> with logger.catch(message="Because we never know..."): ... main() # No exception, no logs >>> # Use 'onerror' to prevent the program exit code to be 0 (if 'reraise=False') while >>> # also avoiding the stacktrace to be duplicated on stderr (if 'reraise=True'). >>> @logger.catch(onerror=lambda _: sys.exit(1)) ... def main(): ... 1 / 0 """ if callable(exception) and ( not isclass(exception) or not issubclass(exception, BaseException) ): return self.catch()(exception) logger = self class Catcher: def __init__(self, from_decorator): self._from_decorator = from_decorator def __enter__(self): return None def __exit__(self, type_, value, traceback_): if type_ is None: return None # We must prevent infinite recursion in case "logger.catch()" handles an exception # that occurs while logging another exception. This can happen for example when # the exception formatter calls "repr(obj)" while the "__repr__" method is broken # but decorated with "logger.catch()". In such a case, we ignore the catching # mechanism and just let the exception be thrown (that way, the formatter will # rightly assume the object is unprintable). if getattr(logger._core.thread_locals, "already_logging_exception", False): return False if not issubclass(type_, exception): return False if exclude is not None and issubclass(type_, exclude): return False from_decorator = self._from_decorator _, depth, _, options = logger._options if from_decorator: depth += 1 catch_options = [(type_, value, traceback_), depth, True, options] logger._core.thread_locals.already_logging_exception = True try: logger._log(level, from_decorator, catch_options, message, (), {}) finally: logger._core.thread_locals.already_logging_exception = False if onerror is not None: onerror(value) return not reraise def __call__(self, function): if isclass(function): raise TypeError( "Invalid object decorated with 'catch()', it must be a function, " "not a class (tried to wrap '%s')" % function.__name__ ) catcher = Catcher(True) if iscoroutinefunction(function): async def catch_wrapper(args, kwargs): with catcher: return await function(args, *kwargs) return default elif isgeneratorfunction(function): def catch_wrapper(args, *kwargs): with catcher: return (yield from function(args, *kwargs)) return default else: def catch_wrapper(args, *kwargs): with catcher: return function(args, *kwargs) return default functools.update_wrapper(catch_wrapper, function) return catch_wrapper return Catcher(False) def opt( self, , exception=None, record=False, lazy=False, colors=False, raw=False, capture=True, depth=0, ansi=False ): r"""Parametrize a logging call to slightly change generated log message. Note that it's not possible to chain \|opt\| calls, the last one takes precedence over the others as it will "reset" the options to their default values. Parameters ---------- exception : \|bool\|, \|tuple\| or \|Exception\|, optional If it does not evaluate as ``False``, the passed exception is formatted and added to the log message. It could be an \|Exception\| object or a ``(type, value, traceback)`` tuple, otherwise the exception information is retrieved from \|sys.exc_info\|. record : \|bool\|, optional If ``True``, the record dict contextualizing the logging call can be used to format the message by using ``{record[key]}`` in the log message. lazy : \|bool\|, optional If ``True``, the logging call attribute to format the message should be functions which will be called only if the level is high enough. This can be used to avoid expensive functions if not necessary. colors : \|bool\|, optional If ``True``, logged message will be colorized according to the markups it possibly contains. raw : \|bool\|, optional If ``True``, the formatting of each sink will be bypassed and the message will be sent as is. capture : \|bool\|, optional If ``False``, the ``kwargs`` of logged message will not automatically populate the ``extra`` dict (although they are still used for formatting). depth : \|int\|, optional Specify which stacktrace should be used to contextualize the logged message. This is useful while using the logger from inside a wrapped function to retrieve worthwhile information. ansi : \|bool\|, optional Deprecated since version 0.4.1: the ``ansi`` parameter will be removed in Loguru 1.0.0, it is replaced by ``colors`` which is a more appropriate name. Returns ------- :class:`~Logger` A logger wrapping the core logger, but transforming logged message adequately before sending. Examples -------- >>> try: ... 1 / 0 ... except ZeroDivisionError: ... logger.opt(exception=True).debug("Exception logged with debug level:") ... [18:10:02] DEBUG in '<module>' - Exception logged with debug level: Traceback (most recent call last, catch point marked): > File "<stdin>", line 2, in <module> ZeroDivisionError: division by zero >>> logger.opt(record=True).info("Current line is: {record[line]}") [18:10:33] INFO in '<module>' - Current line is: 1 >>> logger.opt(lazy=True).debug("If sink <= DEBUG: {x}", x=lambda: math.factorial(25)) [18:11:19] DEBUG in '<module>' - If sink <= DEBUG: 263130836933693530167218012160000000 >>> logger.opt(colors=True).warning("We got a <red>BIG</red> problem") [18:11:30] WARNING in '<module>' - We got a BIG problem >>> logger.opt(raw=True).debug("No formatting\n") No formatting >>> logger.opt(capture=False).info("Displayed but not captured: {value}", value=123) [18:11:41] Displayed but not captured: 123 >>> def wrapped(): ... logger.opt(depth=1).info("Get parent context") ... >>> def func(): ... wrapped() ... >>> func() [18:11:54] DEBUG in 'func' - Get parent context """ if ansi: colors = True warnings.warn( "The 'ansi' parameter is deprecated, please use 'colors' instead", DeprecationWarning, stacklevel=2, ) args = self._options[-2:] return Logger(self._core, exception, depth, record, lazy, colors, raw, capture, args) def bind(__self, kwargs): # noqa: N805 """Bind attributes to the ``extra`` dict of each logged message record. This is used to add custom context to each logging call. Parameters ---------- kwargs Mapping between keys and values that will be added to the ``extra`` dict. Returns ------- :class:`~Logger` A logger wrapping the core logger, but which sends record with the customized ``extra`` dict. Examples -------- >>> logger.add(sys.stderr, format="{extra[ip]} - {message}") >>> class Server: ... def __init__(self, ip): ... self.ip = ip ... self.logger = logger.bind(ip=ip) ... def call(self, message): ... self.logger.info(message) ... >>> instance_1 = Server("192.168.0.200") >>> instance_2 = Server("127.0.0.1") >>> instance_1.call("First instance") 192.168.0.200 - First instance >>> instance_2.call("Second instance") 127.0.0.1 - Second instance """ options, extra = __self._options return Logger(__self._core, options, {extra, kwargs}) @contextlib.contextmanager def contextualize(__self, kwargs): # noqa: N805 """Bind attributes to the context-local ``extra`` dict while inside the ``with`` block. Contrary to \|bind\| there is no ``logger`` returned, the ``extra`` dict is modified in-place and updated globally. Most importantly, it uses \|contextvars\| which means that contextualized values are unique to each threads and asynchronous tasks. The ``extra`` dict will retrieve its initial state once the context manager is exited. Parameters ---------- kwargs Mapping between keys and values that will be added to the context-local ``extra`` dict. Returns ------- :term:`context manager` / :term:`decorator` A context manager (usable as a decorator too) that will bind the attributes once entered and restore the initial state of the ``extra`` dict while exited. Examples -------- >>> logger.add(sys.stderr, format="{message} \| {extra}") 1 >>> def task(): ... logger.info("Processing!") ... >>> with logger.contextualize(task_id=123): ... task() ... Processing! \| {'task_id': 123} >>> logger.info("Done.") Done. \| {} """ with __self._core.lock: new_context = {context.get(), kwargs} token = context.set(new_context) try: yield finally: with __self._core.lock: context.reset(token) def patch(self, patcher): """Attach a function to modify the record dict created by each logging call. The ``patcher`` may be used to update the record on-the-fly before it's propagated to the handlers. This allows the "extra" dict to be populated with dynamic values and also permits advanced modifications of the record emitted while logging a message. The function is called once before sending the log message to the different handlers. It is recommended to apply modification on the ``record["extra"]`` dict rather than on the ``record`` dict itself, as some values are used internally by `Loguru`, and modify them may produce unexpected results. The logger can be patched multiple times. In this case, the functions are called in the same order as they are added. Parameters ---------- patcher: \|callable\|_ The function to which the record dict will be passed as the sole argument. This function is in charge of updating the record in-place, the function does not need to return any value, the modified record object will be re-used. Returns ------- :class:`~Logger` A logger wrapping the core logger, but which records are passed through the ``patcher`` function before being sent to the added handlers. Examples -------- >>> logger.add(sys.stderr, format="{extra[utc]} {message}") >>> logger = logger.patch(lambda record: record["extra"].update(utc=datetime.utcnow()) >>> logger.info("That's way, you can log messages with time displayed in UTC") >>> def wrapper(func): ... @functools.wraps(func) ... def wrapped(args, *kwargs): ... logger.patch(lambda r: r.update(function=func.__name__)).info("Wrapped!") ... return func(args, *kwargs) ... return wrapped >>> def recv_record_from_network(pipe): ... record = pickle.loads(pipe.read()) ... level, message = record["level"], record["message"] ... logger.patch(lambda r: r.update(record)).log(level, message) """ options, patchers, extra = self._options return Logger(self._core, options, [patchers, patcher], extra) def level(self, name, no=None, color=None, icon=None): r"""Add, update or retrieve a logging level. Logging levels are defined by their ``name`` to which a severity ``no``, an ansi ``color`` tag and an ``icon`` are associated and possibly modified at run-time. To \|log\| to a custom level, you should necessarily use its name, the severity number is not linked back to levels name (this implies that several levels can share the same severity). To add a new level, its ``name`` and its ``no`` are required. A ``color`` and an ``icon`` can also be specified or will be empty by default. To update an existing level, pass its ``name`` with the parameters to be changed. It is not possible to modify the ``no`` of a level once it has been added. To retrieve level information, the ``name`` solely suffices. Parameters ---------- name : \|str\| The name of the logging level. no : \|int\| The severity of the level to be added or updated. color : \|str\| The color markup of the level to be added or updated. icon : \|str\| The icon of the level to be added or updated. Returns ------- ``Level`` A \|namedtuple\| containing information about the level. Raises ------ ValueError If attempting to access a level with a ``name`` that is not registered, or if trying to change the severity ``no`` of an existing level. Examples -------- >>> level = logger.level("ERROR") >>> print(level) Level(name='ERROR', no=40, color='<red><bold>', icon='❌') >>> logger.add(sys.stderr, format="{level.no} {level.icon} {message}") 1 >>> logger.level("CUSTOM", no=15, color="<blue>", icon="@") Level(name='CUSTOM', no=15, color='<blue>', icon='@') >>> logger.log("CUSTOM", "Logging...") 15 @ Logging... >>> logger.level("WARNING", icon=r"/!\\") Level(name='WARNING', no=30, color='<yellow><bold>', icon='/!\\\\') >>> logger.warning("Updated!") 30 /!\\ Updated! """ if not isinstance(name, str): raise TypeError( "Invalid level name, it should be a string, not: '%s'" % type(name).__name__ ) if no is color is icon is None: try: return self._core.levels[name] except KeyError: raise ValueError("Level '%s' does not exist" % name) from None if name not in self._core.levels: if no is None: raise ValueError( "Level '%s' does not exist, you have to create it by specifying a level no" % name ) old_color, old_icon = "", " " elif no is not None: raise ValueError("Level '%s' already exists, you can't update its severity no" % name) else: _, no, old_color, old_icon = self.level(name) if color is None: color = old_color if icon is None: icon = old_icon if not isinstance(no, int): raise TypeError( "Invalid level no, it should be an integer, not: '%s'" % type(no).__name__ ) if no < 0: raise ValueError("Invalid level no, it should be a positive integer, not: %d" % no) ansi = Colorizer.ansify(color) level = Level(name, no, color, icon) with self._core.lock: self._core.levels[name] = level self._core.levels_ansi_codes[name] = ansi self._core.levels_lookup[name] = (name, name, no, icon) for handler in self._core.handlers.values(): handler.update_format(name) return level def disable(self, name): """Disable logging of messages coming from ``name`` module and its children. Developers of library using `Loguru` should absolutely disable it to avoid disrupting users with unrelated logs messages. Note that in some rare circumstances, it is not possible for `Loguru` to determine the module's ``__name__`` value. In such situation, ``record["name"]`` will be equal to ``None``, this is why ``None`` is also a valid argument. Parameters ---------- name : \|str\| or ``None`` The name of the parent module to disable. Examples -------- >>> logger.info("Allowed message by default") [22:21:55] Allowed message by default >>> logger.disable("my_library") >>> logger.info("While publishing a library, don't forget to disable logging") """ self._change_activation(name, False) def enable(self, name): """Enable logging of messages coming from ``name`` module and its children. Logging is generally disabled by imported library using `Loguru`, hence this function allows users to receive these messages anyway. To enable all logs regardless of the module they are coming from, an empty string ``""`` can be passed. Parameters ---------- name : \|str\| or ``None`` The name of the parent module to re-allow. Examples -------- >>> logger.disable("__main__") >>> logger.info("Disabled, so nothing is logged.") >>> logger.enable("__main__") >>> logger.info("Re-enabled, messages are logged.") [22:46:12] Re-enabled, messages are logged. """ self._change_activation(name, True) def configure(self, , handlers=None, levels=None, extra=None, patcher=None, activation=None): """Configure the core logger. It should be noted that ``extra`` values set using this function are available across all modules, so this is the best way to set overall default values. To load the configuration directly from a file, such as JSON or YAML, it is also possible to use the \|loguru-config\|_ library developed by `@erezinman`_. Parameters ---------- handlers : \|list\| of \|dict\|, optional A list of each handler to be added. The list should contain dicts of params passed to the \|add\| function as keyword arguments. If not ``None``, all previously added handlers are first removed. levels : \|list\| of \|dict\|, optional A list of each level to be added or updated. The list should contain dicts of params passed to the \|level\| function as keyword arguments. This will never remove previously created levels. extra : \|dict\|, optional A dict containing additional parameters bound to the core logger, useful to share common properties if you call \|bind\| in several of your files modules. If not ``None``, this will remove previously configured ``extra`` dict. patcher : \|callable\|_, optional A function that will be applied to the record dict of each logged messages across all modules using the logger. It should modify the dict in-place without returning anything. The function is executed prior to the one possibly added by the \|patch\| method. If not ``None``, this will replace previously configured ``patcher`` function. activation : \|list\| of \|tuple\|, optional A list of ``(name, state)`` tuples which denotes which loggers should be enabled (if ``state`` is ``True``) or disabled (if ``state`` is ``False``). The calls to \|enable\| and \|disable\| are made accordingly to the list order. This will not modify previously activated loggers, so if you need a fresh start prepend your list with ``("", False)`` or ``("", True)``. Returns ------- :class:`list` of :class:`int` A list containing the identifiers of added sinks (if any). Examples -------- >>> logger.configure( ... handlers=[ ... dict(sink=sys.stderr, format="[{time}] {message}"), ... dict(sink="file.log", enqueue=True, serialize=True), ... ], ... levels=[dict(name="NEW", no=13, icon="¤", color="")], ... extra={"common_to_all": "default"}, ... patcher=lambda record: record["extra"].update(some_value=42), ... activation=[("my_module.secret", False), ("another_library.module", True)], ... ) [1, 2] >>> # Set a default "extra" dict to logger across all modules, without "bind()" >>> extra = {"context": "foo"} >>> logger.configure(extra=extra) >>> logger.add(sys.stderr, format="{extra[context]} - {message}") >>> logger.info("Context without bind") >>> # => "foo - Context without bind" >>> logger.bind(context="bar").info("Suppress global context") >>> # => "bar - Suppress global context" """ if handlers is not None: self.remove() else: handlers = [] if levels is not None: for params in levels: self.level(params) if patcher is not None: with self._core.lock: self._core.patcher = patcher if extra is not None: with self._core.lock: self._core.extra.clear() self._core.extra.update(extra) if activation is not None: for name, state in activation: if state: self.enable(name) else: self.disable(name) return [self.add(params) for params in handlers] def _change_activation(self, name, status): if not (name is None or isinstance(name, str)): raise TypeError( "Invalid name, it should be a string (or None), not: '%s'" % type(name).__name__ ) with self._core.lock: enabled = self._core.enabled.copy() if name is None: for n in enabled: if n is None: enabled[n] = status self._core.activation_none = status self._core.enabled = enabled return if name != "": name += "." activation_list = [ (n, s) for n, s in self._core.activation_list if n[: len(name)] != name ] parent_status = next((s for n, s in activation_list if name[: len(n)] == n), None) if parent_status != status and not (name == "" and status is True): activation_list.append((name, status)) def modules_depth(x): return x[0].count(".") activation_list.sort(key=modules_depth, reverse=True) for n in enabled: if n is not None and (n + ".")[: len(name)] == name: enabled[n] = status self._core.activation_list = activation_list self._core.enabled = enabled @staticmethod def parse(file, pattern, , cast={}, chunk=2*16): # noqa: B006 """Parse raw logs and extract each entry as a \|dict\|. The logging format has to be specified as the regex ``pattern``, it will then be used to parse the ``file`` and retrieve each entry based on the named groups present in the regex. Parameters ---------- file : \|str\|, \|Path\| or \|file-like object\|_ The path of the log file to be parsed, or an already opened file object. pattern : \|str\| or \|re.Pattern\|_ The regex to use for logs parsing, it should contain named groups which will be included in the returned dict. cast : \|callable\|_ or \|dict\|, optional A function that should convert in-place the regex groups parsed (a dict of string values) to more appropriate types. If a dict is passed, it should be a mapping between keys of parsed log dict and the function that should be used to convert the associated value. chunk : \|int\|, optional The number of bytes read while iterating through the logs, this avoids having to load the whole file in memory. Yields ------ :class:`dict` The dict mapping regex named groups to matched values, as returned by \|match.groupdict\| and optionally converted according to ``cast`` argument. Examples -------- >>> reg = r"(?P<lvl>[0-9]+): (?P<msg>.)" # If log format is "{level.no} - {message}" >>> for e in logger.parse("file.log", reg): # A file line could be "10 - A debug message" ... print(e) # => {'lvl': '10', 'msg': 'A debug message'} >>> caster = dict(lvl=int) # Parse 'lvl' key as an integer >>> for e in logger.parse("file.log", reg, cast=caster): ... print(e) # => {'lvl': 10, 'msg': 'A debug message'} >>> def cast(groups): ... if "date" in groups: ... groups["date"] = datetime.strptime(groups["date"], "%Y-%m-%d %H:%M:%S") ... >>> with open("file.log") as file: ... for log in logger.parse(file, reg, cast=cast): ... print(log["date"], log["something_else"]) """ if isinstance(file, (str, PathLike)): @contextlib.contextmanager def opener(): with open(str(file)) as fileobj: yield fileobj elif hasattr(file, "read") and callable(file.read): @contextlib.contextmanager def opener(): yield file else: raise TypeError( "Invalid file, it should be a string path or a file object, not: '%s'" % type(file).__name__ ) if isinstance(cast, dict): def cast_function(groups): for key, converter in cast.items(): if key in groups: groups[key] = converter(groups[key]) elif callable(cast): cast_function = cast else: raise TypeError( "Invalid cast, it should be a function or a dict, not: '%s'" % type(cast).__name__ ) try: regex = re.compile(pattern) except TypeError: raise TypeError( "Invalid pattern, it should be a string or a compiled regex, not: '%s'" % type(pattern).__name__ ) from None with opener() as fileobj: matches = Logger._find_iter(fileobj, regex, chunk) for match in matches: groups = match.groupdict() cast_function(groups) yield groups @staticmethod def _find_iter(fileobj, regex, chunk): buffer = fileobj.read(0) while True: text = fileobj.read(chunk) buffer += text matches = list(regex.finditer(buffer)) if not text: yield from matches break if len(matches) > 1: end = matches[-2].end() buffer = buffer[end:] yield from matches[:-1] def _log(self, level, from_decorator, options, message, args, kwargs): core = self._core if not core.handlers: return try: level_id, level_name, level_no, level_icon = core.levels_lookup[level] except (KeyError, TypeError): if isinstance(level, str): raise ValueError("Level '%s' does not exist" % level) from None if not isinstance(level, int): raise TypeError( "Invalid level, it should be an integer or a string, not: '%s'" % type(level).__name__ ) from None if level < 0: raise ValueError( "Invalid level value, it should be a positive integer, not: %d" % level ) from None cache = (None, "Level %d" % level, level, " ") level_id, level_name, level_no, level_icon = cache core.levels_lookup[level] = cache if level_no < core.min_level: return (exception, depth, record, lazy, colors, raw, capture, patchers, extra) = options try: frame = get_frame(depth + 2) except ValueError: f_globals = {} f_lineno = 0 co_name = "<unknown>" co_filename = "<unknown>" else: f_globals = frame.f_globals f_lineno = frame.f_lineno co_name = frame.f_code.co_name co_filename = frame.f_code.co_filename try: name = f_globals["__name__"] except KeyError: name = None try: if not core.enabled[name]: return except KeyError: enabled = core.enabled if name is None: status = core.activation_none enabled[name] = status if not status: return else: dotted_name = name + "." for dotted_module_name, status in core.activation_list: if dotted_name[: len(dotted_module_name)] == dotted_module_name: if status: break enabled[name] = False return enabled[name] = True current_datetime = aware_now() file_name = basename(co_filename) thread = current_thread() process = current_process() elapsed = current_datetime - start_time if exception: if isinstance(exception, BaseException): type_, value, traceback = (type(exception), exception, exception.__traceback__) elif isinstance(exception, tuple): type_, value, traceback = exception else: type_, value, traceback = sys.exc_info() exception = RecordException(type_, value, traceback) else: exception = None log_record = { "elapsed": elapsed, "exception": exception, "extra": {core.extra, context.get(), *extra}, "file": RecordFile(file_name, co_filename), "function": co_name, "level": RecordLevel(level_name, level_no, level_icon), "line": f_lineno, "message": str(message), "module": splitext(file_name)[0], "name": name, "process": RecordProcess(process.ident, process.name), "thread": RecordThread(thread.ident, thread.name), "time": current_datetime, } if lazy: args = [arg() for arg in args] kwargs = {key: value() for key, value in kwargs.items()} if capture and kwargs: log_record["extra"].update(kwargs) if record: if "record" in kwargs: raise TypeError( "The message can't be formatted: 'record' shall not be used as a keyword " "argument while logger has been configured with '.opt(record=True)'" ) kwargs.update(record=log_record) if colors: if args or kwargs: colored_message = Colorizer.prepare_message(message, args, kwargs) else: colored_message = Colorizer.prepare_simple_message(str(message)) log_record["message"] = colored_message.stripped elif args or kwargs: colored_message = None log_record["message"] = message.format(args, *kwargs) else: colored_message = None if core.patcher: core.patcher(log_record) for patcher in patchers: patcher(log_record) for handler in core.handlers.values(): handler.emit(log_record, level_id, from_decorator, raw, colored_message) def trace(__self, __message, args, *kwargs): # noqa: N805 r"""Log ``message.format(args, *kwargs)`` with severity ``'TRACE'``.""" __self._log("TRACE", False, __self._options, __message, args, kwargs) def debug(__self, __message, args, *kwargs): # noqa: N805 r"""Log ``message.format(args, *kwargs)`` with severity ``'DEBUG'``.""" __self._log("DEBUG", False, __self._options, __message, args, kwargs) def info(__self, __message, args, *kwargs): # noqa: N805 r"""Log ``message.format(args, *kwargs)`` with severity ``'INFO'``.""" __self._log("INFO", False, __self._options, __message, args, kwargs) def success(__self, __message, args, *kwargs): # noqa: N805 r"""Log ``message.format(args, *kwargs)`` with severity ``'SUCCESS'``.""" __self._log("SUCCESS", False, __self._options, __message, args, kwargs) def warning(__self, __message, args, *kwargs): # noqa: N805 r"""Log ``message.format(args, *kwargs)`` with severity ``'WARNING'``.""" __self._log("WARNING", False, __self._options, __message, args, kwargs) def error(__self, __message, args, *kwargs): # noqa: N805 r"""Log ``message.format(args, *kwargs)`` with severity ``'ERROR'``.""" __self._log("ERROR", False, __self._options, __message, args, kwargs) def critical(__self, __message, args, *kwargs): # noqa: N805 r"""Log ``message.format(args, *kwargs)`` with severity ``'CRITICAL'``.""" __self._log("CRITICAL", False, __self._options, __message, args, kwargs) def exception(__self, __message, args, *kwargs): # noqa: N805 r"""Log an ``'ERROR'```` message while also capturing the currently handled exception.""" options = (True,) + __self._options[1:] __self._log("ERROR", False, options, __message, args, kwargs) def log(__self, __level, __message, args, *kwargs): # noqa: N805 r"""Log ``message.format(args, *kwargs)`` with severity ``level``.""" __self._log(__level, False, __self._options, __message, args, kwargs) def start(self, args, *kwargs): """Add a handler sending log messages to a sink adequately configured. Deprecated function, use \|add\| instead. Warnings -------- .. deprecated:: 0.2.2 ``start()`` will be removed in Loguru 1.0.0, it is replaced by ``add()`` which is a less confusing name. """ warnings.warn( "The 'start()' method is deprecated, please use 'add()' instead", DeprecationWarning, stacklevel=2, ) return self.add(args, *kwargs) def stop(self, args, *kwargs): """Remove a previously added handler and stop sending logs to its sink. Deprecated function, use \|remove\| instead. Warnings -------- .. deprecated:: 0.2.2 ``stop()`` will be removed in Loguru 1.0.0, it is replaced by ``remove()`` which is a less confusing name. """ warnings.warn( "The 'stop()' method is deprecated, please use 'remove()' instead", DeprecationWarning, stacklevel=2, ) return self.remove(args, **kwargs)	95.56 KB	2025-05-25 12:26
📄 _recattrs.py import pickle from collections import namedtuple class RecordLevel: __slots__ = ("icon", "name", "no") def __init__(self, name, no, icon): self.name = name self.no = no self.icon = icon def __repr__(self): return "(name=%r, no=%r, icon=%r)" % (self.name, self.no, self.icon) def __format__(self, spec): return self.name.__format__(spec) class RecordFile: __slots__ = ("name", "path") def __init__(self, name, path): self.name = name self.path = path def __repr__(self): return "(name=%r, path=%r)" % (self.name, self.path) def __format__(self, spec): return self.name.__format__(spec) class RecordThread: __slots__ = ("id", "name") def __init__(self, id_, name): self.id = id_ self.name = name def __repr__(self): return "(id=%r, name=%r)" % (self.id, self.name) def __format__(self, spec): return self.id.__format__(spec) class RecordProcess: __slots__ = ("id", "name") def __init__(self, id_, name): self.id = id_ self.name = name def __repr__(self): return "(id=%r, name=%r)" % (self.id, self.name) def __format__(self, spec): return self.id.__format__(spec) class RecordException( namedtuple("RecordException", ("type", "value", "traceback")) # noqa: PYI024 ): def __repr__(self): return "(type=%r, value=%r, traceback=%r)" % (self.type, self.value, self.traceback) def __reduce__(self): # The traceback is not picklable, therefore it needs to be removed. Additionally, there's a # possibility that the exception value is not picklable either. In such cases, we also need # to remove it. This is done for user convenience, aiming to prevent error logging caused by # custom exceptions from third-party libraries. If the serialization succeeds, we can reuse # the pickled value later for optimization (so that it's not pickled twice). It's important # to note that custom exceptions might not necessarily raise a PickleError, hence the # generic Exception catch. try: pickled_value = pickle.dumps(self.value) except Exception: return (RecordException, (self.type, None, None)) else: return (RecordException._from_pickled_value, (self.type, pickled_value, None)) @classmethod def _from_pickled_value(cls, type_, pickled_value, traceback_): try: # It's safe to use "pickle.loads()" in this case because the pickled value is generated # by the same code and is not coming from an untrusted source. value = pickle.loads(pickled_value) except Exception: return cls(type_, None, traceback_) else: return cls(type_, value, traceback_)	2.82 KB	2025-05-25 12:26
📄 _simple_sinks.py import inspect import logging import weakref from ._asyncio_loop import get_running_loop, get_task_loop class StreamSink: def __init__(self, stream): self._stream = stream self._flushable = callable(getattr(stream, "flush", None)) self._stoppable = callable(getattr(stream, "stop", None)) self._completable = inspect.iscoroutinefunction(getattr(stream, "complete", None)) def write(self, message): self._stream.write(message) if self._flushable: self._stream.flush() def stop(self): if self._stoppable: self._stream.stop() def tasks_to_complete(self): if not self._completable: return [] return [self._stream.complete()] class StandardSink: def __init__(self, handler): self._handler = handler def write(self, message): raw_record = message.record message = str(message) exc = raw_record["exception"] record = logging.getLogger().makeRecord( raw_record["name"], raw_record["level"].no, raw_record["file"].path, raw_record["line"], message, (), (exc.type, exc.value, exc.traceback) if exc else None, raw_record["function"], {"extra": raw_record["extra"]}, ) if exc: record.exc_text = "\n" record.levelname = raw_record["level"].name self._handler.handle(record) def stop(self): self._handler.close() def tasks_to_complete(self): return [] class AsyncSink: def __init__(self, function, loop, error_interceptor): self._function = function self._loop = loop self._error_interceptor = error_interceptor self._tasks = weakref.WeakSet() def write(self, message): try: loop = self._loop or get_running_loop() except RuntimeError: return coroutine = self._function(message) task = loop.create_task(coroutine) def check_exception(future): if future.cancelled() or future.exception() is None: return if not self._error_interceptor.should_catch(): raise future.exception() self._error_interceptor.print(message.record, exception=future.exception()) task.add_done_callback(check_exception) self._tasks.add(task) def stop(self): for task in self._tasks: task.cancel() def tasks_to_complete(self): # To avoid errors due to "self._tasks" being mutated while iterated, the # "tasks_to_complete()" method must be protected by the same lock as "write()" (which # happens to be the handler lock). However, the tasks must not be awaited while the lock is # acquired as this could lead to a deadlock. Therefore, we first need to collect the tasks # to complete, then return them so that they can be awaited outside of the lock. return [self._complete_task(task) for task in self._tasks] async def _complete_task(self, task): loop = get_running_loop() if get_task_loop(task) is not loop: return try: await task except Exception: pass # Handled in "check_exception()" def __getstate__(self): state = self.__dict__.copy() state["_tasks"] = None return state def __setstate__(self, state): self.__dict__.update(state) self._tasks = weakref.WeakSet() class CallableSink: def __init__(self, function): self._function = function def write(self, message): self._function(message) def stop(self): pass def tasks_to_complete(self): return []	3.73 KB	2025-05-25 12:26
📄 _string_parsers.py import datetime import re class Frequencies: @staticmethod def hourly(t): dt = t + datetime.timedelta(hours=1) return dt.replace(minute=0, second=0, microsecond=0) @staticmethod def daily(t): dt = t + datetime.timedelta(days=1) return dt.replace(hour=0, minute=0, second=0, microsecond=0) @staticmethod def weekly(t): dt = t + datetime.timedelta(days=7 - t.weekday()) return dt.replace(hour=0, minute=0, second=0, microsecond=0) @staticmethod def monthly(t): if t.month == 12: y, m = t.year + 1, 1 else: y, m = t.year, t.month + 1 return t.replace(year=y, month=m, day=1, hour=0, minute=0, second=0, microsecond=0) @staticmethod def yearly(t): y = t.year + 1 return t.replace(year=y, month=1, day=1, hour=0, minute=0, second=0, microsecond=0) def parse_size(size): size = size.strip() reg = re.compile(r"([e\+\-\.\d]+)\s([kmgtpezy])?(i)?(b)", flags=re.I) match = reg.fullmatch(size) if not match: return None s, u, i, b = match.groups() try: s = float(s) except ValueError as e: raise ValueError("Invalid float value while parsing size: '%s'" % s) from e u = "kmgtpezy".index(u.lower()) + 1 if u else 0 i = 1024 if i else 1000 b = {"b": 8, "B": 1}[b] if b else 1 return s i*u / b def parse_duration(duration): duration = duration.strip() reg = r"(?:([e\+\-\.\d]+)\s([a-z]+)[\s\,])" units = [ ("y\|years?", 31536000), ("months?", 2628000), ("w\|weeks?", 604800), ("d\|days?", 86400), ("h\|hours?", 3600), ("min(?:ute)?s?", 60), ("s\|sec(?:ond)?s?", 1), # spellchecker: disable-line ("ms\|milliseconds?", 0.001), ("us\|microseconds?", 0.000001), ] if not re.fullmatch(reg + "+", duration, flags=re.I): return None seconds = 0 for value, unit in re.findall(reg, duration, flags=re.I): try: value = float(value) except ValueError as e: raise ValueError("Invalid float value while parsing duration: '%s'" % value) from e try: unit = next(u for r, u in units if re.fullmatch(r, unit, flags=re.I)) except StopIteration: raise ValueError("Invalid unit value while parsing duration: '%s'" % unit) from None seconds += value unit return datetime.timedelta(seconds=seconds) def parse_frequency(frequency): frequencies = { "hourly": Frequencies.hourly, "daily": Frequencies.daily, "weekly": Frequencies.weekly, "monthly": Frequencies.monthly, "yearly": Frequencies.yearly, } frequency = frequency.strip().lower() return frequencies.get(frequency, None) def parse_day(day): days = { "monday": 0, "tuesday": 1, "wednesday": 2, "thursday": 3, "friday": 4, "saturday": 5, "sunday": 6, } day = day.strip().lower() if day in days: return days[day] if day.startswith("w") and day[1:].isdigit(): day = int(day[1:]) if not 0 <= day < 7: raise ValueError("Invalid weekday value while parsing day (expected [0-6]): '%d'" % day) else: day = None return day def parse_time(time): time = time.strip() reg = re.compile(r"^[\d\.\:]+\s(?:[ap]m)?$", flags=re.I) if not reg.match(time): return None formats = [ "%H", "%H:%M", "%H:%M:%S", "%H:%M:%S.%f", "%I %p", "%I:%M %S", "%I:%M:%S %p", "%I:%M:%S.%f %p", ] for format_ in formats: try: dt = datetime.datetime.strptime(time, format_) except ValueError: pass else: return dt.time() raise ValueError("Unrecognized format while parsing time: '%s'" % time) def parse_daytime(daytime): daytime = daytime.strip() reg = re.compile(r"^(.?)\s+at\s+(.*)$", flags=re.I) match = reg.match(daytime) if match: day, time = match.groups() else: day = time = daytime try: parsed_day = parse_day(day) if match and parsed_day is None: raise ValueError("Unparsable day") except ValueError as e: raise ValueError("Invalid day while parsing daytime: '%s'" % day) from e try: parsed_time = parse_time(time) if match and parsed_time is None: raise ValueError("Unparsable time") except ValueError as e: raise ValueError("Invalid time while parsing daytime: '%s'" % time) from e if parsed_day is None and parsed_time is None: return None return parsed_day, parsed_time	4.7 KB	2025-05-25 12:26
📄 py.typed	0 B	2025-05-25 12:26

Edit File:

Terminal