logger-36 2024.22__py3-none-any.whl → 2024.24__py3-none-any.whl

logger_36/catalog/handler/console_rich.py

@@ -31,7 +31,6 @@ from logger_36.task.format.rule import Rule
 from logger_36.type.handler import handler_extension_t
 from rich.console import Console as console_t
 from rich.console import RenderableType as renderable_t
-from rich.markup import escape as EscapedForRich
 from rich.text import Text as text_t
 from rich.traceback import install as InstallTracebackHandler
 
@@ -140,7 +139,7 @@ class console_rich_handler_t(lggg.Handler):
         if hasattr(record, SHOW_W_RULE_ATTR):
             richer = Rule(record.msg, DATE_TIME_COLOR)
         else:
-            first, next_s = self.FormattedLines(record, PreProcessed=EscapedForRich)
+            first, next_s = self.FormattedLines(record)
             should_highlight_back = self.alternating_lines == 1
             if self.alternating_lines >= 0:
                 self.alternating_lines = (self.alternating_lines + 1) % 2
@@ -173,7 +172,9 @@ def HighlightedVersion(
     background_is_light: bool = True,
 ) -> renderable_t:
     """"""
-    output = text_t(first_line)
+    # TODO: Is there a way to use html or something to enable message styling,
+    #     regardless of the handler (would require styling conversion; html->rich here).
+    output = text_t.from_markup(first_line)
 
     # Used instead of _CONTEXT_LENGTH which might include \t, thus creating a
     # mismatch between character length and length when displayed in console.
@@ -193,7 +194,7 @@ def HighlightedVersion(
     output.stylize(ELAPSED_TIME_COLOR, start=elapsed_time_separator)
 
     if next_lines is not None:
-        output.append(next_lines)
+        output.append(text_t.from_markup(next_lines))
 
     _ = output.highlight_regex(ACTUAL_PATTERNS, style=ACTUAL_COLOR)
     _ = output.highlight_regex(EXPECTED_PATTERNS, style=EXPECTED_COLOR)

logger_36/constant/message.py

@@ -19,7 +19,7 @@ LOG_LEVEL_LENGTH = 1 + LEVEL_OPENING.__len__() + LEVEL_CLOSING.__len__()
 CONTEXT_LENGTH = TIME_LENGTH + LOG_LEVEL_LENGTH
 NEXT_LINE_PROLOGUE = "\n" + (CONTEXT_LENGTH + MESSAGE_MARKER.__len__() + 1) * " "
 
-expected_op_h = h.Literal[": ", "=", "!=", ">=", "<="]
+expected_op_h = h.Literal[":", ": ", "=", "!=", ">=", "<="]
 EXPECTED_OP: tuple[str, ...] = h.get_args(expected_op_h)
 
 """

logger_36/task/format/message.py

@@ -4,6 +4,7 @@ Contributor(s): Eric Debreuve (eric.debreuve@cnrs.fr) since 2023
 SEE COPYRIGHT NOTICE BELOW
 """
 
+import difflib as diff
 import typing as h
 
 from logger_36.config.message import (
@@ -14,7 +15,7 @@ from logger_36.config.message import (
     MESSAGE_MARKER,
 )
 from logger_36.constant.generic import NOT_PASSED
-from logger_36.constant.message import EXPECTED_OP, expected_op_h
+from logger_36.constant.message import expected_op_h
 
 
 def MessageFormat(with_where: bool, with_memory_usage: bool, /) -> str:
@@ -40,19 +41,11 @@ def FormattedMessage(
     *,
     actual: h.Any = NOT_PASSED,
     expected: h.Any | None = None,
+    expected_is_choices: bool = False,
     expected_op: expected_op_h = "=",
     with_final_dot: bool = True,
 ) -> str:
     """"""
-    if expected_op not in EXPECTED_OP:
-        raise ValueError(
-            FormattedMessage(
-                'Invalid "expected" section operator',
-                actual=expected_op,
-                expected=f"One of {str(EXPECTED_OP)[1:-1]}",
-            )
-        )
-
     if actual is NOT_PASSED:
         if with_final_dot:
             if message[-1] != ".":
@@ -64,27 +57,35 @@ def FormattedMessage(
 
     if message[-1] == ".":
         message = message[:-1]
-    actual = _FormattedValue(actual)
-    expected = _FormattedValue(expected)
-
+    expected = _FormattedExpected(expected_op, expected, expected_is_choices, actual)
     if with_final_dot:
         dot = "."
     else:
         dot = ""
-    return f"{message}: Actual={actual}; Expected{expected_op}{expected}{dot}"
 
+    return f"{message}: Actual={actual}:{type(actual).__name__}; {expected}{dot}"
 
-def _FormattedValue(value: h.Any, /, *, should_format_str: bool = True) -> str:
-    """"""
-    if value is None:
-        return "None"
-
-    if isinstance(value, str):
-        if should_format_str:
-            return f'"{value}"'
-        return value
 
-    return str(value)
+def _FormattedExpected(
+    operator: str, expected: h.Any, expected_is_choices: bool, actual: h.Any, /
+) -> str:
+    """"""
+    if isinstance(expected, h.Sequence) and expected_is_choices:
+        close_matches = diff.get_close_matches(actual, expected)
+        if close_matches.__len__() > 0:
+            close_matches = ", ".join(close_matches)
+            return f"Close matche(s): {close_matches}"
+        else:
+            expected = ", ".join(map(str, expected))
+            return f"Valid values: {expected}"
+    else:
+        if operator == "=":
+            stripe = f":{type(expected).__name__}"
+        else:
+            stripe = ""
+            if operator == ":":
+                operator = ": "
+        return f"Expected{operator}{expected}{stripe}"
 
 
 """

logger_36/task/format/rule.py

@@ -5,18 +5,24 @@ SEE COPYRIGHT NOTICE BELOW
 """
 
 
-def RuleAsText(text: str, /) -> str:
+def RuleAsText(text: str | None, /) -> str:
     """"""
-    return f"---- ---- ---- ---- {text} ---- ---- ---- ----"
+    if text is None:
+        return "---- ---- ---- ---- ---- ---- ---- ---- ----"
+    else:
+        return f"---- ---- ---- ---- {text} ---- ---- ---- ----"
 
 
 try:
     from rich.rule import Rule as rule_t
     from rich.text import Text as text_t
 
-    def Rule(text: str, color: str, /) -> rule_t:
+    def Rule(text: str | None, color: str, /) -> rule_t | str:
         """"""
-        return rule_t(title=text_t(text, style=f"bold {color}"), style=color)
+        if text is None:
+            return rule_t(style=color)
+        else:
+            return rule_t(title=text_t(text, style=f"bold {color}"), style=color)
 
 except ModuleNotFoundError:
     Rule = lambda _txt, _: RuleAsText(_txt)

logger_36/type/issue.py

@@ -25,6 +25,7 @@ def NewIssue(
     level: int = lggg.ERROR,
     actual: h.Any = NOT_PASSED,
     expected: h.Any | None = None,
+    expected_is_choices: bool = False,
     expected_op: expected_op_h = "=",
     with_final_dot: bool = True,
 ) -> issue_t:
@@ -35,6 +36,7 @@ def NewIssue(
         message,
         actual=actual,
         expected=expected,
+        expected_is_choices=expected_is_choices,
         expected_op=expected_op,
         with_final_dot=with_final_dot,
     )

logger_36/type/logger.py

@@ -32,6 +32,7 @@ from logger_36.task.format.memory import (
     FormattedUsageWithAutoUnit as FormattedMemoryUsage,
 )
 from logger_36.task.format.message import FormattedMessage
+from logger_36.task.format.rule import Rule
 from logger_36.task.measure.chronos import ElapsedTime
 from logger_36.task.measure.memory import CurrentUsage as CurrentMemoryUsage
 from logger_36.type.issue import NewIssue, issue_t
@@ -42,12 +43,14 @@ class logger_t(lggg.Logger):
     name_: d.InitVar[str] = LOGGER_NAME
     level_: d.InitVar[int] = lggg.NOTSET
     activate_wrn_interceptions: d.InitVar[bool] = True
-    exit_on_error: bool = False  # Implies exit_on_critical.
-    exit_on_critical: bool = False
+
     # Must not be False until at least one handler has been added.
     should_hold_messages: bool = True
+    exit_on_error: bool = False  # Implies exit_on_critical.
+    exit_on_critical: bool = False
 
     on_hold: list[lggg.LogRecord] = d.field(init=False, default_factory=list)
+    events: dict[int, int] = d.field(init=False, default_factory=dict)
     last_message_date: str = d.field(init=False, default="")
     any_handler_shows_memory: bool = d.field(init=False, default=False)
     memory_usages: list[tuple[str, int]] = d.field(init=False, default_factory=list)
@@ -66,11 +69,19 @@ class logger_t(lggg.Logger):
         self.setLevel(level_)
         self.propagate = False  # Part of lggg.Logger.
 
+        for level in lggg.getLevelNamesMapping().values():
+            self.events[level] = 0
+
         if activate_wrn_interceptions:
             self._ActivateWarningInterceptions()
         if self.exit_on_error:
             self.exit_on_critical = True
 
+    def ResetEventCounts(self) -> None:
+        """"""
+        for level in self.events:
+            self.events[level] = 0
+
     def _ActivateWarningInterceptions(self) -> None:
         """
         The log message will not appear if called from __post_init__ since there are no
@@ -214,6 +225,7 @@ class logger_t(lggg.Logger):
         else:
             lggg.Logger.handle(self, record)
 
+        self.events[record.levelno] += 1
         if (self.exit_on_critical and (record.levelno is lggg.CRITICAL)) or (
             self.exit_on_error and (record.levelno is lggg.ERROR)
         ):
@@ -221,7 +233,30 @@ class logger_t(lggg.Logger):
             # __post_init__ set self.exit_on_critical if self.exit_on_error.
             sstm.exit(1)
 
-    def log_exception(
+    def Log(
+        self,
+        message: str,
+        /,
+        *,
+        level: int = lggg.ERROR,
+        actual: h.Any = NOT_PASSED,
+        expected: h.Any | None = None,
+        expected_is_choices: bool = False,
+        expected_op: expected_op_h = "=",
+        with_final_dot: bool = True,
+    ) -> None:
+        """"""
+        message = FormattedMessage(
+            message,
+            actual=actual,
+            expected=expected,
+            expected_is_choices=expected_is_choices,
+            expected_op=expected_op,
+            with_final_dot=with_final_dot,
+        )
+        self.log(level, message)
+
+    def LogException(
         self,
         exception: Exception,
         /,
@@ -236,11 +271,25 @@ class logger_t(lggg.Logger):
         else:
             # TODO: Explain:
             #     - Why it's not: "\n".join(lines)?
-            #     - Why adding excpetion name here and not when removing caller?
+            #     - Why adding exception name here and not when removing caller?
             formatted = "".join(lines)
             message = f"{type(exception).__name__}:\n{formatted}"
         self.log(level, message)
 
+    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:
+                ShowMessage(message)
+
+    def DisplayRule(self, /, *, text: str | None = None, color: str = "white") -> None:
+        """"""
+        self.ShowMessage(Rule(text, color))
+
     def AddContextLevel(self, new_level: str, /) -> None:
         """"""
         self.context_levels.append(new_level)
@@ -262,6 +311,7 @@ class logger_t(lggg.Logger):
         level: int = lggg.ERROR,
         actual: h.Any = NOT_PASSED,
         expected: h.Any | None = None,
+        expected_is_choices: bool = False,
         expected_op: expected_op_h = "=",
         with_final_dot: bool = False,
     ) -> None:
@@ -274,6 +324,7 @@ class logger_t(lggg.Logger):
             level=level,
             actual=actual,
             expected=expected,
+            expected_is_choices=expected_is_choices,
             expected_op=expected_op,
             with_final_dot=with_final_dot,
         )
@@ -335,16 +386,6 @@ class logger_t(lggg.Logger):
                 self.log(int(level), issue, stacklevel=2)
         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:
-                ShowMessage(message)
-
     def __enter__(self) -> None:
         """"""
         pass

logger_36/version.py

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

{logger_36-2024.22.dist-info → logger_36-2024.24.dist-info}/METADATA

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

@@ -5,10 +5,10 @@ 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=JPQbndmeGc-ytruoejhakNRfDt3ogZPJwu9ZkQINvwA,2206
+logger_36/version.py,sha256=R2K8-57Lahk2FjSCqX05d_TyRALChV-T1s0nHQifns8,2206
 logger_36/catalog/config/console_rich.py,sha256=QDkgSs3I7ZULvkd1q4J1hdvgyB857JJcJWxM9fdL51Y,2883
 logger_36/catalog/handler/console.py,sha256=SF9S3CUoEPp5dh7RrqotywDJjMgRp0rD9sO3eLVXnkA,4004
-logger_36/catalog/handler/console_rich.py,sha256=Ti1k2E1ox4egzicghTb9Wv30xiWaBbWwe8ouopJsujY,8792
+logger_36/catalog/handler/console_rich.py,sha256=uLZzVURQ6OIUuQEGMc142vJkEyxBbE0-HJJGQ_zOJcI,8914
 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
@@ -26,7 +26,7 @@ logger_36/constant/handler.py,sha256=HM8qCSEMGNMCzddjUUNBPGL-3d0qU-EmG5eW4ZQHW6A
 logger_36/constant/issue.py,sha256=01l8itRPWGS5F6gXtsXUJgGR-4lS1Eu3_YeKC-khKLw,2315
 logger_36/constant/logger.py,sha256=0GhemAQ_YBiRO5WQBuNTczuejyVu2IYCsgqPRIbL8es,2780
 logger_36/constant/memory.py,sha256=ZL1MwbdtNsrCrOwzEyfTsfOoOsRBTJtbbf3otHGnxXo,2343
-logger_36/constant/message.py,sha256=RKQL-YmEDds5q7HuHTeDebz7_h3zWDX0PNxu-RTwL2I,2714
+logger_36/constant/message.py,sha256=JMnCmW4j-oa-Cs1iZCJ5yAG6V4BzjLCGRIvEw6pQTtU,2719
 logger_36/constant/record.py,sha256=zebZYR4buX1lGfc7IyuvEh8zOpk7hx0aS4pJ12H0flI,2311
 logger_36/constant/system.py,sha256=G2mzBTxRXoJMxb53TnmBaceMJC_q3WonoCG7y6nC_R8,2430
 logger_36/instance/logger.py,sha256=ttKjl9MD7FUjqCWjv5w2hmmpDYxgaORcYf9NaaE9W_M,2246
@@ -34,15 +34,15 @@ logger_36/instance/loggers.py,sha256=RCWpC1NPAf6vXnFc9NqsSALv-x-FEzcH6k_OlxTxeQk
 logger_36/task/inspection.py,sha256=f9VkVrwMJ_ixV9rFu3XUNpmCbEgoo1tssqd2nMeGYLI,5028
 logger_36/task/storage.py,sha256=XaSeu-iBCa0N8HNpwCV7cLprj-lbOJocpTIKUgSOvsc,5668
 logger_36/task/format/memory.py,sha256=ECOdHjdxIqXivOwtcmwpLDMYUrutIeOTCn1L4d3-U8k,4241
-logger_36/task/format/message.py,sha256=X9qtXPxhXgCIjnRYBJn93vj4rW4I-7dJP6LaXD5Qu2o,4142
-logger_36/task/format/rule.py,sha256=YEe8wG_QLy9vRZqmT2bWlvKT-Dxp4pGaZVmEuwwODyE,2598
+logger_36/task/format/message.py,sha256=HuV8we1mqh7Xcd4vbwoC0mJ8f_PjtP4sX3WFM6W7Oew,4420
+logger_36/task/format/rule.py,sha256=M4a8uW7FEvMI9f4s32A9-DoP0WVlLkyXamGnqbzZ65A,2797
 logger_36/task/measure/chronos.py,sha256=t-y0bVm1SmF-3wI9pR9Bp6-qzVlsE94fZTZr5a_hZUA,2884
 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=5NCcDX8uTcp4Zd7HoRTYB2_f3RVjqHeDEavkssr6bg0,3114
-logger_36/type/logger.py,sha256=sH-eEEt3_kdYSTS4C3sLXA_pp-2MH-D_Bf6EDlJNY1E,15935
+logger_36/type/issue.py,sha256=Y7OCLCzVt6Yvkecwj8HXLdZjg33oMxexc9XkYHzUhh4,3202
+logger_36/type/logger.py,sha256=GClqeLtTCiItaIM0G29NNEETw765vA23npa4klOoydQ,17178
 logger_36/type/loggers.py,sha256=znqxWBnfQxvkg3VUfbTUvt3S6Kq0DAzWWepxQDt9suI,2871
-logger_36-2024.22.dist-info/METADATA,sha256=K5YZ0rA-ldUEqGnM3lMh09FzH9fmEY7gTZC7eWyTpcE,6276
-logger_36-2024.22.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
-logger_36-2024.22.dist-info/top_level.txt,sha256=sM95BTMWmslEEgR_1pzwZsOeSp8C_QBiu8ImbFr0XLc,10
-logger_36-2024.22.dist-info/RECORD,,
+logger_36-2024.24.dist-info/METADATA,sha256=B8cCu3tIwEJIFQ4nKmP-lP4AzaeBJCau_ns-bguXr-8,6276
+logger_36-2024.24.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+logger_36-2024.24.dist-info/top_level.txt,sha256=sM95BTMWmslEEgR_1pzwZsOeSp8C_QBiu8ImbFr0XLc,10
+logger_36-2024.24.dist-info/RECORD,,

{logger_36-2024.22.dist-info → logger_36-2024.24.dist-info}/WHEEL

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