Central logging.

Author: janiversen

pymodbus/__init__.py

@@ -3,29 +3,20 @@
 Released under the the BSD license
 """
 
-import logging as __logging
-from logging import NullHandler as __null
+from logging import WARNING
 
 import pymodbus.version as __version
+from pymodbus.logging import Log
 
 
 __version__ = __version.version.short()
 __author__ = "Galen Collins"
 __maintainer__ = "dhoomakethu, janiversen"
 
-# ---------------------------------------------------------------------------#
-#  Block unhandled logging
-# ---------------------------------------------------------------------------#
-__logging.getLogger(__name__).addHandler(__null())
 
-
-def pymodbus_apply_logging_config(level=__logging.WARNING):
+def pymodbus_apply_logging_config(level=WARNING):
     """Apply basic logging configuration used by default by Pymodbus maintainers.
 
     Please call this function to format logging appropriately when opening issues.
     """
-    __logging.basicConfig(
-        format="%(asctime)s %(levelname)-5s %(module)s:%(lineno)s %(message)s",
-        datefmt="%H:%M:%S",
-        level=level,
-    )
+    Log.apply_logging_config(level)

pymodbus/logging.py

@@ -0,0 +1,95 @@
+"""Pymodbus: Modbus Protocol Implementation.
+
+Released under the the BSD license
+"""
+
+import logging
+from logging import NullHandler as __null
+
+from pymodbus.utilities import hexlify_packets
+
+
+# ---------------------------------------------------------------------------#
+#  Block unhandled logging
+# ---------------------------------------------------------------------------#
+logging.getLogger(__name__).addHandler(__null())
+
+
+class Log:
+    """Class to hide logging complexity.
+
+    :meta private:
+    """
+
+    CRITICAL = logging.CRITICAL
+    ERROR = logging.ERROR
+    WARNING = logging.WARNING
+    DEBUG = logging.DEBUG
+    INFO = logging.INFO
+
+    LOG_LEVEL = logging.WARNING
+    _logger = logging.getLogger(__name__)
+
+    @classmethod
+    def apply_logging_config(cls, level=logging.WARNING):
+        """Apply basic logging configuration"""
+        logging.basicConfig(
+            format="%(asctime)s %(levelname)-5s %(module)s:%(lineno)s %(message)s",
+            datefmt="%H:%M:%S",
+        )
+        cls._logger.setLevel(level)
+        cls.LOG_LEVEL = level
+
+    @classmethod
+    def build_msg(cls, txt, *args):
+        """Build message."""
+        string_args = []
+        count_args = len(args) - 1
+        skip = False
+        for i in range(count_args + 1):
+            if skip:
+                skip = False
+                continue
+            if (
+                i < count_args
+                and isinstance(args[i + 1], str)
+                and args[i + 1][0] == ":"
+            ):
+                if args[i + 1] == ":hex":
+                    string_args.append(hexlify_packets(args[i]))
+                elif args[i + 1] == ":str":
+                    string_args.append(str(args[i]))
+                skip = True
+            else:
+                string_args.append(args[i])
+        return txt.format(*string_args)
+
+    @classmethod
+    def info(cls, txt, *args):
+        """Log info messagees."""
+        if logging.INFO >= cls.LOG_LEVEL:
+            cls._logger.info(cls.build_msg(txt, *args))
+
+    @classmethod
+    def debug(cls, txt, **args):
+        """Log debug messagees."""
+        if logging.DEBUG >= cls.LOG_LEVEL:
+            cls._logger.debug(cls.build_msg(txt, *args))
+
+    @classmethod
+    def warning(cls, txt, **args):
+        """Log warning messagees."""
+        if logging.WARNING >= cls.LOG_LEVEL:
+            cls._logger.warning(cls.build_msg(txt, *args))
+
+    @classmethod
+    def error(cls, txt, **args):
+        """Log error messagees."""
+        if logging.ERROR >= cls.LOG_LEVEL:
+            cls._logger.error(cls.build_msg(txt, *args))
+
+    @classmethod
+    def critical(cls, txt, **args):
+        """Log critical messagees."""
+        if logging.CRITICAL >= cls.LOG_LEVEL:
+            cls._logger.critical(cls.build_msg(txt, *args))

test/test_logging.py

@@ -0,0 +1,40 @@
+"""Test datastore."""
+import pytest
+
+from pymodbus import pymodbus_apply_logging_config
+from pymodbus.logging import Log
+
+
+class TestLogging:
+    """Tests of pymodbus logging."""
+
+    def test_log_our_default(self):
+        """Test default logging"""
+        pymodbus_apply_logging_config()
+        assert Log.LOG_LEVEL == Log.WARNING
+
+    def test_log_set_level(self):
+        """Test default logging"""
+        pymodbus_apply_logging_config(Log.DEBUG)
+        assert Log.LOG_LEVEL == Log.DEBUG
+        pymodbus_apply_logging_config(Log.INFO)
+        assert Log.LOG_LEVEL == Log.INFO
+
+    def test_log_simple(self):
+        """Test simple string"""
+        txt = "simple string"
+        log_txt = Log.build_msg(txt)
+        assert log_txt == txt
+
+    @pytest.mark.parametrize(
+        "txt, result, params",
+        [
+            ("string {} {} {}", "string 101 102 103", (101, 102, 103)),
+            ("string {}", "string 0x41 0x42 0x43 0x44", (b"ABCD", ":hex")),
+            ("string {}", "string 125", (125, ":str")),
+        ],
+    )
+    def test_log_parms(self, txt, result, params):
+        """Test string with parameters (old f-string)"""
+        log_txt = Log.build_msg(txt, *params)
+        assert log_txt == result