festo-python-logging 0.0.7__tar.gz → 0.0.10__tar.gz

{festo_python_logging-0.0.7 → festo_python_logging-0.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: festo-python-logging
-Version: 0.0.7
+Version: 0.0.10
 Summary: Convenience function to configure python logging.
 License: Proprietary
 Author: Charles Wilmot
@@ -14,3 +14,4 @@ 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

{festo_python_logging-0.0.7 → festo_python_logging-0.0.10}/festo_python_logging/__init__.py

@@ -4,6 +4,8 @@ from datetime import datetime
 from pathlib import Path
 from typing import List, Optional
 
+from festo_python_logging.formatter import AlignedFormatter
+
 
 def configure_logging(
     verbose: bool = False,
@@ -23,10 +25,7 @@ def configure_logging(
 
     """
     # Define formatters for stdout and file logging
-    stdout_formatter = logging.Formatter(
-        fmt="{relativeCreated:13.2f} {levelname:>8} {name:>35.35}:{lineno:4d} │  {message}",
-        style="{",
-    )
+    stdout_formatter = AlignedFormatter()
     file_formatter = logging.Formatter(
         fmt="{relativeCreated:13.2f} {levelname:>8} {name:>35.35}:{lineno:4d} │  {message}",
         style="{",

festo_python_logging-0.0.10/festo_python_logging/formatter.py

@@ -0,0 +1,52 @@
+import logging
+import shutil
+import textwrap
+
+
+class AlignedFormatter(logging.Formatter):
+    """A logging formatter that aligns log messages for better readability."""
+
+    def format(self, record):  # noqa: D102, manually set below
+        if not hasattr(self, "_max_record_name_length"):
+            self._max_record_name_length = 8
+
+        if len(record.name) > self._max_record_name_length:
+            self._max_record_name_length = min(35, len(record.name))
+
+        # Get the base message
+        message = record.getMessage()
+        separator_1 = "├"
+        separator_2 = "│"
+
+        # Compute available width for message text
+        terminal_width = shutil.get_terminal_size((160, 20)).columns
+
+        right_padded_record_name = f"{record.name:>{self._max_record_name_length}.{self._max_record_name_length}}"
+        prefix = (
+            " ".join(
+                (
+                    f"{record.relativeCreated:13.2f}",
+                    f"{record.levelname:>8}",
+                    f"{right_padded_record_name}:{record.lineno:4d}",
+                ),
+            )
+            + f" {separator_1} "
+        )
+        text_width = max(10, terminal_width - len(prefix))
+
+        # Wrap the message text
+        wrapped_lines = textwrap.wrap(message, width=text_width)
+
+        # Assemble aligned output
+        if wrapped_lines:
+            lines = [prefix + wrapped_lines[0]]
+            continuation_prefix = " " * (len(prefix) - 2) + separator_2 + " "
+            for line in wrapped_lines[1:]:
+                lines.append(continuation_prefix + line)
+            formatted = "\n".join(lines)
+        else:
+            formatted = prefix
+
+        return formatted
+
+    format.__doc__ = logging.Formatter.format.__doc__

festo_python_logging-0.0.10/festo_python_logging/test.py

@@ -0,0 +1,20 @@
+import logging
+
+from festo_python_logging import configure_logging
+
+logger = logging.getLogger(__name__)
+
+configure_logging(verbose=True)
+
+logger.debug("This is a debug message.")
+logger.info("This is an info message.")
+logger.warning("This is a warning message.")
+logger.error("This is an error message.")
+
+verys = "very " * 50
+logger.debug(f"This is a {verys} long  debug message.")
+logger.info(f"This is an {verys} long  info message.")
+logger.warning(f"This is a {verys} long  warning message.")
+logger.error(f"This is an {verys} long  error message.")
+some_list = [i for i in range(100)]
+logger.debug(f"{some_list}")

{festo_python_logging-0.0.7 → festo_python_logging-0.0.10}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "poetry_dynamic_versioning.backend"
 
 [tool.poetry]
 name = "festo-python-logging"
-version = "0.0.7"
+version = "0.0.10"
 license = "Proprietary"
 authors = [
   "Charles Wilmot <charles.wilmot@festo.com>",
@@ -56,7 +56,9 @@ ignore = [
     "ANN401",  # at the moment a lot of these annotations are necessary due to missing upstream typing support,
     "D100",    # not enforced pending decision on documentation requirements
     "D104",    # not enforced pending decision on documentation requirements
+    "D107",    # missing docstring in __init__
     "D401",    # Do not enforce first word being in impertative
+    "D203",    # 1 blank line before class docstring
     "D211",
     "D213",
     "TRY003",  # raise-vanilla-args