pmt4api 1.0.0__py3-none-any.whl

pmt4api/diagnostics.py

@@ -0,0 +1,38 @@
+"""Route the core's own diagnostics into Python's ``logging``."""
+from __future__ import annotations
+
+import logging
+from typing import Any, Callable
+
+from . import _runtime
+
+_LEVELS = {"Trace": logging.DEBUG, "Debug": logging.DEBUG, "Info": logging.INFO, "Warn": logging.WARNING,
+           "Error": logging.ERROR, "Exception": logging.ERROR}
+
+
+def enable_core_logging(logger_name: str = "pmt4api.core") -> Callable[[], None]:
+    """Forward the core's log messages (``Logger.OnMsgEx``) and internal diagnostics (``Diag.Sink``) to the Python
+    logger ``logger_name``. Returns a function that switches it off again. Nothing is forwarded unless this is called,
+    and the core is silent by default."""
+    core = _runtime.load()
+    import System  # noqa: PLC0415
+    logger = logging.getLogger(logger_name)
+
+    def on_msg(sender: Any, msg: Any, kind: Any, ex: Any = None) -> None:
+        level = _LEVELS.get(str(kind), logging.INFO)
+        if logger.isEnabledFor(level):
+            logger.log(level, "%s%s", msg, (" | %s" % ex.Message) if ex is not None else "")
+
+    def on_diag(message: Any) -> None:
+        if logger.isEnabledFor(logging.DEBUG):
+            logger.debug("%s", message)
+
+    core.Logger.OnMsgEx += on_msg
+    sink = System.Action[System.String](on_diag)
+    previous = core.Diag.Sink
+    core.Diag.Sink = sink
+
+    def disable() -> None:
+        core.Logger.OnMsgEx -= on_msg
+        core.Diag.Sink = previous
+    return disable