logger-36 2024.15__py3-none-any.whl → 2024.17__py3-none-any.whl

logger_36/catalog/handler/generic.py

@@ -1,52 +1,26 @@
-# Copyright CNRS/Inria/UniCA
-# 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.
-
-import dataclasses as dtcl
+"""
+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 typing as h
 
-from logger_36.catalog.config.console_rich import DATE_TIME_COLOR
-
 try:
+    from logger_36.catalog.config.console_rich import DATE_TIME_COLOR
+    from logger_36.catalog.handler.console_rich import console_rich_handler_t
     from rich.console import Console as console_t
     from rich.console import ConsoleOptions as console_options_t
     from rich.markup import escape as EscapedForRich
     from rich.terminal_theme import DEFAULT_TERMINAL_THEME
 except ModuleNotFoundError:
-    console_t = EscapedForRich = DEFAULT_TERMINAL_THEME = None
+    console_t = console_options_t = EscapedForRich = DEFAULT_TERMINAL_THEME = None
 
-from logger_36.catalog.handler.console_rich import console_rich_handler_t
 from logger_36.constant.record import SHOW_W_RULE_ATTR
 from logger_36.task.format.rule import Rule, RuleAsText
-from logger_36.type.extension import handler_extension_t
+from logger_36.type.handler import handler_extension_t
 
 
 class can_show_message_p(h.Protocol):
@@ -56,25 +30,25 @@ class can_show_message_p(h.Protocol):
 interface_h = can_show_message_p | h.Callable[[str], None]
 
 
-@dtcl.dataclass(slots=True, repr=False, eq=False)
+@d.dataclass(slots=True, repr=False, eq=False)
 class generic_handler_t(lggg.Handler):
 
-    extension: handler_extension_t = dtcl.field(init=False)
-    console: console_t | None = None
-    console_options: console_options_t | None = None
-    FormattedLines: h.Callable[..., tuple[str, str | None]] = dtcl.field(init=False)
+    extension: handler_extension_t = d.field(init=False)
+    console: console_t = None
+    console_options: console_options_t = None
+    FormattedLines: h.Callable[..., tuple[str, str | None]] = d.field(init=False)
     ShowMessage: h.Callable[[str], None] = lambda _arg: None
 
-    name: dtcl.InitVar[str | None] = None
-    level: dtcl.InitVar[int] = lggg.NOTSET
-    show_where: dtcl.InitVar[bool] = True
-    show_memory_usage: dtcl.InitVar[bool] = False
-    message_width: dtcl.InitVar[int] = -1
-    formatter: dtcl.InitVar[lggg.Formatter | None] = None
+    name: d.InitVar[str | None] = None
+    level: d.InitVar[int] = lggg.NOTSET
+    show_where: d.InitVar[bool] = True
+    show_memory_usage: d.InitVar[bool] = False
+    message_width: d.InitVar[int] = -1
+    formatter: d.InitVar[lggg.Formatter | None] = None
 
-    supports_html: dtcl.InitVar[bool] = False
-    rich_kwargs: dtcl.InitVar[dict[str, h.Any] | None] = None
-    interface: dtcl.InitVar[interface_h | None] = None  # Cannot be None actually.
+    supports_html: d.InitVar[bool] = False
+    rich_kwargs: d.InitVar[dict[str, h.Any] | None] = None
+    interface: d.InitVar[interface_h | None] = None  # Cannot be None actually.
 
     def __post_init__(
         self,
@@ -159,3 +133,50 @@ class generic_handler_t(lggg.Handler):
             )
 
         self.ShowMessage(message)
+
+
+"""
+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/catalog/logging/chronos.py

@@ -1,39 +1,62 @@
-# Copyright CNRS/Inria/UniCA
-# 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
+"""
 
 from logger_36.constant.logger import HIDE_WHERE_KWARG
-from logger_36.instance import LOGGER
+from logger_36.instance.logger import LOGGER
 from logger_36.task.measure.chronos import ElapsedTime
+from logger_36.type.logger import logger_t
 
 
-def LogElapsedTime() -> None:
+def LogElapsedTime(*, logger: logger_t = LOGGER) -> None:
     """"""
-    LOGGER.info(f"Elapsed Time: {ElapsedTime()}", **HIDE_WHERE_KWARG)
+    logger.info(f"Elapsed Time: {ElapsedTime()}", **HIDE_WHERE_KWARG)
+
+
+"""
+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/catalog/logging/exception.py

@@ -0,0 +1,74 @@
+"""
+Copyright CNRS/Inria/UniCA
+Contributor(s): Eric Debreuve (eric.debreuve@cnrs.fr) since 2023
+SEE COPYRIGHT NOTICE BELOW
+"""
+
+import traceback as tcbk
+
+from logger_36.instance.logger import LOGGER
+from logger_36.type.logger import logger_t
+
+
+def LogException(
+    exception: Exception,
+    /,
+    *,
+    logger: logger_t = LOGGER,
+    should_remove_caller: bool = False,
+) -> None:
+    """"""
+    lines = tcbk.format_exception(exception)
+    if should_remove_caller:
+        message = "\n".join(lines[:1] + lines[2:])
+    else:
+        formatted = "".join(lines)
+        message = f"{type(exception).__name__}:\n{formatted}"
+    logger.error(message)
+
+
+"""
+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/catalog/logging/gpu.py

@@ -1,39 +1,15 @@
-# Copyright CNRS/Inria/UniCA
-# 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 sys as sstm
 
 from logger_36.constant.error import GPU_LOGGING_ERROR
 from logger_36.constant.logger import HIDE_WHERE_KWARG
-from logger_36.instance import LOGGER
+from logger_36.instance.logger import LOGGER
+from logger_36.type.logger import logger_t
 
 try:
     import tensorflow as tsfl
@@ -45,7 +21,7 @@ except ModuleNotFoundError:
     _GPU_LOGGING_ERROR = GPU_LOGGING_ERROR
 
 
-def LogGPURelatedDetails() -> None:
+def LogGPURelatedDetails(*, logger: logger_t = LOGGER) -> None:
     """"""
     global _GPU_LOGGING_ERROR
 
@@ -56,7 +32,7 @@ def LogGPURelatedDetails() -> None:
         return
 
     system_details = tsfl.sysconfig.get_build_info()
-    LOGGER.info(
+    logger.info(
         f"GPU-RELATED DETAILS\n"
         f"                GPUs: {tsfl.config.list_physical_devices('GPU')}\n"
         f"                CPUs: {tsfl.config.list_physical_devices('CPU')}\n"
@@ -67,3 +43,50 @@ def LogGPURelatedDetails() -> None:
         f"            TensorRT: {tsrt.__version__}",
         **HIDE_WHERE_KWARG,
     )
+
+
+"""
+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/catalog/logging/memory.py

@@ -1,40 +1,16 @@
-# Copyright CNRS/Inria/UniCA
-# 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
+"""
 
 from logger_36.config.memory import LENGTH_100, MAX_N_SAMPLES
 from logger_36.constant.logger import HIDE_WHERE_KWARG
 from logger_36.constant.memory import storage_units_h
-from logger_36.instance import LOGGER
+from logger_36.instance.logger import LOGGER
 from logger_36.task.format.memory import FormattedUsage, UsageBar
 from logger_36.task.format.message import FormattedMessage
+from logger_36.type.logger import logger_t
 
 
 def LogMemoryUsages(
@@ -43,14 +19,15 @@ def LogMemoryUsages(
     decimals: int = None,
     max_n_samples: int | None = MAX_N_SAMPLES,
     length_100: int = LENGTH_100,
+    logger: logger_t = LOGGER,
 ) -> None:
     """"""
-    if not LOGGER.any_handler_shows_memory:
+    if not logger.any_handler_shows_memory:
         return
 
-    where_s, usages = zip(*LOGGER.memory_usages)
+    where_s, usages = zip(*logger.memory_usages)
 
-    where, max_usage = LOGGER.max_memory_usage_full
+    where, max_usage = logger.max_memory_usage_full
     value, unit = FormattedUsage(max_usage, unit=unit, decimals=decimals)
     title = f"Memory Usage: Max={value}{unit} near {where}\n"
 
@@ -88,18 +65,68 @@ def LogMemoryUsages(
         )
     plot = "\n".join(plot)
 
-    LOGGER.info(title + plot, **HIDE_WHERE_KWARG)
+    logger.info(title + plot, **HIDE_WHERE_KWARG)
 
 
 def LogMaximumMemoryUsage(
-    *, unit: storage_units_h | None = "a", decimals: int = None
+    *,
+    unit: storage_units_h | None = "a",
+    decimals: int = None,
+    logger: logger_t = LOGGER,
 ) -> None:
     """
     unit: b or None=bytes, k=kilo, m=mega, g=giga, a=auto
     """
-    if LOGGER.any_handler_shows_memory:
-        where, max_usage = LOGGER.max_memory_usage_full
+    if logger.any_handler_shows_memory:
+        where, max_usage = logger.max_memory_usage_full
         value, unit = FormattedUsage(max_usage, unit=unit, decimals=decimals)
-        LOGGER.info(
+        logger.info(
             f"Max. Memory Usage: {value}{unit} near {where}", **HIDE_WHERE_KWARG
         )
+
+
+"""
+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/
+"""