RFL.log 1.0.0__tar.gz

RFL.log-1.0.0/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.1
+Name: RFL.log
+Version: 1.0.0
+Summary: Rackslab Foundation Library: log package
+Author-email: Rémi Palancher <remi@rackslab.io>
+License: GPLv3+
+Project-URL: Homepage, https://github.com/rackslab/RFL
+Project-URL: Bug Tracker, https://github.com/rackslab/RFL/issues
+Keywords: utility,basic
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+
+# RFL: log package
+
+Logging utility.

RFL.log-1.0.0/README.md

@@ -0,0 +1,3 @@
+# RFL: log package
+
+Logging utility.

RFL.log-1.0.0/RFL.log.egg-info/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.1
+Name: RFL.log
+Version: 1.0.0
+Summary: Rackslab Foundation Library: log package
+Author-email: Rémi Palancher <remi@rackslab.io>
+License: GPLv3+
+Project-URL: Homepage, https://github.com/rackslab/RFL
+Project-URL: Bug Tracker, https://github.com/rackslab/RFL/issues
+Keywords: utility,basic
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+
+# RFL: log package
+
+Logging utility.

RFL.log-1.0.0/RFL.log.egg-info/SOURCES.txt

@@ -0,0 +1,8 @@
+README.md
+pyproject.toml
+RFL.log.egg-info/PKG-INFO
+RFL.log.egg-info/SOURCES.txt
+RFL.log.egg-info/dependency_links.txt
+RFL.log.egg-info/top_level.txt
+rfl/log/__init__.py
+rfl/log/formatters.py

RFL.log-1.0.0/RFL.log.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

RFL.log-1.0.0/RFL.log.egg-info/top_level.txt

@@ -0,0 +1 @@
+rfl

RFL.log-1.0.0/pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "RFL.log"
+version = "1.0.0"
+description = "Rackslab Foundation Library: log package"
+license = {text = "GPLv3+"}
+requires-python = ">=3.6"
+keywords = ["utility", "basic"]
+authors = [
+    {name = "Rémi Palancher", email = "remi@rackslab.io"},
+]
+dependencies = []
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
+    "Programming Language :: Python :: 3",
+    "Topic :: System :: Systems Administration",
+]
+readme = "README.md"
+
+[project.urls]
+"Homepage" = "https://github.com/rackslab/RFL"
+"Bug Tracker" = "https://github.com/rackslab/RFL/issues"
+
+[tool.setuptools.packages.find]
+include = ["rfl.log*"]

RFL.log-1.0.0/rfl/log/__init__.py

@@ -0,0 +1,83 @@
+# Copyright (c) 2023 Rackslab
+#
+# This file is part of RFL.
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from typing import Optional, List
+import logging
+
+from .formatters import TTYFormatter, DaemonFormatter, auto_formatter
+
+__all__ = [TTYFormatter, DaemonFormatter, auto_formatter]
+
+
+def setup_logger(
+    debug: bool = False,
+    log_flags: Optional[List[str]] = None,
+    debug_flags: Optional[List[str]] = None,
+    formatter: logging.Formatter = auto_formatter(),
+) -> None:
+    """Setup root logger debug level, debug flags and formatter."""
+    if debug:
+        logging_level = logging.DEBUG
+    else:
+        logging_level = logging.INFO
+
+    if log_flags is None:
+        log_flags = []
+    if debug_flags is None:
+        debug_flags = []
+
+    root_logger = logging.getLogger()
+    root_logger.setLevel(logging_level)
+    handler = logging.StreamHandler()
+    handler.setLevel(logging_level)
+    formatter = formatter(debug)
+    handler.setFormatter(formatter)
+    # filter out all libs logs not enabled in flags
+    def custom_filter(record):
+        component = record.name.split(".")[0]
+        if record.levelno == logging.DEBUG:
+            if "ALL" in debug_flags or component in debug_flags:
+                return 1
+            return 0
+        if "ALL" in log_flags or component in log_flags:
+            return 1
+        return 0
+
+    handler.addFilter(custom_filter)
+    root_logger.addHandler(handler)
+
+
+def enforce_debug(
+    log_flags: Optional[List[str]] = None,
+    debug_flags: Optional[List[str]] = None,
+) -> None:
+    """Enforce root logger debug level and debug flags."""
+    root_logger = logging.getLogger()
+    root_logger.setLevel(level=logging.DEBUG)
+
+    if log_flags is None:
+        log_flags = []
+    if debug_flags is None:
+        debug_flags = []
+
+    # filter out all libs logs not enabled in flags
+    def custom_filter(record):
+        component = record.name.split(".")[0]
+        if record.levelno == logging.DEBUG:
+            if "ALL" in debug_flags or component in debug_flags:
+                return 1
+            return 0
+        if "ALL" in log_flags or component in log_flags:
+            return 1
+        return 0
+
+    # For all handlers, set log level, enable debug in formatter and replace filter.
+    for handler in root_logger.handlers:
+        handler.setLevel(logging.DEBUG)
+        handler.formatter.debug = True
+        for filter in handler.filters:
+            handler.removeFilter(filter)
+            handler.addFilter(custom_filter)

RFL.log-1.0.0/rfl/log/formatters.py

@@ -0,0 +1,75 @@
+# Copyright (c) 2023 Rackslab
+#
+# This file is part of RFL.
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+import sys
+import logging
+
+
+def auto_formatter():
+    """Automatically select the most appropriate formatter class by checking if stdout
+    is connected to a TTY."""
+    if sys.stdout.isatty():
+        return TTYFormatter
+    else:
+        return DaemonFormatter
+
+
+class ANSIStyle:
+    def __init__(self, fg, bg=None):
+        self.fg = fg
+        self.bg = bg
+
+    @property
+    def start(self):
+        bg_s = ""
+        if self.bg is not None:
+            bg_s = f"\033[48;5;{self.bg}m"
+        return bg_s + f"\033[38;5;{self.fg}m"
+
+    @property
+    def end(self):
+        return "\033[0;0m"
+
+
+LOG_LEVEL_ANSI_STYLES = {
+    logging.CRITICAL: ANSIStyle(fg=15, bg=160),  # white on red
+    logging.ERROR: ANSIStyle(fg=160),  # red
+    logging.WARNING: ANSIStyle(fg=208),  # orange
+    logging.INFO: ANSIStyle(fg=28),  # dark green
+    logging.DEBUG: ANSIStyle(fg=62),  # light mauve
+    logging.NOTSET: ANSIStyle(fg=8),  # grey
+}
+
+
+class TTYFormatter(logging.Formatter):
+    def __init__(self, debug=False):
+        super().__init__("%(message)s")
+        self.debug = debug
+
+    def format(self, record):
+
+        _msg = record.getMessage()
+        style = LOG_LEVEL_ANSI_STYLES[record.levelno]
+        prefix = ""
+        if self.debug:
+            prefix = "{level:8s}⸬{where:30s} ↦ ".format(
+                level="[" + record.levelname + "]",
+                where=record.name + ":" + str(record.lineno),
+            )
+        elif record.levelno >= logging.INFO:
+            # prefix with level if over info
+            prefix = "{level} ⸬ ".format(level=record.levelname)
+
+        return style.start + prefix + _msg + style.end
+
+
+class DaemonFormatter(logging.Formatter):
+    def __init__(self, debug=True):
+        if debug:
+            _fmt = "%(threadName)s: [%(levelname)s] %(name)s %(message)s"
+        else:
+            _fmt = "%(threadName)s: [%(levelname)s] %(message)s"
+        super().__init__(_fmt)

RFL.log-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+