logger-36 2025.4__py3-none-any.whl → 2025.6__py3-none-any.whl

logger_36/exception.py

@@ -4,23 +4,24 @@ Contributor(s): Eric Debreuve (eric.debreuve@cnrs.fr) since 2023
 SEE COPYRIGHT NOTICE BELOW
 """
 
-import sys as sstm
+import re as r
+import sys as s
 import tempfile as tmpf
 import traceback as tcbk
 import types as t
 from pathlib import Path as path_t
 
-_ORIGINAL_EXCEPTION_HANDLER = sstm.excepthook
+_ORIGINAL_EXCEPTION_HANDLER = s.excepthook
 
 
 def OverrideExceptionFormat() -> None:
     """"""
-    sstm.excepthook = _HandleException
+    s.excepthook = _HandleException
 
 
 def ResetExceptionFormat() -> None:
     """"""
-    sstm.excepthook = _ORIGINAL_EXCEPTION_HANDLER
+    s.excepthook = _ORIGINAL_EXCEPTION_HANDLER
 
 
 def _HandleException(
@@ -30,25 +31,58 @@ def _HandleException(
     while trace.tb_next is not None:
         trace = trace.tb_next
     frame = trace.tb_frame
-    module = frame.f_code.co_filename
-    function = frame.f_code.co_name
-    line = frame.f_lineno
-
-    home = str(path_t.home())
-    if module.startswith(home):
-        module = "~" + module[home.__len__():]
-
-    message = str(exception)
+    code = frame.f_code
+    module = path_t(code.co_filename)
+    function = code.co_name
+    line_number = frame.f_lineno
+    line_content = module.read_text().splitlines()[line_number - 1].strip()
+
+    # Format module.
+    home = path_t.home()
+    if module.is_relative_to(home):
+        module = path_t("~") / module.relative_to(home)
+
+    # Format line content.
+    if line_content.startswith("raise "):
+        # Do not display code of explicit exception raising.
+        line_content = None
+
+    # Find variables appearing in the line.
+    if line_content is None:
+        line_content = variables = ""
+    else:
+        all_variables = frame.f_locals
+        found_names = []
+        for match in r.finditer(r"[^\d\W]\w*", line_content):
+            name = match.group()
+            if name in all_variables:
+                found_names.append(name)
+        if found_names.__len__() > 0:
+            longest = max(map(len, found_names))
+            variables = map(
+                lambda _: f"{_:{longest}} = {all_variables[_]}", sorted(found_names)
+            )
+            variables = "        " + "\n        ".join(variables) + "\n"
+        else:
+            variables = ""
+
+        line_content = f"    {line_content}\n"
+
+    # Format message.
+    message = str(exception).strip()
     if message.__len__() > 0:
-        message = f"    {message}\n"
+        message = f"    {message[0].title()}{message[1:]}\n"
 
     document = tmpf.NamedTemporaryFile(delete=False)
 
     print(
         f"{stripe.__name__}\n"
-        f"    {module}.{function}@{line}\n"
-        f"{message}    Full report at: {document.name}",
-        file=sstm.stderr,
+        f"    {module}:{function}@{line_number}\n"
+        f"{line_content}"
+        f"{variables}"
+        f"{message}"
+        f"    Full report at: {document.name}",
+        file=s.stderr,
     )
 
     lines = tcbk.format_exception(exception)

logger_36/gpu.py

@@ -4,7 +4,7 @@ Contributor(s): Eric Debreuve (eric.debreuve@cnrs.fr) since 2023
 SEE COPYRIGHT NOTICE BELOW
 """
 
-from logger_36.catalog.logger.gpu import LogGPURelatedDetails
+from logger_36.catalog.logger.gpu import LogGPURelatedDetails  # noqa
 
 """
 COPYRIGHT NOTICE

logger_36/handler.py

@@ -4,38 +4,34 @@ Contributor(s): Eric Debreuve (eric.debreuve@cnrs.fr) since 2023
 SEE COPYRIGHT NOTICE BELOW
 """
 
-import logging as lggg
-import sys as sstm
+import logging as l
+import sys as s
 from pathlib import Path as path_t
 
+from logger_36.catalog.config.optional import MISSING_RICH_MESSAGE, RICH_IS_AVAILABLE
 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, show_message_p
-from logger_36.constant.error import MISSING_RICH_ERROR
-from logger_36.instance.logger import LOGGER
 
-try:
+if RICH_IS_AVAILABLE:
     from logger_36.catalog.handler.console_rich import console_rich_handler_t
-
-    _MISSING_RICH_ERROR = None
-except ModuleNotFoundError:
+else:
     from logger_36.catalog.handler.console import (
         console_handler_t as console_rich_handler_t,
     )
-
-    _MISSING_RICH_ERROR = MISSING_RICH_ERROR
+_MISSING_RICH_MESSAGE = MISSING_RICH_MESSAGE
 
 
 def AddGenericHandler(
+    logger: l.Logger,
     ShowMessage: show_message_p,
     /,
     *,
-    logger: lggg.Logger | None = None,
     name: str | None = None,
-    level: int = lggg.INFO,
+    level: int = l.INFO,
     should_store_memory_usage: bool = False,
     message_width: int = -1,
-    formatter: lggg.Formatter | None = None,
+    formatter: l.Formatter | None = None,
     supports_html: bool = False,
     alternating_lines: int = 2,
     should_record: bool = False,
@@ -43,9 +39,6 @@ def AddGenericHandler(
     **kwargs,
 ) -> None:
     """"""
-    if logger is None:
-        logger = LOGGER
-
     handler = generic_handler_t(
         name=name,
         level=level,
@@ -58,23 +51,21 @@ def AddGenericHandler(
         rich_kwargs=kwargs,
         ShowMessage=ShowMessage,
     )
-    logger.AddHandler(handler, should_hold_messages)
+    logger.AddHandler(handler, should_hold_messages=should_hold_messages)
 
 
 def AddConsoleHandler(
+    logger: l.Logger,
+    /,
     *,
-    logger: lggg.Logger | None = None,
     name: str | None = None,
-    level: int = lggg.INFO,
+    level: int = l.INFO,
     should_store_memory_usage: bool = False,
     message_width: int = -1,
-    formatter: lggg.Formatter | None = None,
+    formatter: l.Formatter | None = None,
     should_hold_messages: bool = False,
 ) -> None:
     """"""
-    if logger is None:
-        logger = LOGGER
-
     handler = console_handler_t(
         name=name,
         level=level,
@@ -82,17 +73,18 @@ def AddConsoleHandler(
         message_width=message_width,
         formatter=formatter,
     )
-    logger.AddHandler(handler, should_hold_messages)
+    logger.AddHandler(handler, should_hold_messages=should_hold_messages)
 
 
 def AddRichConsoleHandler(
+    logger: l.Logger,
+    /,
     *,
-    logger: lggg.Logger | None = None,
     name: str | None = None,
-    level: int = lggg.INFO,
+    level: int = l.INFO,
     should_store_memory_usage: bool = False,
     message_width: int = -1,
-    formatter: lggg.Formatter | None = None,
+    formatter: l.Formatter | None = None,
     alternating_lines: int = 2,
     should_hold_messages: bool = False,
     should_install_traceback: bool = False,
@@ -100,13 +92,10 @@ def AddRichConsoleHandler(
     **kwargs,
 ) -> None:
     """"""
-    global _MISSING_RICH_ERROR
-    if _MISSING_RICH_ERROR is not None:
-        print(_MISSING_RICH_ERROR, file=sstm.stderr)
-        _MISSING_RICH_ERROR = None
-
-    if logger is None:
-        logger = LOGGER
+    global _MISSING_RICH_MESSAGE
+    if _MISSING_RICH_MESSAGE is not None:
+        print(_MISSING_RICH_MESSAGE, file=s.stderr)
+        _MISSING_RICH_MESSAGE = None
 
     if console_rich_handler_t is console_handler_t:
         additional_s = {}
@@ -125,19 +114,19 @@ def AddRichConsoleHandler(
         formatter=formatter,
         **additional_s,
     )
-    logger.AddHandler(handler, should_hold_messages)
+    logger.AddHandler(handler, should_hold_messages=should_hold_messages)
 
 
 def AddFileHandler(
+    logger: l.Logger,
     path: str | path_t,
     /,
     *args,
-    logger: lggg.Logger | None = None,
     name: str | None = None,
-    level: int = lggg.INFO,
+    level: int = l.INFO,
     should_store_memory_usage: bool = False,
     message_width: int = -1,
-    formatter: lggg.Formatter | None = None,
+    formatter: l.Formatter | None = None,
     should_hold_messages: bool = False,
     **kwargs,
 ) -> None:
@@ -146,8 +135,6 @@ def AddFileHandler(
         path = path_t(path)
     if path.exists():
         raise ValueError(f"File or folder already exists: {path}.")
-    if logger is None:
-        logger = LOGGER
 
     handler = file_handler_t(
         name=name,
@@ -159,7 +146,7 @@ def AddFileHandler(
         handler_args=args,
         handler_kwargs=kwargs,
     )
-    logger.AddHandler(handler, should_hold_messages)
+    logger.AddHandler(handler, should_hold_messages=should_hold_messages)
 
 
 """

logger_36/instance/logger.py

@@ -6,7 +6,7 @@ SEE COPYRIGHT NOTICE BELOW
 
 from logger_36.type.logger import logger_t
 
-LOGGER = logger_t()
+L = logger_t()
 
 """
 COPYRIGHT NOTICE

logger_36/memory.py

@@ -4,14 +4,17 @@ Contributor(s): Eric Debreuve (eric.debreuve@cnrs.fr) since 2023
 SEE COPYRIGHT NOTICE BELOW
 """
 
-from logger_36.catalog.logger.memory import LogMaximumMemoryUsage, LogMemoryUsages
-from logger_36.task.format.memory import FormattedUsage as FormattedMemoryUsage
-from logger_36.task.format.memory import (
+from logger_36.catalog.logger.memory import (  # noqa
+    LogMaximumMemoryUsage,
+    LogMemoryUsages,
+)
+from logger_36.task.format.memory import FormattedUsage as FormattedMemoryUsage  # noqa
+from logger_36.task.format.memory import (  # noqa
     FormattedUsageWithAutoUnit as FormattedMemoryUsageWithAutoUnit,
 )
-from logger_36.task.format.memory import UsageBar as MemoryUsageBar
-from logger_36.task.measure.memory import CanCheckUsage as CanCheckMemoryUsage
-from logger_36.task.measure.memory import CurrentUsage as CurrentMemoryUsage
+from logger_36.task.format.memory import UsageBar as MemoryUsageBar  # noqa
+from logger_36.task.measure.memory import CanCheckUsage as CanCheckMemoryUsage  # noqa
+from logger_36.task.measure.memory import CurrentUsage as CurrentMemoryUsage  # noqa
 
 """
 COPYRIGHT NOTICE

logger_36/storage.py

@@ -4,7 +4,7 @@ Contributor(s): Eric Debreuve (eric.debreuve@cnrs.fr) since 2023
 SEE COPYRIGHT NOTICE BELOW
 """
 
-from logger_36.task.storage import SaveLOGasHTML
+from logger_36.task.storage import SaveLOGasHTML  # noqa
 
 """
 COPYRIGHT NOTICE

logger_36/system.py

@@ -4,7 +4,7 @@ Contributor(s): Eric Debreuve (eric.debreuve@cnrs.fr) since 2023
 SEE COPYRIGHT NOTICE BELOW
 """
 
-from logger_36.catalog.logger.system import LogSystemDetails
+from logger_36.catalog.logger.system import LogSystemDetails  # noqa
 
 """
 COPYRIGHT NOTICE

logger_36/task/format/rule.py

@@ -4,6 +4,8 @@ Contributor(s): Eric Debreuve (eric.debreuve@cnrs.fr) since 2023
 SEE COPYRIGHT NOTICE BELOW
 """
 
+from logger_36.catalog.config.optional import RICH_IS_AVAILABLE
+
 
 def RuleAsText(text: str | None, /) -> str:
     """"""
@@ -13,7 +15,7 @@ def RuleAsText(text: str | None, /) -> str:
         return f"---- ---- ---- ---- {text} ---- ---- ---- ----"
 
 
-try:
+if RICH_IS_AVAILABLE:
     from rich.rule import Rule as rule_t  # noqa
     from rich.text import Text as text_t  # noqa
 
@@ -24,7 +26,7 @@ try:
         else:
             return rule_t(title=text_t(text, style=f"bold {color}"), style=color)
 
-except ModuleNotFoundError:
+else:
     Rule = lambda _txt, _: RuleAsText(_txt)
 
 """

logger_36/task/inspection.py

@@ -6,7 +6,7 @@ SEE COPYRIGHT NOTICE BELOW
 
 import importlib.metadata as mprt
 import pkgutil as pkgs
-import sys as sstm
+import sys as s
 from types import FunctionType, MethodType
 
 
@@ -17,8 +17,8 @@ def Modules(
     output = []
 
     if only_loaded:
-        modules = sstm.modules
-        module_names = set(modules.keys()).difference(sstm.stdlib_module_names)
+        modules = s.modules
+        module_names = set(modules.keys()).difference(s.stdlib_module_names)
         module_names = sorted(module_names, key=str.lower)
     else:
         modules = None

logger_36/task/measure/chronos.py

@@ -22,9 +22,7 @@ def TimeStamp(*, precision: str = "microseconds") -> str:
     )
 
 
-def ElapsedTime(
-    *, should_return_now: bool = False
-) -> str | tuple[str, date_time_t]:
+def ElapsedTime(*, should_return_now: bool = False) -> str | tuple[str, date_time_t]:
     """"""
     now = date_time_t.now()
     elapsed_seconds = (now - _START_DATE_AND_TIME).total_seconds()

logger_36/task/measure/memory.py

@@ -6,10 +6,10 @@ SEE COPYRIGHT NOTICE BELOW
 
 try:
     from psutil import Process as process_t  # noqa
-
-    _PROCESS = process_t()
 except ModuleNotFoundError:
     _PROCESS = None
+else:
+    _PROCESS = process_t()
 
 
 def CanCheckUsage() -> bool:

logger_36/task/storage.py

@@ -5,18 +5,20 @@ SEE COPYRIGHT NOTICE BELOW
 """
 
 import dataclasses as d
-import logging as lggg
-import re as regx
+import logging as l
+import re as r
 from html.parser import HTMLParser as html_parser_t
 from io import IOBase as io_base_t
 from pathlib import Path as path_t
 
-try:
+from logger_36.catalog.config.optional import RICH_IS_AVAILABLE
+from logger_36.instance.logger import L
+
+if RICH_IS_AVAILABLE:
     from rich.console import Console as console_t  # noqa
-except ModuleNotFoundError:
+else:
     console_t = None
 
-from logger_36.instance.logger import LOGGER
 
 _BODY_END_PATTERN = r"</[bB][oO][dD][yY]>(.|\n)*$"
 
@@ -60,7 +62,7 @@ class html_reader_t(html_parser_t):
             output[self.body_position_start[0] : (self.body_position_end[0] + 1)]
         )
         output = output[self.body_position_start[1] :]
-        output = regx.sub(_BODY_END_PATTERN, "", output, count=1)
+        output = r.sub(_BODY_END_PATTERN, "", output, count=1)
 
         return output.strip()
 
@@ -77,19 +79,19 @@ def SaveLOGasHTML(path: str | path_t | io_base_t | None = None) -> None:
     cannot_save = "Cannot save logging record as HTML"
 
     if console_t is None:
-        LOGGER.warning(f"{cannot_save}: The Rich console cannot be imported.")
+        L.warning(f"{cannot_save}: The Rich console cannot be imported.")
         return
 
     if path is None:
-        for handler in LOGGER.handlers:
-            if isinstance(handler, lggg.FileHandler):
+        for handler in L.handlers:
+            if isinstance(handler, l.FileHandler):
                 path = path_t(handler.baseFilename).with_suffix(".htm")
                 break
         if path is None:
-            LOGGER.warning(f"{cannot_save}: No file handler to build a filename from.")
+            L.warning(f"{cannot_save}: No file handler to build a filename from.")
             return
         if path.exists():
-            LOGGER.warning(
+            L.warning(
                 f'{cannot_save}: Automatically generated path "{path}" already exists.'
             )
             return
@@ -98,10 +100,10 @@ def SaveLOGasHTML(path: str | path_t | io_base_t | None = None) -> None:
 
     actual_file = isinstance(path, path_t)
     if actual_file and path.exists():
-        LOGGER.warning(f'{cannot_save}: File "{path}" already exists.')
+        L.warning(f'{cannot_save}: File "{path}" already exists.')
         return
 
-    for handler in LOGGER.handlers:
+    for handler in L.handlers:
         console = getattr(handler, "console", None)
         if isinstance(console, console_t) and console.record:
             html = console.export_html()
@@ -112,9 +114,7 @@ def SaveLOGasHTML(path: str | path_t | io_base_t | None = None) -> None:
                 path.write(html)
             break
     else:
-        LOGGER.warning(
-            f"{cannot_save}: No handler has a RICH console with recording ON."
-        )
+        L.warning(f"{cannot_save}: No handler has a RICH console with recording ON.")
 
 
 """

logger_36/time.py

@@ -4,8 +4,8 @@ Contributor(s): Eric Debreuve (eric.debreuve@cnrs.fr) since 2023
 SEE COPYRIGHT NOTICE BELOW
 """
 
-from logger_36.catalog.logger.chronos import LogElapsedTime
-from logger_36.task.measure.chronos import ElapsedTime, TimeStamp
+from logger_36.catalog.logger.chronos import LogElapsedTime  # noqa
+from logger_36.task.measure.chronos import ElapsedTime, TimeStamp  # noqa
 
 """
 COPYRIGHT NOTICE

logger_36/type/handler.py

@@ -5,8 +5,8 @@ SEE COPYRIGHT NOTICE BELOW
 """
 
 import dataclasses as d
-import logging as lggg
-import sys as sstm
+import logging as l
+import sys as s
 import typing as h
 
 from logger_36.config.message import (
@@ -16,12 +16,31 @@ from logger_36.config.message import (
     WHERE_SEPARATOR,
 )
 from logger_36.constant.error import MEMORY_MEASURE_ERROR
-from logger_36.constant.handler import HANDLER_CODES
+from logger_36.constant.handler import HANDLER_KINDS
 from logger_36.constant.message import NEXT_LINE_PROLOGUE
 from logger_36.task.format.message import MessageWithActualExpected
 from logger_36.task.measure.chronos import TimeStamp
 from logger_36.task.measure.memory import CanCheckUsage as CanCheckMemoryUsage
 
+
+@h.runtime_checkable
+class message_from_record_raw_p(h.Protocol):
+    def __call__(self, record: l.LogRecord, /) -> str: ...
+
+
+@h.runtime_checkable
+class message_from_record_preprocessed_p(h.Protocol):
+    def __call__(
+        self,
+        record: l.LogRecord,
+        /,
+        *,
+        PreProcessed: h.Callable[[str], str] | None = None,
+    ) -> str: ...
+
+
+message_from_record_h = message_from_record_raw_p | message_from_record_preprocessed_p
+
 _MEMORY_MEASURE_ERROR = MEMORY_MEASURE_ERROR
 
 
@@ -30,24 +49,24 @@ class handler_extension_t:
     name: str | None = None
     should_store_memory_usage: bool = False
     message_width: int = -1
-    MessageFromRecord: h.Callable[..., str] = d.field(init=False)
+    MessageFromRecord: message_from_record_h = d.field(init=False)
 
-    handler: d.InitVar[lggg.Handler | None] = None
-    level: d.InitVar[int] = lggg.NOTSET
-    formatter: d.InitVar[lggg.Formatter | None] = None
+    handler: d.InitVar[l.Handler | None] = None
+    level: d.InitVar[int] = l.NOTSET
+    formatter: d.InitVar[l.Formatter | None] = None
 
     def __post_init__(
-        self, handler: lggg.Handler | None, level: int, formatter: lggg.Formatter | None
+        self, handler: l.Handler | None, level: int, formatter: l.Formatter | None
     ) -> None:
         """"""
         global _MEMORY_MEASURE_ERROR
 
-        if self.name in HANDLER_CODES:
+        if self.name in HANDLER_KINDS:
             raise ValueError(
                 MessageWithActualExpected(
                     "Invalid handler name",
                     actual=self.name,
-                    expected=f"a name not in {str(HANDLER_CODES)[1:-1]}",
+                    expected=f"a name not in {str(HANDLER_KINDS)[1:-1]}",
                 )
             )
 
@@ -57,7 +76,7 @@ class handler_extension_t:
         if self.should_store_memory_usage and not CanCheckMemoryUsage():
             self.should_store_memory_usage = False
             if _MEMORY_MEASURE_ERROR is not None:
-                print(_MEMORY_MEASURE_ERROR, file=sstm.stderr)
+                print(_MEMORY_MEASURE_ERROR, file=s.stderr)
                 _MEMORY_MEASURE_ERROR = None
 
         handler.setLevel(level)
@@ -72,7 +91,7 @@ class handler_extension_t:
 
     def _MessageFromRecord(
         self,
-        record: lggg.LogRecord,
+        record: l.LogRecord,
         /,
         *,
         PreProcessed: h.Callable[[str], str] | None = None,

logger_36/type/issue.py

@@ -4,7 +4,7 @@ Contributor(s): Eric Debreuve (eric.debreuve@cnrs.fr) since 2023
 SEE COPYRIGHT NOTICE BELOW
 """
 
-import logging as lggg
+import logging as l
 import typing as h
 
 from logger_36.config.issue import ISSUE_BASE_CONTEXT
@@ -22,7 +22,7 @@ def NewIssue(
     message: str,
     /,
     *,
-    level: int = lggg.ERROR,
+    level: int = l.ERROR,
     actual: h.Any = NOT_PASSED,
     expected: h.Any | None = None,
     expected_is_choices: bool = False,