pywmswebcontrolpro 0.1.1__tar.gz → 0.1.2__tar.gz

{pywmswebcontrolpro-0.1.1 → pywmswebcontrolpro-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pywmswebcontrolpro
-Version: 0.1.1
+Version: 0.1.2
 Summary: Python library for the Warema WMS WebControl pro API
 Author-email: Marc Hoersken <info@marc-hoersken.de>
 License-Expression: Apache-2.0

{pywmswebcontrolpro-0.1.1 → pywmswebcontrolpro-0.1.2}/pywmswebcontrolpro/webcontrol.py

@@ -4,6 +4,7 @@ import asyncio
 import pprint
 import time
 from collections.abc import Mapping
+from dataclasses import dataclass
 from datetime import timedelta
 from pathlib import Path
 from types import MappingProxyType
@@ -33,6 +34,14 @@ DEFAULT_RETRY_DELAY = 1.0
 DEFAULT_REQUEST_SPACING = 0.5
 
 
+@dataclass(frozen=True)
+class ConfigChanges:
+    """Destinations that appeared or disappeared with a configuration refresh."""
+
+    added: frozenset[int] = frozenset()
+    removed: frozenset[int] = frozenset()
+
+
 class WebControlPro:
     """Client of one WMS WebControl pro gateway."""
 
@@ -143,15 +152,27 @@ class WebControlPro:
         ping = await self._ping()
         return ping["status"] == 0
 
-    async def refresh(self) -> None:
-        """Read the configuration and create destinations, rooms and scenes."""
+    async def refresh(self) -> ConfigChanges:
+        """Read the configuration and create destinations, rooms and scenes.
+
+        A destination that is already known stays the same object, so its
+        actions keep their movement model and stored state. Only new
+        destinations are created, and the result names the destinations that
+        appeared and disappeared. Rooms and scenes are created again.
+        """
         config = await self._getConfiguration()
         self._config = config
+        known = self._dests
         self._dests = {
-            dest["id"]: Destination(self, **dest) for dest in config["destinations"]
+            dest["id"]: known.get(dest["id"]) or Destination(self, **dest)
+            for dest in config["destinations"]
         }
         self._rooms = {room["id"]: Room(self, **room) for room in config["rooms"]}
         self._scenes = {scene["id"]: Scene(self, **scene) for scene in config["scenes"]}
+        return ConfigChanges(
+            added=frozenset(self._dests) - frozenset(known),
+            removed=frozenset(known) - frozenset(self._dests),
+        )
 
     def dest(self, name: str) -> Destination:
         """Return the destination with the given name or raise KeyError."""

{pywmswebcontrolpro-0.1.1 → pywmswebcontrolpro-0.1.2}/tests/conftest.py

@@ -106,12 +106,13 @@ class FakeGateway:
     def __init__(self) -> None:
         self.status_answers: list[dict[str, Any] | Exception] = []
         self.requests: list[dict[str, Any]] = []
+        self.config = CONFIG
 
     def post(self, url: str, json: dict[str, Any], timeout: int) -> FakeRequest:
         """Answer one request of the library."""
         self.requests.append(json)
         if json["command"] == "getConfiguration":
-            return FakeRequest(CONFIG)
+            return FakeRequest(self.config)
         return FakeRequest(self.status_answers.pop(0))
 
     @property

pywmswebcontrolpro-0.1.2/tests/test_configuration.py

@@ -0,0 +1,59 @@
+"""Tests for reading the configuration of the gateway again."""
+
+from collections.abc import Callable
+from copy import deepcopy
+from typing import Any
+
+from pywmswebcontrolpro.webcontrol import ConfigChanges, WebControlPro
+
+from .conftest import CONFIG, DEST_ID, FakeGateway
+
+NEW_DEST_ID = 8
+
+
+def _config_with(*dest_ids: int) -> dict[str, Any]:
+    """Return a configuration with copies of the test destination."""
+    config = deepcopy(CONFIG)
+    template = config["destinations"][0]
+    config["destinations"] = [{**template, "id": dest_id} for dest_id in dest_ids]
+    return config
+
+
+async def test_first_refresh_reports_all_destinations_as_added(
+    make_control: Callable[..., WebControlPro],
+) -> None:
+    """The first read of the configuration finds the destinations."""
+    changes = await make_control().refresh()
+
+    assert changes == ConfigChanges(added=frozenset({DEST_ID}))
+
+
+async def test_refresh_reports_added_and_removed_destinations(
+    make_control: Callable[..., WebControlPro], gateway: FakeGateway
+) -> None:
+    """A destination that appears or disappears is named in the result."""
+    control = make_control()
+    await control.refresh()
+    gateway.config = _config_with(NEW_DEST_ID)
+
+    changes = await control.refresh()
+
+    assert changes == ConfigChanges(
+        added=frozenset({NEW_DEST_ID}), removed=frozenset({DEST_ID})
+    )
+    assert set(control.dests) == {NEW_DEST_ID}
+
+
+async def test_refresh_keeps_the_known_destinations(
+    make_control: Callable[..., WebControlPro], gateway: FakeGateway
+) -> None:
+    """A known destination stays the same object with its state."""
+    control = make_control()
+    await control.refresh()
+    known = control.dests[DEST_ID]
+    gateway.config = _config_with(DEST_ID, NEW_DEST_ID)
+
+    changes = await control.refresh()
+
+    assert changes == ConfigChanges(added=frozenset({NEW_DEST_ID}))
+    assert control.dests[DEST_ID] is known