refact: reorganize utility modules

src/kleinanzeigen_bot/utils/loggers.py

@@ -0,0 +1,116 @@
+"""
+SPDX-FileCopyrightText: © Sebastian Thomschke and contributors
+SPDX-License-Identifier: AGPL-3.0-or-later
+SPDX-ArtifactOfProjectHomePage: https://github.com/Second-Hand-Friends/kleinanzeigen-bot/
+"""
+import copy, logging, re, sys
+from gettext import gettext as _
+from typing import Any, Final  # @UnusedImport
+
+import colorama
+from . import i18n, reflect
+
+__all__ = [
+    "Logger",
+    "LOG_ROOT",
+    "DEBUG",
+    "INFO",
+    "configure_console_logging",
+    "flush_all_handlers",
+    "get_logger"
+]
+
+Logger = logging.Logger
+DEBUG:Final[int] = logging.DEBUG
+INFO:Final[int] = logging.INFO
+
+LOG_ROOT:Final[logging.Logger] = logging.getLogger()
+
+
+def configure_console_logging() -> None:
+
+    class CustomFormatter(logging.Formatter):
+        LEVEL_COLORS = {
+            logging.DEBUG: colorama.Fore.BLACK + colorama.Style.BRIGHT,
+            logging.INFO: colorama.Fore.BLACK + colorama.Style.BRIGHT,
+            logging.WARNING: colorama.Fore.YELLOW,
+            logging.ERROR: colorama.Fore.RED,
+            logging.CRITICAL: colorama.Fore.RED,
+        }
+        MESSAGE_COLORS = {
+            logging.DEBUG: colorama.Fore.BLACK + colorama.Style.BRIGHT,
+            logging.INFO: colorama.Fore.RESET,
+            logging.WARNING: colorama.Fore.YELLOW,
+            logging.ERROR: colorama.Fore.RED,
+            logging.CRITICAL: colorama.Fore.RED + colorama.Style.BRIGHT,
+        }
+        VALUE_COLORS = {
+            logging.DEBUG: colorama.Fore.BLACK + colorama.Style.BRIGHT,
+            logging.INFO: colorama.Fore.MAGENTA,
+            logging.WARNING: colorama.Fore.MAGENTA,
+            logging.ERROR: colorama.Fore.MAGENTA,
+            logging.CRITICAL: colorama.Fore.MAGENTA,
+        }
+
+        def format(self, record:logging.LogRecord) -> str:
+            record = copy.deepcopy(record)
+
+            level_color = self.LEVEL_COLORS.get(record.levelno, "")
+            msg_color = self.MESSAGE_COLORS.get(record.levelno, "")
+            value_color = self.VALUE_COLORS.get(record.levelno, "")
+
+            # translate and colorize log level name
+            levelname = _(record.levelname) if record.levelno > logging.DEBUG else record.levelname
+            record.levelname = f"{level_color}[{levelname}]{colorama.Style.RESET_ALL}"
+
+            # highlight message values enclosed by [...], "...", and '...'
+            record.msg = re.sub(
+                r"\[([^\]]+)\]|\"([^\"]+)\"|\'([^\']+)\'",
+                lambda match: f"[{value_color}{match.group(1) or match.group(2) or match.group(3)}{colorama.Fore.RESET}{msg_color}]",
+                str(record.msg),
+            )
+
+            # colorize message
+            record.msg = f"{msg_color}{record.msg}{colorama.Style.RESET_ALL}"
+
+            return super().format(record)
+
+    formatter = CustomFormatter("%(levelname)s %(message)s")
+
+    stdout_log = logging.StreamHandler(sys.stderr)
+    stdout_log.setLevel(logging.DEBUG)
+    stdout_log.addFilter(type("", (logging.Filter,), {
+        "filter": lambda rec: rec.levelno <= logging.INFO
+    }))
+    stdout_log.setFormatter(formatter)
+    LOG_ROOT.addHandler(stdout_log)
+
+    stderr_log = logging.StreamHandler(sys.stderr)
+    stderr_log.setLevel(logging.WARNING)
+    stderr_log.setFormatter(formatter)
+    LOG_ROOT.addHandler(stderr_log)
+
+
+def flush_all_handlers() -> None:
+    for handler in LOG_ROOT.handlers:
+        handler.flush()
+
+
+def get_logger(name: str | None = None) -> logging.Logger:
+    """
+    Returns a localized logger
+    """
+
+    class TranslatingLogger(logging.Logger):
+
+        def _log(self, level: int, msg: object, *args: Any, **kwargs: Any) -> None:
+            if level != logging.DEBUG:  # debug messages should not be translated
+                msg = i18n.translate(msg, reflect.get_caller(2))
+            super()._log(level, msg, *args, **kwargs)
+
+    logging.setLoggerClass(TranslatingLogger)
+    return logging.getLogger(name)
+
+
+def is_debug(logger:Logger) -> bool:
+    return logger.isEnabledFor(logging.DEBUG)