dScriptModule 3.5.0__tar.gz → 3.5.1__tar.gz

{dscriptmodule-3.5.0 → dscriptmodule-3.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dScriptModule
-Version: 3.5.0
+Version: 3.5.1
 Summary: Home Assistant ready python module for dScript boards (by Robot-Electronics / Devantech Ltd.) with CUSTOM app firmware
 Home-page: https://github.com/mk-maddin/dScriptModule
 Author: Martin Kraemer

{dscriptmodule-3.5.0 → dscriptmodule-3.5.1}/dScriptModule/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "3.5.0"
+__version__ = "3.5.1"
 
 from .dScriptObject import *
 from .dScriptServer import *

{dscriptmodule-3.5.0 → dscriptmodule-3.5.1}/dScriptModule/dScriptBoard.py

@@ -704,7 +704,7 @@ class dScriptBoard(dScriptObject):
             databytes=self._ToDataBytes(data)
             return self.__CheckSet(self._ToDataBytes(data)[0])
         except Exception as e:
-            _LOGGER.error("dScriptBoard - %s: async_SetLight failed: %s (%s.%s)", str(e), e.__class__.__module__, type(e).__name__)
+            _LOGGER.error("dScriptBoard - %s: async_SetLight failed: %s (%s.%s)", self.friendlyname, str(e), e.__class__.__module__, type(e).__name__)
 
     '''Execute the SH, SetShutter command to define a shutter status'''
     def SetShutter(self,identifier,state) -> None | bool:

{dscriptmodule-3.5.0 → dscriptmodule-3.5.1}/dScriptModule.egg-info/SOURCES.txt

@@ -9,4 +9,5 @@ dScriptModule/dScriptObject.py
 dScriptModule/dScriptServer.py
 dScriptModule/dScriptVirtualBoard.py
 tests/test_board.py
+tests/test_logging_calls.py
 tests/test_server_events.py

dscriptmodule-3.5.1/tests/test_logging_calls.py

@@ -0,0 +1,31 @@
+"""Every logging call must have as many arguments as its format string has placeholders.
+
+A mismatch only shows up when the message is formatted (e.g. with debug logging enabled) - pytest then raises,
+in production the log line is lost. This already broke board setup once (10 placeholders, 9 arguments).
+"""
+import ast
+import os
+import re
+
+ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
+LEVELS = {"debug", "info", "warning", "error", "exception", "critical"}
+PLACEHOLDER = re.compile(r"%(?!%)[-#0 +]*\d*(?:\.\d+)?[sdifrx]")
+
+
+def test_logging_placeholders_match_arguments():
+    mismatches = []
+    for base, _dirs, files in os.walk(os.path.join(ROOT, "dScriptModule")):
+        for name in files:
+            if not name.endswith(".py"):
+                continue
+            path = os.path.join(base, name)
+            with open(path, encoding="utf-8") as fh:
+                tree = ast.parse(fh.read(), path)
+            for node in ast.walk(tree):
+                if (isinstance(node, ast.Call) and isinstance(node.func, ast.Attribute) and node.func.attr in LEVELS
+                        and node.args and isinstance(node.args[0], ast.Constant) and isinstance(node.args[0].value, str)):
+                    need = len(PLACEHOLDER.findall(node.args[0].value))
+                    have = len(node.args) - 1
+                    if need != have:
+                        mismatches.append("%s:%s: %s placeholders, %s arguments" % (os.path.relpath(path, ROOT), node.lineno, need, have))
+    assert mismatches == []