logger-36 2024.22__tar.gz → 2024.23__tar.gz

{logger_36-2024.22 → logger_36-2024.23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: logger-36
-Version: 2024.22
+Version: 2024.23
 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 → logger_36-2024.23}/package/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-2024.22 → logger_36-2024.23}/package/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 (
@@ -40,6 +41,7 @@ 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:
@@ -64,27 +66,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}"
-
 
-def _FormattedValue(value: h.Any, /, *, should_format_str: bool = True) -> str:
-    """"""
-    if value is None:
-        return "None"
+    return f"{message}: Actual={actual}:{type(actual).__name__}; {expected}{dot}"
 
-    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-2024.22 → logger_36-2024.23}/package/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-2024.22 → logger_36-2024.23}/package/logger_36/type/logger.py

@@ -221,7 +221,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,7 +259,7 @@ 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)
@@ -262,6 +285,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 +298,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,
         )

{logger_36-2024.22 → logger_36-2024.23}/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.22"
+__version__ = "2024.23"
 
 """
 COPYRIGHT NOTICE

{logger_36-2024.22 → logger_36-2024.23}/package/logger_36.egg-info/PKG-INFO

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