lcdp-logging-utils 1.5.8__tar.gz

lcdp_logging_utils-1.5.8/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.4
+Name: lcdp-logging-utils
+Version: 1.5.8
+Summary: Postgres Utils to configure logging...
+Author: Le Comptoir Des Pharmacies
+Author-email: webmaster@lecomptoirdespharmacies.fr
+Requires-Python: >=3.8
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: click (==8.1.7)

lcdp_logging_utils-1.5.8/lcdp_logging_utils/config.py

@@ -0,0 +1,83 @@
+import logging
+import click
+import sys
+from copy import copy
+from typing_extensions import Literal
+TRACE_LOG_LEVEL = 5
+
+class DdStub:
+    trace_id = 0
+    span_id = 0
+
+class ColourizedFormatter(logging.Formatter):
+    """
+    A custom log formatter class that:
+
+    * Outputs the LOG_LEVEL with an appropriate color.
+    * If a log call includes an `extra={"color_message": ...}` it will be used
+      for formatting the output, instead of the plain text message.
+    """
+
+    level_name_colors = {
+        TRACE_LOG_LEVEL: lambda level_name: click.style(str(level_name), fg="blue"),
+        logging.DEBUG: lambda level_name: click.style(str(level_name), fg="cyan"),
+        logging.INFO: lambda level_name: click.style(str(level_name), fg="green"),
+        logging.WARNING: lambda level_name: click.style(str(level_name), fg="yellow"),
+        logging.ERROR: lambda level_name: click.style(str(level_name), fg="red"),
+        logging.CRITICAL: lambda level_name: click.style(str(level_name), fg="bright_red"),
+    }
+
+    def __init__(
+        self,
+        fmt: str | None = None,
+        datefmt: str | None = None,
+        style: Literal["%", "{", "$"] = "%",
+        use_colors: bool | None = None,
+        *args,
+        **kwargs
+    ):
+        if use_colors in (True, False):
+            self.use_colors = use_colors
+        else:
+            self.use_colors = sys.stdout.isatty()
+        super().__init__(fmt=fmt, datefmt=datefmt, style=style, *args, **kwargs)
+
+    def color_level_name(self, level_name: str, level_no: int) -> str:
+        def default(level_name: str) -> str:
+            return str(level_name)  # pragma: no cover
+
+        func = self.level_name_colors.get(level_no, default)
+        return func(level_name)
+
+    def should_use_colors(self) -> bool:
+        return True  # pragma: no cover
+
+    def formatMessage(self, record: logging.LogRecord) -> str:
+        recordcopy = copy(record)
+        levelname = recordcopy.levelname
+        if self.use_colors:
+            levelname = self.color_level_name(levelname, recordcopy.levelno)
+            if "color_message" in recordcopy.__dict__:
+                recordcopy.msg = recordcopy.__dict__["color_message"]
+                recordcopy.__dict__["message"] = recordcopy.getMessage()
+        recordcopy.__dict__["levelprefix"] = levelname
+        return super().formatMessage(recordcopy)
+
+
+# See : https://github.com/encode/starlette/issues/864#issuecomment-653076434
+def create_periodic_endpoint_filter(custom_endpoints=[]):
+    class PeriodicEndpointFilter(logging.Filter):
+        def filter(self, record: logging.LogRecord) -> bool:
+            matchers = ["/actuator/health"]
+            matchers.extend(custom_endpoints)
+            return not any(xs in record.getMessage() for xs in matchers)
+
+    return PeriodicEndpointFilter
+
+def console_formatter():
+    return ColourizedFormatter(
+    "{threadName}s - {dd.trace_id} {dd.span_id} - {levelprefix} - {name} - {message}",
+    style="{",
+    use_colors=True,
+    defaults={"dd": DdStub()}
+)

lcdp_logging_utils-1.5.8/pyproject.toml

@@ -0,0 +1,23 @@
+[tool.poetry]
+name = "lcdp-logging-utils"
+# https://github.com/python-poetry/poetry/issues/1208
+version = "1.5.8"
+description = "Postgres Utils to configure logging..."
+authors = ["Le Comptoir Des Pharmacies <webmaster@lecomptoirdespharmacies.fr>"]
+
+[tool.poetry-dynamic-versioning]
+enable = false
+vcs = "git"
+
+[tool.poetry.requires-plugins]
+poetry-dynamic-versioning = { version = ">=1.0.0,<2.0.0", extras = ["plugin"] }
+
+[tool.poetry.dependencies]
+python = ">=3.8"
+click = "8.1.7"
+
+[tool.poetry.dev-dependencies]
+
+[build-system]
+requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning>=1.0.0,<2.0.0"]
+build-backend = "poetry_dynamic_versioning.backend"