logger-36 2023.13__py3-none-any.whl → 2025.3__py3-none-any.whl

logger_36/task/format/message.py

@@ -0,0 +1,111 @@
+"""
+Copyright CNRS/Inria/UniCA
+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.constant.generic import NOT_PASSED
+from logger_36.constant.message import expected_op_h
+
+
+def MessageWithActualExpected(
+    message: str,
+    /,
+    *,
+    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 actual is NOT_PASSED:
+        if with_final_dot:
+            if message[-1] != ".":
+                message += "."
+        elif message[-1] == ".":
+            message = message[:-1]
+
+        return message
+
+    if message[-1] == ".":
+        message = message[:-1]
+    expected = _FormattedExpected(expected_op, expected, expected_is_choices, actual)
+    if with_final_dot:
+        dot = "."
+    else:
+        dot = ""
+
+    return f"{message}: Actual={actual}:{type(actual).__name__}; {expected}{dot}"
+
+
+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}"
+
+
+"""
+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/
+"""

logger_36/task/format/rule.py

@@ -0,0 +1,74 @@
+"""
+Copyright CNRS/Inria/UniCA
+Contributor(s): Eric Debreuve (eric.debreuve@cnrs.fr) since 2023
+SEE COPYRIGHT NOTICE BELOW
+"""
+
+
+def RuleAsText(text: str | None, /) -> str:
+    """"""
+    if text is None:
+        return "---- ---- ---- ---- ---- ---- ---- ---- ----"
+    else:
+        return f"---- ---- ---- ---- {text} ---- ---- ---- ----"
+
+
+try:
+    from rich.rule import Rule as rule_t  # noqa
+    from rich.text import Text as text_t  # noqa
+
+    def Rule(text: str | None, color: str, /) -> rule_t | str:
+        """"""
+        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)
+
+"""
+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/
+"""

logger_36/task/inspection.py

@@ -1,33 +1,8 @@
-# Copyright CNRS/Inria/UCA
-# Contributor(s): Eric Debreuve (since 2023)
-#
-# eric.debreuve@cnrs.fr
-#
-# 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.
+"""
+Copyright CNRS/Inria/UniCA
+Contributor(s): Eric Debreuve (eric.debreuve@cnrs.fr) since 2023
+SEE COPYRIGHT NOTICE BELOW
+"""
 
 import importlib.metadata as mprt
 import pkgutil as pkgs
@@ -36,14 +11,15 @@ from types import FunctionType, MethodType
 
 
 def Modules(
-    with_version: bool, formatted: bool, /, *, only_loaded: bool = True
+    with_version: bool, formatted: bool, /, *, only_loaded: bool = True, indent: int = 0
 ) -> tuple[str, ...] | str:
     """"""
     output = []
 
     if only_loaded:
         modules = sstm.modules
-        module_names = sorted(modules.keys(), key=str.lower)
+        module_names = set(modules.keys()).difference(sstm.stdlib_module_names)
+        module_names = sorted(module_names, key=str.lower)
     else:
         modules = None
         module_names = _ModulesUsingPkgUtil()
@@ -53,35 +29,34 @@ def Modules(
         if name.startswith("_") or ("." in name):
             continue
 
-        if modules is None:
-            version = "?version?"
-        else:
-            module = modules[name]
-            version = getattr(module, "__version__", None)
-            if version is None:
-                continue
-
-        if formatted and (m_idx > 0) and (m_idx % 4 == 0):
-            output.append("\n")
-
         if with_version:
+            if modules is None:
+                version = "?"
+            else:
+                module = modules[name]
+                # strip: Some packages have a \n at the end of their version. Just in
+                # case, let's strip it left and right.
+                version = getattr(module, "__version__", "?").strip()
             element = f"{name}={version}"
         else:
             element = name
+
+        if formatted and (m_idx > 0) and (m_idx % 4 == 0):
+            output.append("\n")
         output.append(element)
 
         if formatted:
-            max_length = max(max_length, name.__len__() + version.__len__() + 1)
+            max_length = max(max_length, element.__len__())
             m_idx += 1
 
     if formatted:
         max_length += 4
-        AlignedInColumns = (
-            lambda _str: f"{_str:{max_length}}" if _str != "\n" else "\n    "
-        )
+        AlignedInColumns = lambda _str: f"{_str:{max_length}}" if _str != "\n" else "\n"
         output = map(AlignedInColumns, output)
+        output = "".join(output).rstrip()
 
-        return "".join(output)
+        spaces = indent * " "
+        return spaces + f"\n{spaces}".join(map(str.rstrip, output.splitlines()))
 
     return tuple(output)
 
@@ -125,3 +100,50 @@ def _ModulesUsingImportlib() -> tuple[str, ...]:
             if (_elm[0] != "_") and ("__" not in _elm) and ("/" not in _elm)
         )
     )
+
+
+"""
+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/
+"""

logger_36/task/measure/chronos.py

@@ -0,0 +1,84 @@
+"""
+Copyright CNRS/Inria/UniCA
+Contributor(s): Eric Debreuve (eric.debreuve@cnrs.fr) since 2023
+SEE COPYRIGHT NOTICE BELOW
+"""
+
+import time
+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 = date_time_t.now()
+
+
+def TimeStamp(*, precision: str = "microseconds") -> str:
+    """"""
+    return (
+        date_time_t.now()
+        .isoformat(timespec=precision)
+        .replace(".", "-")
+        .replace(":", "-")
+    )
+
+
+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()
+    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
+
+
+"""
+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/
+"""

logger_36/task/measure/memory.py

@@ -0,0 +1,72 @@
+"""
+Copyright CNRS/Inria/UniCA
+Contributor(s): Eric Debreuve (eric.debreuve@cnrs.fr) since 2023
+SEE COPYRIGHT NOTICE BELOW
+"""
+
+try:
+    from psutil import Process as process_t  # noqa
+
+    _PROCESS = process_t()
+except ModuleNotFoundError:
+    _PROCESS = None
+
+
+def CanCheckUsage() -> bool:
+    """"""
+    return _PROCESS is not None
+
+
+def CurrentUsage() -> int:
+    """"""
+    if _PROCESS is None:
+        return -1
+
+    return _PROCESS.memory_info().rss
+
+
+"""
+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/
+"""

logger_36/task/storage.py

@@ -0,0 +1,164 @@
+"""
+Copyright CNRS/Inria/UniCA
+Contributor(s): Eric Debreuve (eric.debreuve@cnrs.fr) since 2023
+SEE COPYRIGHT NOTICE BELOW
+"""
+
+import dataclasses as d
+import logging as lggg
+import re as regx
+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 rich.console import Console as console_t  # noqa
+except ModuleNotFoundError:
+    console_t = None
+
+from logger_36.instance.logger import LOGGER
+
+_BODY_END_PATTERN = r"</[bB][oO][dD][yY]>(.|\n)*$"
+
+
+@d.dataclass(slots=True, repr=False, eq=False)
+class html_reader_t(html_parser_t):
+    source: str = ""
+    inside_body: bool = d.field(init=False, default=False)
+    body_position_start: tuple[int, int] = d.field(init=False, default=(-1, -1))
+    body_position_end: tuple[int, int] = d.field(init=False, default=(-1, -1))
+    pieces: list[str] = d.field(init=False, default_factory=list)
+
+    def __post_init__(self) -> None:
+        """"""
+        html_parser_t.__init__(self)
+        self.source = self.source.strip()
+        self.feed(self.source)
+
+    def handle_starttag(self, tag: str, attrs: list[tuple[str, str | None]], /) -> None:
+        """"""
+        if tag == "body":
+            self.body_position_start = self.getpos()
+            self.inside_body = True
+
+    def handle_endtag(self, tag: str, /) -> None:
+        """"""
+        if tag == "body":
+            self.body_position_end = self.getpos()
+            self.inside_body = False
+
+    def handle_data(self, data: str, /) -> None:
+        """"""
+        if self.inside_body:
+            self.pieces.append(data)
+
+    @property
+    def body(self) -> str:
+        """"""
+        output = self.source.splitlines()
+        output = "\n".join(
+            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)
+
+        return output.strip()
+
+    @property
+    def body_as_text(self) -> str:
+        """"""
+        return "".join(self.pieces).strip()
+
+
+def SaveLOGasHTML(path: str | path_t | io_base_t | None = None) -> None:
+    """
+    From first console handler found.
+    """
+    cannot_save = "Cannot save logging record as HTML"
+
+    if console_t is None:
+        LOGGER.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):
+                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.")
+            return
+        if path.exists():
+            LOGGER.warning(
+                f'{cannot_save}: Automatically generated path "{path}" already exists.'
+            )
+            return
+    elif isinstance(path, str):
+        path = path_t(path)
+
+    actual_file = isinstance(path, path_t)
+    if actual_file and path.exists():
+        LOGGER.warning(f'{cannot_save}: File "{path}" already exists.')
+        return
+
+    for handler in LOGGER.handlers:
+        console = getattr(handler, "console", None)
+        if isinstance(console, console_t) and console.record:
+            html = console.export_html()
+            if actual_file:
+                with open(path, "w") as accessor:
+                    accessor.write(html)
+            else:
+                path.write(html)
+            break
+    else:
+        LOGGER.warning(
+            f"{cannot_save}: No handler has a RICH console with recording ON."
+        )
+
+
+"""
+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/
+"""