python-swidget 1.4.16__tar.gz → 1.4.17__tar.gz

{python_swidget-1.4.16 → python_swidget-1.4.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-swidget
-Version: 1.4.16
+Version: 1.4.17
 Summary: Python API for Swidget smart devices
 Home-page: https://github.com/swidget/python-swidget
 License: GPL-3.0-or-later

{python_swidget-1.4.16 → python_swidget-1.4.17}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-swidget"
-version = "1.4.16"
+version = "1.4.17"
 description = "Python API for Swidget smart devices"
 license = "GPL-3.0-or-later"
 authors = ["Swidget"]

{python_swidget-1.4.16 → python_swidget-1.4.17}/swidget/swidgetdevice.py

@@ -1004,14 +1004,27 @@ class SwidgetAssembly:
 class SwidgetComponent:
     """Component-level representation of a Swidget Assembly.
 
-    Carries the function-state map plus the optional summary-level
-    fields fan hosts emit alongside ``functions`` (``maxCFM``, ``code``,
-    ``modules``). Non-fan components don't populate them and they stay
-    at their defaults.
+    ``summary_functions`` is the immutable list of function tags the
+    device declared in its summary — this is the schema. ``functions``
+    starts as a same-keyed dict of placeholder ``None`` values and is
+    later mutated by ``process_state`` to carry live datapoint values.
+
+    Process_state also leaks in keys that aren't in the summary
+    functions list (e.g. fans emit a ``modules`` map in state that
+    isn't a declared function tag), so ``functions.keys()`` is *not*
+    schema-stable across summary refreshes. Anything that needs a
+    stable schema fingerprint (entity wiring, structure-change
+    detection) must read ``summary_functions``, not ``functions``.
+
+    ``max_cfm``, ``model_code`` and ``modules`` come from the optional
+    summary-level fields fan hosts emit alongside ``functions`` —
+    non-fan components don't populate them.
     """
 
     def __init__(self, component):
-        self.functions = {f: None for f in component.get("functions", [])}
+        funcs = list(component.get("functions", []))
+        self.summary_functions: tuple[str, ...] = tuple(funcs)
+        self.functions = {f: None for f in funcs}
         self.max_cfm = component.get("maxCFM")
         self.model_code = component.get("code")
         self.modules = list(component.get("modules", []))