ebus-sdk 0.2.0__tar.gz → 0.2.2__tar.gz

{ebus_sdk-0.2.0/src/ebus_sdk.egg-info → ebus_sdk-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ebus-sdk
-Version: 0.2.0
+Version: 0.2.2
 Summary: Python SDK for Homie MQTT Convention (eBus)
 Author: Clark Communications Corporation
 License-Expression: MIT

{ebus_sdk-0.2.0 → ebus_sdk-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ebus-sdk"
-version = "0.2.0"
+version = "0.2.2"
 description = "Python SDK for Homie MQTT Convention (eBus)"
 readme = "README.md"
 requires-python = ">=3.10"

{ebus_sdk-0.2.0 → ebus_sdk-0.2.2}/src/ebus_sdk/__init__.py

@@ -28,6 +28,7 @@ from .homie import EBUS_HOMIE_MQTT_QOS, HOMIE_EFFECTIVE_STATE_TABLE
 from .homie import (
     datatype_from_type,
     ebus_cfg_add_auth,
+    sanitize_homie_id,
 )
 
 # Property abstractions
@@ -42,7 +43,7 @@ from .property import (
 # MQTT client
 from ebus_mqtt_client import MqttClient
 
-__version__ = "0.2.0"
+__version__ = "0.2.2"
 
 __all__ = [
     # Homie classes
@@ -62,6 +63,7 @@ __all__ = [
     # Utilities
     "datatype_from_type",
     "ebus_cfg_add_auth",
+    "sanitize_homie_id",
     # Property abstractions
     "ObservableProperty",
     "GroupedPropertyDict",

{ebus_sdk-0.2.0 → ebus_sdk-0.2.2}/src/ebus_sdk/homie.py

@@ -39,6 +39,7 @@ import asyncio
 import json
 import logging
 import os
+import re
 import time
 import uuid
 from enum import Enum
@@ -134,6 +135,40 @@ class PropertyDatatype(StrEnum):
     JSON = "json"
 
 
+def sanitize_homie_id(value: Optional[str]) -> str:
+    """Coerce an arbitrary string to a Homie-legal id segment (a-z, 0-9, -).
+
+    The Homie 5 spec requires device-ids and node/property ids to match
+    ``[a-z][a-z0-9-]*``. This helper coerces vendor-supplied strings
+    (serial numbers, model names, etc.) to a legal form by:
+
+      1. lowercasing
+      2. replacing underscores, whitespace, and dots with hyphens
+      3. dropping any other character outside ``[a-z0-9-]``
+      4. collapsing runs of hyphens
+      5. stripping leading/trailing hyphens
+
+    Empty input (``None`` or empty string) returns an empty string. The
+    caller is responsible for handling the empty-string case — e.g. by
+    falling back to a synthesized id when the sanitized form is empty,
+    or by raising if the value was required to be non-empty.
+
+    Composing device-ids from multiple vendor-supplied segments (e.g.
+    ``f"{panel_serial}-{bess_serial}"``) MUST apply this helper to each
+    segment independently, so that publisher and consumer always agree
+    on the resulting Homie-legal id. Composing first and sanitizing the
+    composite is not equivalent — a hyphen-joiner can be collapsed if an
+    adjacent segment ends/begins with characters that drop out.
+    """
+    if not value:
+        return ""
+    result = value.lower()
+    result = re.sub(r"[_\s.]+", "-", result)
+    result = re.sub(r"[^a-z0-9-]", "", result)
+    result = re.sub(r"-+", "-", result)
+    return result.strip("-")
+
+
 def datatype_from_type(type: Type) -> Optional[PropertyDatatype]:
     """
     Returns Homie PropertyDatatype from Python type
@@ -1386,7 +1421,9 @@ class Device:
             f"nodeCount={len(self._nodes)},childCount={len(self._children)}"
         )
         self._publish_self()
-        for child in self._children:
+        # Snapshot — main thread may construct child devices (which append
+        # to self._children) while this runs on the MQTT loop thread.
+        for child in list(self._children):
             child.refresh_tree()
 
     def publish(self, attribute: str = "", value: Optional[Any] = None) -> None:
@@ -1463,7 +1500,11 @@ class Device:
                 self.publish("$description")
 
     def publish_nodes(self) -> None:
-        for node in self._nodes.values():
+        # Snapshot — invoked from on_connect() on the MQTT loop thread while
+        # the main thread may be inside state_transition() calling add_node().
+        # Without the snapshot, dict-size-changed-during-iteration crashes the
+        # MQTT thread on initial connect.
+        for node in list(self._nodes.values()):
             node.publish()
 
     def on_connect(self) -> None:

{ebus_sdk-0.2.0 → ebus_sdk-0.2.2/src/ebus_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ebus-sdk
-Version: 0.2.0
+Version: 0.2.2
 Summary: Python SDK for Homie MQTT Convention (eBus)
 Author: Clark Communications Corporation
 License-Expression: MIT

{ebus_sdk-0.2.0 → ebus_sdk-0.2.2}/tests/test_homie_device.py

@@ -15,6 +15,7 @@ from ebus_sdk.homie import (
     Unit,
     datatype_from_type,
     ebus_cfg_add_auth,
+    sanitize_homie_id,
     EBUS_HOMIE_DOMAIN,
     EBUS_HOMIE_MQTT_QOS,
     EBUS_HOMIE_VERSION_MAJOR,
@@ -93,6 +94,61 @@ class TestDatatypeFromType:
         assert datatype_from_type(list) is None
 
 
+# ── sanitize_homie_id ────────────────────────────────────────────────────
+
+
+class TestSanitizeHomieId:
+    def test_empty_string(self):
+        assert sanitize_homie_id("") == ""
+
+    def test_none(self):
+        assert sanitize_homie_id(None) == ""
+
+    def test_already_legal(self):
+        assert sanitize_homie_id("device-1") == "device-1"
+
+    def test_lowercases(self):
+        # Tesla Powerwall serial — the real bug from G3P-23496
+        assert sanitize_homie_id("TG121153003K7G") == "tg121153003k7g"
+
+    def test_underscore_to_hyphen(self):
+        assert sanitize_homie_id("my_device_id") == "my-device-id"
+
+    def test_whitespace_to_hyphen(self):
+        assert sanitize_homie_id("my device id") == "my-device-id"
+
+    def test_dot_to_hyphen(self):
+        assert sanitize_homie_id("v1.2.3") == "v1-2-3"
+
+    def test_drops_illegal_chars(self):
+        # Slashes, plus signs, etc. drop out entirely
+        assert sanitize_homie_id("a/b+c") == "abc"
+
+    def test_collapses_runs_of_hyphens(self):
+        assert sanitize_homie_id("a---b") == "a-b"
+
+    def test_collapses_mixed_separators(self):
+        # Underscore + space + dot all become hyphens, then collapsed
+        assert sanitize_homie_id("a_ .b") == "a-b"
+
+    def test_strips_leading_trailing_hyphens(self):
+        assert sanitize_homie_id("-abc-") == "abc"
+
+    def test_strips_leading_trailing_from_separators(self):
+        assert sanitize_homie_id(" abc ") == "abc"
+
+    def test_all_illegal_collapses_to_empty(self):
+        # Caller is responsible for handling empty result
+        assert sanitize_homie_id("///+++") == ""
+
+    def test_only_separators_collapses_to_empty(self):
+        assert sanitize_homie_id("___") == ""
+
+    def test_complex_composition(self):
+        # Vendor-supplied composite: capitals, underscore, dot, illegal char
+        assert sanitize_homie_id("My_Device.v1/2") == "my-device-v12"
+
+
 # ── Unit enum ────────────────────────────────────────────────────────────
 
 
@@ -1168,6 +1224,25 @@ class TestDevicePublish:
         device.publish_nodes()
         mock_node.publish.assert_called_once()
 
+    def test_publish_nodes_snapshots_against_concurrent_add(self, mock_paho):
+        """SDK-e3k: publish_nodes() must snapshot self._nodes so the main
+        thread adding a node mid-iteration doesn't raise
+        'dictionary changed size during iteration' on the MQTT loop thread."""
+        device, _ = _make_device(mock_paho)
+
+        # Simulate the race: while iterating, one node's publish() mutates
+        # the underlying dict (as the main thread's add_node would).
+        racing_node = MagicMock()
+
+        def mutate_during_publish():
+            device._nodes["late-arrival"] = MagicMock()
+
+        racing_node.publish.side_effect = mutate_during_publish
+        device._nodes = {"core": racing_node}
+
+        # Without the list() snapshot fix, this raises RuntimeError.
+        device.publish_nodes()
+
 
 class TestDeviceOnConnect:
     def test_initial_connection(self, mock_paho):
@@ -1302,6 +1377,33 @@ class TestDeviceRefreshTree:
             )
             assert any(f"/{device_id}/$state" in t for t in topics), f"missing $state for {device_id} in {topics}"
 
+    def test_refresh_tree_snapshots_against_concurrent_child_add(self, mock_paho):
+        """SDK-e3k: refresh_tree() must snapshot self._children so a child
+        appended by the main thread mid-cascade isn't pulled into the current
+        republish on the MQTT loop thread. (Lists don't raise on
+        mutation-during-iteration the way dicts do, but processing a
+        half-constructed child is its own correctness hazard.)"""
+        root, _ = _make_device(mock_paho, device_id="panel-1")
+        existing_child = Device(id="circuit-a", parent=root)
+        late_arrival = MagicMock(spec=Device)
+
+        original_refresh = existing_child.refresh_tree
+
+        def mutate_during_refresh():
+            # Simulate the main thread appending a new child while the MQTT
+            # thread is mid-cascade.
+            root._children.append(late_arrival)
+            original_refresh()
+
+        existing_child.refresh_tree = mutate_during_refresh
+
+        root.refresh_tree()
+
+        # Snapshot semantics: late_arrival was appended after iteration began,
+        # so it must NOT be touched by this refresh cycle. Without the
+        # list() snapshot, CPython's list iterator picks it up.
+        late_arrival.refresh_tree.assert_not_called()
+
     def test_refresh_tree_three_levels(self, mock_paho):
         """S2 + S6: grandchildren also republish on reconnect."""
         root, mock_client = _make_device(mock_paho, device_id="panel-1")