logger-36 2024.20__tar.gz → 2024.21__tar.gz

{logger_36-2024.20 → logger_36-2024.21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: logger-36
-Version: 2024.20
+Version: 2024.21
 Summary: Simple logger with a catalog of handlers
 Home-page: https://src.koda.cnrs.fr/eric.debreuve/logger-36/
 Author: Eric Debreuve

{logger_36-2024.20 → logger_36-2024.21}/package/logger_36/catalog/handler/console.py

@@ -58,7 +58,10 @@ class console_handler_t(lggg.Handler):
         print(message)
 
     def ShowMessage(self, message: str, /) -> None:
-        """"""
+        """
+        See documentation of
+        logger_36.catalog.handler.generic.generic_handler_t.ShowMessage.
+        """
         print(message)
 
 

{logger_36-2024.20 → logger_36-2024.21}/package/logger_36/catalog/handler/console_rich.py

@@ -155,7 +155,10 @@ class console_rich_handler_t(lggg.Handler):
         self.console.print(richer, crop=False, overflow="ignore")
 
     def ShowMessage(self, message: str, /) -> None:
-        """"""
+        """
+        See documentation of
+        logger_36.catalog.handler.generic.generic_handler_t.ShowMessage.
+        """
         self.console.print(message, crop=False, overflow="ignore")
 
 

{logger_36-2024.20 → logger_36-2024.21}/package/logger_36/catalog/handler/file.py

@@ -68,7 +68,10 @@ class file_handler_t(lggg.FileHandler):
         self.stream.flush()
 
     def ShowMessage(self, message: str, /) -> None:
-        """"""
+        """
+        See documentation of
+        logger_36.catalog.handler.generic.generic_handler_t.ShowMessage.
+        """
         print(message, file=self.stream)
         self.stream.flush()
 

{logger_36-2024.20 → logger_36-2024.21}/package/logger_36/catalog/handler/generic.py

@@ -23,31 +23,35 @@ from logger_36.task.format.rule import Rule, RuleAsText
 from logger_36.type.handler import handler_extension_t
 
 
-class can_show_message_p(h.Protocol):
-    def ShowMessage(self, message: str, /) -> None: ...
-
-
-interface_h = can_show_message_p | h.Callable[[str], None]
-
-
 @d.dataclass(slots=True, repr=False, eq=False)
 class generic_handler_t(lggg.Handler):
     """
     alternating_lines:
-    - Initial value:
-        - 1: enabled for dark background
-        - 2: enabled for light background
-        - anything else: disabled
-    - Runtime value: 0/1=do not/do highlight next time.
+        - Initial value:
+            - 1: enabled for dark background
+            - 2: enabled for light background
+            - anything else: disabled
+        - Runtime value: 0/1=do not/do highlight next time.
+
+    ShowMessage:
+        Log a message as is, i.e. without formatting. If this is a method, it should
+        contain the same call(s) as the final ones in the emit methods that are used to
+        output the formatted log messages. This means that there is some code
+        duplication, but it avoids a (maybe negligible) slowing down that would arise
+        from calling this method at the end of the emit methods.
+        Here, since, by definition, the generic handler does not know how to output
+        messages, it is a callable attribute that must be set at instantiation time, and
+        it is indeed called at the end of the emit method.
     """
 
-    extension: handler_extension_t = d.field(init=False)
+    ShowMessage: h.Callable[[str], None]
     console: console_t = None
     console_options: console_options_t = None
-    FormattedLines: h.Callable[..., tuple[str, str | None]] = d.field(init=False)
     alternating_lines: int = 0
     background_is_light: bool = True
-    ShowMessage: h.Callable[[str], None] = lambda _arg: None
+
+    extension: handler_extension_t = d.field(init=False)
+    FormattedLines: h.Callable[..., tuple[str, str | None]] = d.field(init=False)
 
     name: d.InitVar[str | None] = None
     level: d.InitVar[int] = lggg.NOTSET
@@ -59,7 +63,6 @@ class generic_handler_t(lggg.Handler):
     supports_html: d.InitVar[bool] = False
     should_record: d.InitVar[bool] = False
     rich_kwargs: d.InitVar[dict[str, h.Any] | None] = None
-    interface: d.InitVar[interface_h | None] = None  # Cannot be None actually.
 
     def __post_init__(
         self,
@@ -72,7 +75,6 @@ class generic_handler_t(lggg.Handler):
         supports_html: bool,
         should_record: bool,
         rich_kwargs: dict[str, h.Any] | None,
-        interface: interface_h | None,
     ) -> None:
         """"""
         lggg.Handler.__init__(self)
@@ -110,10 +112,6 @@ class generic_handler_t(lggg.Handler):
         else:
             self.alternating_lines = -1
 
-        self.ShowMessage = getattr(
-            interface, can_show_message_p.ShowMessage.__name__, interface
-        )
-
     def emit(self, record: lggg.LogRecord, /) -> None:
         """"""
         if self.console is None:

{logger_36-2024.20 → logger_36-2024.21}/package/logger_36/handler.py

@@ -6,11 +6,12 @@ SEE COPYRIGHT NOTICE BELOW
 
 import logging as lggg
 import sys as sstm
+import typing as h
 from pathlib import Path as path_t
 
 from logger_36.catalog.handler.console import console_handler_t
 from logger_36.catalog.handler.file import file_handler_t
-from logger_36.catalog.handler.generic import generic_handler_t, interface_h
+from logger_36.catalog.handler.generic import generic_handler_t
 from logger_36.constant.error import MISSING_RICH_ERROR
 from logger_36.instance.logger import LOGGER
 
@@ -27,7 +28,7 @@ except ModuleNotFoundError:
 
 
 def AddGenericHandler(
-    interface: interface_h,
+    ShowMessage: h.Callable[[str], None],
     /,
     *,
     logger: lggg.Logger | None = None,
@@ -58,7 +59,7 @@ def AddGenericHandler(
         alternating_lines=alternating_lines,
         should_record=should_record,
         rich_kwargs=kwargs,
-        interface=interface,
+        ShowMessage=ShowMessage,
     )
     logger.AddHandler(handler, should_hold_messages)
 

{logger_36-2024.20 → logger_36-2024.21}/package/logger_36/type/logger.py

@@ -321,7 +321,10 @@ class logger_t(lggg.Logger):
         self.staged_issues.clear()
 
     def ShowMessage(self, message: str, /) -> None:
-        """"""
+        """
+        See documentation of
+        logger_36.catalog.handler.generic.generic_handler_t.ShowMessage.
+        """
         for handler in self.handlers:
             ShowMessage = getattr(handler, "ShowMessage", None)
             if ShowMessage is not None:

{logger_36-2024.20 → logger_36-2024.21}/package/logger_36/version.py

@@ -4,7 +4,7 @@ Contributor(s): Eric Debreuve (eric.debreuve@cnrs.fr) since 2023
 SEE COPYRIGHT NOTICE BELOW
 """
 
-__version__ = "2024.20"
+__version__ = "2024.21"
 
 """
 COPYRIGHT NOTICE

{logger_36-2024.20 → logger_36-2024.21}/package/logger_36.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: logger-36
-Version: 2024.20
+Version: 2024.21
 Summary: Simple logger with a catalog of handlers
 Home-page: https://src.koda.cnrs.fr/eric.debreuve/logger-36/
 Author: Eric Debreuve