logger-36 2024.19__py3-none-any.whl → 2024.21__py3-none-any.whl

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/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/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/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
@@ -57,9 +61,8 @@ class generic_handler_t(lggg.Handler):
     formatter: d.InitVar[lggg.Formatter | None] = None
 
     supports_html: d.InitVar[bool] = False
-    should_record: 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/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/logger.py

@@ -5,7 +5,6 @@ SEE COPYRIGHT NOTICE BELOW
 """
 
 from logger_36.catalog.logger.chronos import LogElapsedTime
-from logger_36.catalog.logger.exception import LogException
 from logger_36.catalog.logger.memory import LogMaximumMemoryUsage, LogMemoryUsages
 from logger_36.catalog.logger.system import LogSystemDetails
 

logger_36/type/logger.py

@@ -7,7 +7,7 @@ SEE COPYRIGHT NOTICE BELOW
 import dataclasses as d
 import logging as lggg
 import sys as sstm
-import traceback as tbck
+import traceback as tcbk
 import types as t
 import typing as h
 from datetime import datetime as dttm
@@ -221,6 +221,22 @@ class logger_t(lggg.Logger):
             # __post_init__ set self.exit_on_critical if self.exit_on_error.
             sstm.exit(1)
 
+    def error_for_exception(
+        self,
+        exception: Exception,
+        /,
+        *,
+        should_remove_caller: bool = False,
+    ) -> None:
+        """"""
+        lines = tcbk.format_exception(exception)
+        if should_remove_caller:
+            message = "\n".join(lines[:1] + lines[2:])
+        else:
+            formatted = "".join(lines)
+            message = f"{type(exception).__name__}:\n{formatted}"
+        self.error(message)
+
     def AddContextLevel(self, new_level: str, /) -> None:
         """"""
         self.context_levels.append(new_level)
@@ -292,11 +308,11 @@ class logger_t(lggg.Logger):
             try:
                 raise level("\n" + issues)
             except Exception as exception:
-                lines = ["Traceback (most recent call last):"] + tbck.format_stack()[
+                lines = ["Traceback (most recent call last):"] + tcbk.format_stack()[
                     :-1
                 ]
                 lines[-1] = lines[-1][:-1]
-                lines.extend(tbck.format_exception_only(exception))
+                lines.extend(tcbk.format_exception_only(exception))
                 print("\n".join(lines), file=sstm.stderr)
                 sstm.exit(1)
 
@@ -305,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/version.py

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

{logger_36-2024.19.dist-info → logger_36-2024.21.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: logger-36
-Version: 2024.19
+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.19.dist-info → logger_36-2024.21.dist-info}/RECORD

@@ -1,18 +1,17 @@
 logger_36/__init__.py,sha256=jHidpp6dmfJVdoiHkwTXBn1_u1HRaZj3BHS8jq71ZOE,2312
 logger_36/format.py,sha256=mox36RRkNUWbeHo3XkGGlik2CoyswDvDehRDtZkrnD0,2558
-logger_36/handler.py,sha256=wHMj4OyQrUdhAxk_MCvPTBT1Ig3BYpfbqxHYfp91fOU,6697
-logger_36/logger.py,sha256=flRcn5-2L7yGfJusfnkQXzFQcX3Ljt-1_KWnA_I0new,2446
+logger_36/handler.py,sha256=9KUu02RpKGKBR358gqS5G1Zut5C6MyBgGzRsQYFBAtY,6721
+logger_36/logger.py,sha256=7LJtdT7TmfFsn6r34iTr6OGvEjXlU6hKXEO2c5Lm2zY,2386
 logger_36/logger_gpu.py,sha256=YYFk6aYQrBDJfxQaDm-ar16T6SlOSL6jJWTOgvpF4EU,2244
 logger_36/measure.py,sha256=P507VNbVKAf4jYGnGX-3rlDrVbrYP0ZD3nxFmAFvhyI,2404
 logger_36/storage.py,sha256=O8pDmiL0B3LJpKrhi8a9IMBXs6MwW6r1bMUn_cSDAaY,2246
-logger_36/version.py,sha256=pk3jW0gVcV0DVsZOCeVxbuluEwh3R_zjxpQerFhYt0Q,2206
+logger_36/version.py,sha256=rTDQY_iaCr8FcZO-_ELLxzcbp57fGX9nsGWkY7plJmk,2206
 logger_36/catalog/config/console_rich.py,sha256=QDkgSs3I7ZULvkd1q4J1hdvgyB857JJcJWxM9fdL51Y,2883
-logger_36/catalog/handler/console.py,sha256=1WLtmxZCBj0AxLu5xey3VIVBKm02bp-Rc-eZOiFtXnU,3893
-logger_36/catalog/handler/console_rich.py,sha256=v57EFAvCaH5ABoZ24lFn1ObCe_EntHpqzW7RJLs6Lik,8681
-logger_36/catalog/handler/file.py,sha256=GS5nsfp0j0mzPak7vz8E7U4e5H95os_qfDjdM1Ywf0g,4345
-logger_36/catalog/handler/generic.py,sha256=IwHOE_KhviuJJKCp8-LU86X90Mp0HJO5V5fhiOhfN98,8126
+logger_36/catalog/handler/console.py,sha256=SF9S3CUoEPp5dh7RrqotywDJjMgRp0rD9sO3eLVXnkA,4004
+logger_36/catalog/handler/console_rich.py,sha256=Ti1k2E1ox4egzicghTb9Wv30xiWaBbWwe8ouopJsujY,8792
+logger_36/catalog/handler/file.py,sha256=z5ovaOxemh61pbWDCK2sMMlbd1TKwGjMiQhgoicilm4,4456
+logger_36/catalog/handler/generic.py,sha256=wG6Z1-lHj_9o6cPurEVpPctFlec3BFeqx2mZU_krJt8,8379
 logger_36/catalog/logger/chronos.py,sha256=eLqQw8N9vaGO23OCf5RrYDPbUeu7epUvDt9rH-dN7i0,2522
-logger_36/catalog/logger/exception.py,sha256=sL7sZ_bjNoof2xgOXvBzAi2xHrj7Pmjfkfhjzuy6NGs,2708
 logger_36/catalog/logger/gpu.py,sha256=vUFSP17e7U4nenMi5IMlDiP3cZvXe6nqEDpoqzTavdg,3490
 logger_36/catalog/logger/memory.py,sha256=Zel_UCnHqGAqf_YuKpvjt0OIOo9vwKYpFM9g_2bjir0,4790
 logger_36/catalog/logger/system.py,sha256=FQ3w1zIN1ab6y8QYtcYDULhyJYy4iwTwHoDs8Mi2IdQ,3159
@@ -41,9 +40,9 @@ logger_36/task/measure/chronos.py,sha256=t-y0bVm1SmF-3wI9pR9Bp6-qzVlsE94fZTZr5a_
 logger_36/task/measure/memory.py,sha256=eVw5WOYLyn8o4O4mMArdX2MzsVuhhNDovjYEkk-MIaU,2504
 logger_36/type/handler.py,sha256=BXpevZhLq5V_IdUfi_LZA4czzlH2SGLpgvbqUBe5X10,8311
 logger_36/type/issue.py,sha256=cB8pSSJg9aqFPQ6yJr4TC2kJbngKGK8Hyq4ATBm6jAc,2973
-logger_36/type/logger.py,sha256=GaZQQDy6B0_5x2yOrV7r3W9ib7egSRQJCFRE_DpALYw,14669
+logger_36/type/logger.py,sha256=W6U0t_M6juGoc5cGb9vdwk29LhNeg2Sa-VeOKiWJrac,15234
 logger_36/type/loggers.py,sha256=znqxWBnfQxvkg3VUfbTUvt3S6Kq0DAzWWepxQDt9suI,2871
-logger_36-2024.19.dist-info/METADATA,sha256=p3u2INogEHx1jOHYVd6Qja2EmVeA-qe5dM2rcVuOfXc,6276
-logger_36-2024.19.dist-info/WHEEL,sha256=-oYQCr74JF3a37z2nRlQays_SX2MqOANoqVjBBAP2yE,91
-logger_36-2024.19.dist-info/top_level.txt,sha256=sM95BTMWmslEEgR_1pzwZsOeSp8C_QBiu8ImbFr0XLc,10
-logger_36-2024.19.dist-info/RECORD,,
+logger_36-2024.21.dist-info/METADATA,sha256=fsvDva8-byjx5YqWdp2yf83uIjNA04WYyBjTcdVAgbY,6276
+logger_36-2024.21.dist-info/WHEEL,sha256=HiCZjzuy6Dw0hdX5R3LCFPDmFS4BWl8H-8W39XfmgX4,91
+logger_36-2024.21.dist-info/top_level.txt,sha256=sM95BTMWmslEEgR_1pzwZsOeSp8C_QBiu8ImbFr0XLc,10
+logger_36-2024.21.dist-info/RECORD,,

{logger_36-2024.19.dist-info → logger_36-2024.21.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (71.0.3)
+Generator: setuptools (72.2.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

logger_36/catalog/logger/exception.py

@@ -1,74 +0,0 @@
-"""
-Copyright CNRS/Inria/UniCA
-Contributor(s): Eric Debreuve (eric.debreuve@cnrs.fr) since 2023
-SEE COPYRIGHT NOTICE BELOW
-"""
-
-import traceback as tcbk
-
-from logger_36.instance.logger import LOGGER
-from logger_36.type.logger import logger_t
-
-
-def LogException(
-    exception: Exception,
-    /,
-    *,
-    logger: logger_t = LOGGER,
-    should_remove_caller: bool = False,
-) -> None:
-    """"""
-    lines = tcbk.format_exception(exception)
-    if should_remove_caller:
-        message = "\n".join(lines[:1] + lines[2:])
-    else:
-        formatted = "".join(lines)
-        message = f"{type(exception).__name__}:\n{formatted}"
-    logger.error(message)
-
-
-"""
-COPYRIGHT NOTICE
-
-This software is governed by the CeCILL  license under French law and
-abiding by the rules of distribution of free software.  You can  use,
-modify and/ or redistribute the software under the terms of the CeCILL
-license as circulated by CEA, CNRS and INRIA at the following URL
-"http://www.cecill.info".
-
-As a counterpart to the access to the source code and  rights to copy,
-modify and redistribute granted by the license, users are provided only
-with a limited warranty  and the software's author,  the holder of the
-economic rights,  and the successive licensors  have only  limited
-liability.
-
-In this respect, the user's attention is drawn to the risks associated
-with loading,  using,  modifying and/or developing or reproducing the
-software by the user in light of its specific status of free software,
-that may mean  that it is complicated to manipulate,  and  that  also
-therefore means  that it is reserved for developers  and  experienced
-professionals having in-depth computer knowledge. Users are therefore
-encouraged to load and test the software's suitability as regards their
-requirements in conditions enabling the security of their systems and/or
-data to be ensured and,  more generally, to use and operate it in the
-same conditions as regards security.
-
-The fact that you are presently reading this means that you have had
-knowledge of the CeCILL license and that you accept its terms.
-
-SEE LICENCE NOTICE: file README-LICENCE-utf8.txt at project source root.
-
-This software is being developed by Eric Debreuve, a CNRS employee and
-member of team Morpheme.
-Team Morpheme is a joint team between Inria, CNRS, and UniCA.
-It is hosted by the Centre Inria d'Université Côte d'Azur, Laboratory
-I3S, and Laboratory iBV.
-
-CNRS: https://www.cnrs.fr/index.php/en
-Inria: https://www.inria.fr/en/
-UniCA: https://univ-cotedazur.eu/
-Centre Inria d'Université Côte d'Azur: https://www.inria.fr/en/centre/sophia/
-I3S: https://www.i3s.unice.fr/en/
-iBV: http://ibv.unice.fr/
-Team Morpheme: https://team.inria.fr/morpheme/
-"""