Merge branch 'feature/on-changed-dict-fixes' into feature/2pv572-support

Author: nanomad

deebot_client/util/__init__.py

@@ -89,10 +89,12 @@ def __init__(
         super().__init__(iterable)
         self._on_change = on_change
 
+    # This is needed as __getattribute__ won't be invoked for implicit special method lookup
     def __setitem__(self, key: _KT, value: _VT) -> None:
         self._on_change()
         super().__setitem__(key, value)
 
+    # This is needed as __getattribute__ won't be invoked for implicit special method lookup
     def __delitem__(self, key: _KT) -> None:
         self._on_change()
         return super().__delitem__(key)

tests/util/test_init.py

@@ -3,7 +3,7 @@
 import asyncio
 from typing import Any
 
-from deebot_client.util import cancel, create_task
+from deebot_client.util import OnChangedDict, cancel, create_task
 
 
 async def test_create_task_and_cancel() -> None:
@@ -35,3 +35,43 @@ async def sleep(delay: float) -> None:
     for task in _tasks:
         assert task.cancelled()
         assert task.done()
+
+
+def test_on_changed_dict() -> None:
+    class OnChangedListener:
+        def __init__(self) -> None:
+            self.__counter = 0
+
+        def on_changed_dict(self) -> None:
+            self.__counter += 1
+
+        def counter(self) -> int:
+            return self.__counter
+
+    listener = OnChangedListener()
+
+    sut: OnChangedDict[str, int] = OnChangedDict(listener.on_changed_dict)
+
+    sut["test"] = 1001  # Should be triggered by __setitem__
+
+    assert sut["test"] == 1001
+
+    sut.update(
+        {"test": 1002, "test2": 2001, "test3": 3001, "test4": 4001}
+    )  # Should trigger update()
+
+    assert sut["test"] == 1002
+
+    del sut["test"]  # Should trigger __delitem__
+
+    assert "test" not in sut
+
+    assert sut.pop("test2") == 2001  # Should trigger pop()
+
+    (popped_key, popped_value) = sut.popitem()  # Should trigger popitem()
+    assert popped_key == "test4"
+    assert popped_value == 4001
+
+    sut.clear()  # Should trigger clear
+
+    assert listener.counter() == 6