logger-36 2024.27__py3-none-any.whl → 2024.29__py3-none-any.whl

logger_36/handler.py

@@ -6,12 +6,11 @@ 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
+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
 
@@ -28,14 +27,13 @@ except ModuleNotFoundError:
 
 
 def AddGenericHandler(
-    ShowMessage: h.Callable[[str], None],
+    ShowMessage: show_message_p,
     /,
     *,
     logger: lggg.Logger | None = None,
     name: str | None = None,
     level: int = lggg.INFO,
-    show_where: bool = True,
-    show_memory_usage: bool = False,
+    should_store_memory_usage: bool = False,
     message_width: int = -1,
     formatter: lggg.Formatter | None = None,
     supports_html: bool = False,
@@ -51,8 +49,7 @@ def AddGenericHandler(
     handler = generic_handler_t(
         name=name,
         level=level,
-        show_where=show_where,
-        show_memory_usage=show_memory_usage,
+        should_store_memory_usage=should_store_memory_usage,
         message_width=message_width,
         formatter=formatter,
         supports_html=supports_html,
@@ -69,8 +66,7 @@ def AddConsoleHandler(
     logger: lggg.Logger | None = None,
     name: str | None = None,
     level: int = lggg.INFO,
-    show_where: bool = True,
-    show_memory_usage: bool = False,
+    should_store_memory_usage: bool = False,
     message_width: int = -1,
     formatter: lggg.Formatter | None = None,
     should_hold_messages: bool = False,
@@ -82,8 +78,7 @@ def AddConsoleHandler(
     handler = console_handler_t(
         name=name,
         level=level,
-        show_where=show_where,
-        show_memory_usage=show_memory_usage,
+        should_store_memory_usage=should_store_memory_usage,
         message_width=message_width,
         formatter=formatter,
     )
@@ -95,8 +90,7 @@ def AddRichConsoleHandler(
     logger: lggg.Logger | None = None,
     name: str | None = None,
     level: int = lggg.INFO,
-    show_where: bool = True,
-    show_memory_usage: bool = False,
+    should_store_memory_usage: bool = False,
     message_width: int = -1,
     formatter: lggg.Formatter | None = None,
     alternating_lines: int = 2,
@@ -126,8 +120,7 @@ def AddRichConsoleHandler(
     handler = console_rich_handler_t(
         name=name,
         level=level,
-        show_where=show_where,
-        show_memory_usage=show_memory_usage,
+        should_store_memory_usage=should_store_memory_usage,
         message_width=message_width,
         formatter=formatter,
         **additional_s,
@@ -142,8 +135,7 @@ def AddFileHandler(
     logger: lggg.Logger | None = None,
     name: str | None = None,
     level: int = lggg.INFO,
-    show_where: bool = True,
-    show_memory_usage: bool = False,
+    should_store_memory_usage: bool = False,
     message_width: int = -1,
     formatter: lggg.Formatter | None = None,
     should_hold_messages: bool = False,
@@ -160,8 +152,7 @@ def AddFileHandler(
     handler = file_handler_t(
         name=name,
         level=level,
-        show_where=show_where,
-        show_memory_usage=show_memory_usage,
+        should_store_memory_usage=should_store_memory_usage,
         message_width=message_width,
         formatter=formatter,
         path=path,

logger_36/task/format/memory.py

@@ -5,7 +5,7 @@ SEE COPYRIGHT NOTICE BELOW
 """
 
 from logger_36.constant.memory import STORAGE_UNITS, storage_units_h
-from logger_36.task.format.message import FormattedMessage
+from logger_36.task.format.message import MessageWithActualExpected
 
 _KILO_UNIT = 1000.0
 _MEGA_UNIT = _KILO_UNIT * 1000.0
@@ -41,7 +41,7 @@ def FormattedUsage(
         value, unit = FormattedUsageWithAutoUnit(usage, decimals)
     else:
         raise ValueError(
-            FormattedMessage(
+            MessageWithActualExpected(
                 "Invalid unit", actual=unit, expected=str(STORAGE_UNITS)[1:-1]
             )
         )

logger_36/task/format/message.py

@@ -7,35 +7,11 @@ SEE COPYRIGHT NOTICE BELOW
 import difflib as diff
 import typing as h
 
-from logger_36.config.message import (
-    ELAPSED_TIME_FORMAT,
-    LEVEL_CLOSING,
-    LEVEL_OPENING,
-    MEMORY_FORMAT,
-    MESSAGE_MARKER,
-)
 from logger_36.constant.generic import NOT_PASSED
 from logger_36.constant.message import expected_op_h
 
 
-def MessageFormat(with_where: bool, with_memory_usage: bool, /) -> str:
-    """"""
-    output = [
-        f"%(asctime)s"
-        f"{LEVEL_OPENING}%(level_first_letter)s{LEVEL_CLOSING}\t"
-        f"{MESSAGE_MARKER}%(message)s"
-    ]
-
-    if with_where:
-        output.append("%(where)s")
-    output.append(ELAPSED_TIME_FORMAT)
-    if with_memory_usage:
-        output.append(MEMORY_FORMAT)
-
-    return "".join(output)
-
-
-def FormattedMessage(
+def MessageWithActualExpected(
     message: str,
     /,
     *,

logger_36/task/measure/chronos.py

@@ -5,25 +5,35 @@ SEE COPYRIGHT NOTICE BELOW
 """
 
 import time
-from datetime import datetime as dttm
+from datetime import datetime as date_time_t
 
 # This module is imported early. Therefore, the current date and time should be close
 # enough to the real start time of the main script.
-_START_DATE_AND_TIME = dttm.now()
+_START_DATE_AND_TIME = date_time_t.now()
 
 
 def TimeStamp(*, precision: str = "microseconds") -> str:
     """"""
-    return dttm.now().isoformat(timespec=precision).replace(".", "-").replace(":", "-")
+    return (
+        date_time_t.now()
+        .isoformat(timespec=precision)
+        .replace(".", "-")
+        .replace(":", "-")
+    )
 
 
-def ElapsedTime() -> str:
+def ElapsedTime(
+    *, should_return_now: bool = False
+) -> str | tuple[str, date_time_t.date]:
     """"""
-    elapsed_seconds = (dttm.now() - _START_DATE_AND_TIME).total_seconds()
-    output = time.strftime("%Hh %Mm %Ss", time.gmtime(elapsed_seconds))
-    while output.startswith("00") and (" " in output):
-        output = output.split(maxsplit=1)[-1]
-
+    now = date_time_t.now()
+    elapsed_seconds = (now - _START_DATE_AND_TIME).total_seconds()
+    output = time.strftime("%H:%M:%S", time.gmtime(elapsed_seconds))
+    while output.startswith("00:"):
+        output = output.split(sep=":", maxsplit=1)[-1]
+
+    if should_return_now:
+        return output, now
     return output
 
 

logger_36/type/handler.py

@@ -8,15 +8,17 @@ import dataclasses as d
 import logging as lggg
 import sys as sstm
 import typing as h
-from os import sep as FOLDER_SEPARATOR
-from pathlib import Path as path_t
 
-from logger_36.config.message import TIME_FORMAT, WHERE_FORMAT
+from logger_36.config.message import (
+    LEVEL_CLOSING,
+    LEVEL_OPENING,
+    MESSAGE_MARKER,
+    WHERE_SEPARATOR,
+)
 from logger_36.constant.error import MEMORY_MEASURE_ERROR
 from logger_36.constant.handler import HANDLER_CODES
 from logger_36.constant.message import NEXT_LINE_PROLOGUE
-from logger_36.constant.record import HIDE_WHERE_ATTR, SHOW_WHERE_ATTR
-from logger_36.task.format.message import FormattedMessage, MessageFormat
+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
 
@@ -26,10 +28,9 @@ _MEMORY_MEASURE_ERROR = MEMORY_MEASURE_ERROR
 @d.dataclass(slots=True, repr=False, eq=False)
 class handler_extension_t:
     name: str | None = None
-    show_where: bool = True
-    show_memory_usage: bool = False
+    should_store_memory_usage: bool = False
     message_width: int = -1
-    FormattedRecord: h.Callable[[lggg.LogRecord], str] = d.field(init=False)
+    MessageFromRecord: h.Callable[..., str] = d.field(init=False)
 
     handler: d.InitVar[lggg.Handler | None] = None
     level: d.InitVar[int] = lggg.NOTSET
@@ -43,7 +44,7 @@ class handler_extension_t:
 
         if self.name in HANDLER_CODES:
             raise ValueError(
-                FormattedMessage(
+                MessageWithActualExpected(
                     "Invalid handler name",
                     actual=self.name,
                     expected=f"a name not in {str(HANDLER_CODES)[1:-1]}",
@@ -53,8 +54,8 @@ class handler_extension_t:
         if self.name is None:
             self.name = TimeStamp()
 
-        if self.show_memory_usage and not CanCheckMemoryUsage():
-            self.show_memory_usage = False
+        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)
                 _MEMORY_MEASURE_ERROR = None
@@ -64,85 +65,45 @@ class handler_extension_t:
         if 0 < self.message_width < 5:
             self.message_width = 5
         if formatter is None:
-            message_format = MessageFormat(self.show_where, self.show_memory_usage)
-            formatter = lggg.Formatter(fmt=message_format, datefmt=TIME_FORMAT)
-        handler.setFormatter(formatter)
-        self.FormattedRecord = handler.formatter.format
+            self.MessageFromRecord = self._MessageFromRecord
+        else:
+            handler.setFormatter(formatter)
+            self.MessageFromRecord = handler.formatter.format
 
-    def FormattedLines(
+    def _MessageFromRecord(
         self,
         record: lggg.LogRecord,
         /,
         *,
         PreProcessed: h.Callable[[str], str] | None = None,
-        should_join_lines: bool = False,
-    ) -> tuple[str, str | None]:
+    ) -> str:
         """
         See logger_36.catalog.handler.README.txt.
         """
-        record.level_first_letter = record.levelname[0]
-
         message = record.msg
-        if not isinstance(message, str):
-            message = str(message)
-        original_message = message
 
         if PreProcessed is not None:
             message = PreProcessed(message)
-        if (has_newlines := ("\n" in message)) or (
-            (self.message_width > 0) and (message.__len__() > self.message_width)
-        ):
-            if has_newlines:
-                lines = message.splitlines()
-                if self.message_width > 0:
-                    lines = _WrappedLines(lines, self.message_width)
-            else:
-                lines = _WrappedLines([message], self.message_width)
-            next_lines = NEXT_LINE_PROLOGUE.join(lines[1:])
-            next_lines = f"{NEXT_LINE_PROLOGUE}{next_lines}"
-            message = lines[0]
+        if (self.message_width <= 0) or (message.__len__() <= self.message_width):
+            if "\n" in message:
+                message = NEXT_LINE_PROLOGUE.join(message.splitlines())
         else:
-            next_lines = None
-        if self.message_width > 0:
-            n_missing_s = self.message_width - message.__len__()
-            if n_missing_s > 3:
-                message += " " + (n_missing_s - 1) * "."
-            elif n_missing_s > 0:
-                message += n_missing_s * " "
-
-        record.msg = message
-        if self.show_where and not hasattr(record, SHOW_WHERE_ATTR):
-            hide_where = getattr(record, HIDE_WHERE_ATTR, False)
-            if hide_where:
-                record.where = ""
+            if "\n" in message:
+                lines = _WrappedLines(message.splitlines(), self.message_width)
             else:
-                module = path_t(record.pathname)
-                path_was_found = False
-                for path in sstm.path:
-                    if module.is_relative_to(path):
-                        module = module.relative_to(path)
-                        path_was_found = True
-                        break
-                if path_was_found:
-                    module = str(module.parent / module.stem)
-                    module = module.replace(FOLDER_SEPARATOR, ".")
-                else:
-                    module = record.module
-                record.where = WHERE_FORMAT.format(
-                    module=module, funcName=record.funcName, lineno=record.lineno
-                )
-        first_line = self.FormattedRecord(record).replace("\t", " ")
-
-        # Revert the record message to its original value for subsequent handlers.
-        record.msg = original_message
+                lines = _WrappedLines([message], self.message_width)
+            message = NEXT_LINE_PROLOGUE.join(lines)
 
-        if should_join_lines:
-            if next_lines is None:
-                return first_line, None
-            else:
-                return f"{first_line}{next_lines}", None
+        if (where := getattr(record, "where", None)) is None:
+            where = ""
         else:
-            return first_line, next_lines
+            where = f"{NEXT_LINE_PROLOGUE}{WHERE_SEPARATOR} {where}"
+
+        return (
+            f"{record.when_or_elapsed}"
+            f"{LEVEL_OPENING}{record.level_first_letter}{LEVEL_CLOSING} "
+            f"{MESSAGE_MARKER} {message}{where}"
+        )
 
 
 def _WrappedLines(lines: list[str], message_width: int, /) -> list[str]:

logger_36/type/issue.py

@@ -11,7 +11,7 @@ from logger_36.config.issue import ISSUE_BASE_CONTEXT
 from logger_36.constant.generic import NOT_PASSED
 from logger_36.constant.issue import ISSUE_LEVEL_SEPARATOR
 from logger_36.constant.message import expected_op_h
-from logger_36.task.format.message import FormattedMessage
+from logger_36.task.format.message import MessageWithActualExpected
 
 issue_t = str
 
@@ -32,7 +32,7 @@ def NewIssue(
     """"""
     if context.__len__() == 0:
         context = ISSUE_BASE_CONTEXT
-    message = FormattedMessage(
+    message = MessageWithActualExpected(
         message,
         actual=actual,
         expected=expected,