From 47a73ad55fad4d1742a71e88ca01fe3ac299d17d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mose=20M=C3=BCller?= <mosemueller@gmail.com>
Date: Tue, 30 Apr 2024 11:44:19 +0200
Subject: [PATCH] moves _ObservableDict tests into separate file

---
 .../observable/test_observable_dict.py        | 195 ++++++++++++++++++
 .../observable/test_observable_object.py      | 178 ----------------
 2 files changed, 195 insertions(+), 178 deletions(-)
 create mode 100644 tests/observer_pattern/observable/test_observable_dict.py

diff --git a/tests/observer_pattern/observable/test_observable_dict.py b/tests/observer_pattern/observable/test_observable_dict.py
new file mode 100644
index 0000000..de72a30
--- /dev/null
+++ b/tests/observer_pattern/observable/test_observable_dict.py
@@ -0,0 +1,195 @@
+import logging
+from typing import Any
+
+import pytest
+from pydase.observer_pattern.observable import Observable
+from pydase.observer_pattern.observer import Observer
+
+logger = logging.getLogger(__name__)
+
+
+class MyObserver(Observer):
+    def on_change(self, full_access_path: str, value: Any) -> None:
+        logger.info("'%s' changed to '%s'", full_access_path, value)
+
+
+def test_simple_class_dict_attribute(caplog: pytest.LogCaptureFixture) -> None:
+    class MyObservable(Observable):
+        dict_attr = {"first": "Hello"}
+
+    instance = MyObservable()
+    MyObserver(instance)
+    instance.dict_attr["first"] = "Ciao"
+    instance.dict_attr["second"] = "World"
+
+    assert "'dict_attr[\"first\"]' changed to 'Ciao'" in caplog.text
+    assert "'dict_attr[\"second\"]' changed to 'World'" in caplog.text
+
+
+def test_instance_dict_attribute(caplog: pytest.LogCaptureFixture) -> None:
+    class NestedObservable(Observable):
+        def __init__(self) -> None:
+            super().__init__()
+            self.name = "Hello"
+
+    class MyObservable(Observable):
+        def __init__(self) -> None:
+            super().__init__()
+            self.dict_attr = {"first": NestedObservable()}
+
+    instance = MyObservable()
+    MyObserver(instance)
+    instance.dict_attr["first"].name = "Ciao"
+
+    assert "'dict_attr[\"first\"].name' changed to 'Ciao'" in caplog.text
+
+
+def test_class_dict_attribute(caplog: pytest.LogCaptureFixture) -> None:
+    class NestedObservable(Observable):
+        name = "Hello"
+
+    class MyObservable(Observable):
+        dict_attr = {"first": NestedObservable()}
+
+    instance = MyObservable()
+    MyObserver(instance)
+    instance.dict_attr["first"].name = "Ciao"
+
+    assert "'dict_attr[\"first\"].name' changed to 'Ciao'" in caplog.text
+
+
+def test_nested_dict_instances(caplog: pytest.LogCaptureFixture) -> None:
+    dict_instance = {"first": "Hello", "second": "World"}
+
+    class MyObservable(Observable):
+        def __init__(self) -> None:
+            super().__init__()
+            self.nested_dict_attr = {"nested": dict_instance}
+
+    instance = MyObservable()
+    MyObserver(instance)
+    instance.nested_dict_attr["nested"]["first"] = "Ciao"
+
+    assert "'nested_dict_attr[\"nested\"][\"first\"]' changed to 'Ciao'" in caplog.text
+
+
+def test_dict_in_list_instance(caplog: pytest.LogCaptureFixture) -> None:
+    dict_instance = {"first": "Hello", "second": "World"}
+
+    class MyObservable(Observable):
+        def __init__(self) -> None:
+            super().__init__()
+            self.dict_in_list = [dict_instance]
+
+    instance = MyObservable()
+    MyObserver(instance)
+    instance.dict_in_list[0]["first"] = "Ciao"
+
+    assert "'dict_in_list[0][\"first\"]' changed to 'Ciao'" in caplog.text
+
+
+def test_list_in_dict_instance(caplog: pytest.LogCaptureFixture) -> None:
+    list_instance: list[Any] = [1, 2, 3]
+
+    class MyObservable(Observable):
+        def __init__(self) -> None:
+            super().__init__()
+            self.list_in_dict = {"some_list": list_instance}
+
+    instance = MyObservable()
+    MyObserver(instance)
+    instance.list_in_dict["some_list"][0] = "Ciao"
+
+    assert "'list_in_dict[\"some_list\"][0]' changed to 'Ciao'" in caplog.text
+
+
+def test_key_type_error(caplog: pytest.LogCaptureFixture) -> None:
+    class MyObservable(Observable):
+        def __init__(self) -> None:
+            super().__init__()
+            self.dict_attr = {1.0: 1.0}
+
+    with pytest.raises(ValueError) as exc_info:
+        MyObservable()
+
+    assert (
+        "Invalid key type: 1.0 (float). In pydase services, dictionary keys must be "
+        "strings." in str(exc_info)
+    )
+
+
+def test_removed_observer_on_class_dict_attr(caplog: pytest.LogCaptureFixture) -> None:
+    class NestedObservable(Observable):
+        def __init__(self) -> None:
+            super().__init__()
+            self.name = "Hello"
+
+    nested_instance = NestedObservable()
+
+    class MyObservable(Observable):
+        nested_attr = nested_instance
+        changed_dict_attr = {"nested": nested_instance}
+
+    instance = MyObservable()
+    MyObserver(instance)
+    instance.changed_dict_attr["nested"] = "Ciao"
+
+    assert "'changed_dict_attr[\"nested\"]' changed to 'Ciao'" in caplog.text
+    caplog.clear()
+
+    assert nested_instance._observers == {
+        '["nested"]': [],
+        "nested_attr": [instance],
+    }
+
+    instance.nested_attr.name = "Hi"
+
+    assert "'nested_attr.name' changed to 'Hi'" in caplog.text
+    assert "'changed_dict_attr[\"nested\"].name' changed to 'Hi'" not in caplog.text
+
+
+def test_removed_observer_on_instance_dict_attr(
+    caplog: pytest.LogCaptureFixture,
+) -> None:
+    class NestedObservable(Observable):
+        def __init__(self) -> None:
+            super().__init__()
+            self.name = "Hello"
+
+    nested_instance = NestedObservable()
+
+    class MyObservable(Observable):
+        def __init__(self) -> None:
+            super().__init__()
+            self.nested_attr = nested_instance
+            self.changed_dict_attr = {"nested": nested_instance}
+
+    instance = MyObservable()
+    MyObserver(instance)
+    instance.changed_dict_attr["nested"] = "Ciao"
+
+    assert "'changed_dict_attr[\"nested\"]' changed to 'Ciao'" in caplog.text
+    caplog.clear()
+
+    assert nested_instance._observers == {
+        '["nested"]': [],
+        "nested_attr": [instance],
+    }
+
+    instance.nested_attr.name = "Hi"
+
+    assert "'nested_attr.name' changed to 'Hi'" in caplog.text
+    assert "'changed_dict_attr[\"nested\"].name' changed to 'Hi'" not in caplog.text
+
+
+def test_dotted_dict_key(caplog: pytest.LogCaptureFixture) -> None:
+    class MyObservable(Observable):
+        def __init__(self) -> None:
+            super().__init__()
+            self.dict_attr = {"dotted.key": 1.0}
+
+    instance = MyObservable()
+    MyObserver(instance)
+    instance.dict_attr["dotted.key"] = "Ciao"
+
+    assert "'dict_attr[\"dotted.key\"]' changed to 'Ciao'" in caplog.text
diff --git a/tests/observer_pattern/observable/test_observable_object.py b/tests/observer_pattern/observable/test_observable_object.py
index 70d7324..6c9eb29 100644
--- a/tests/observer_pattern/observable/test_observable_object.py
+++ b/tests/observer_pattern/observable/test_observable_object.py
@@ -69,66 +69,6 @@ def test_class_object_list_attribute(caplog: pytest.LogCaptureFixture) -> None:
     assert "'list_attr[0].name' changed to 'Ciao'" in caplog.text
 
 
-def test_simple_instance_dict_attribute(caplog: pytest.LogCaptureFixture) -> None:
-    class MyObservable(Observable):
-        def __init__(self) -> None:
-            super().__init__()
-            self.dict_attr = {"first": "Hello"}
-
-    instance = MyObservable()
-    MyObserver(instance)
-    instance.dict_attr["first"] = "Ciao"
-    instance.dict_attr["second"] = "World"
-
-    assert "'dict_attr[\"first\"]' changed to 'Ciao'" in caplog.text
-    assert "'dict_attr[\"second\"]' changed to 'World'" in caplog.text
-
-
-def test_simple_class_dict_attribute(caplog: pytest.LogCaptureFixture) -> None:
-    class MyObservable(Observable):
-        dict_attr = {"first": "Hello"}
-
-    instance = MyObservable()
-    MyObserver(instance)
-    instance.dict_attr["first"] = "Ciao"
-    instance.dict_attr["second"] = "World"
-
-    assert "'dict_attr[\"first\"]' changed to 'Ciao'" in caplog.text
-    assert "'dict_attr[\"second\"]' changed to 'World'" in caplog.text
-
-
-def test_instance_dict_attribute(caplog: pytest.LogCaptureFixture) -> None:
-    class NestedObservable(Observable):
-        def __init__(self) -> None:
-            super().__init__()
-            self.name = "Hello"
-
-    class MyObservable(Observable):
-        def __init__(self) -> None:
-            super().__init__()
-            self.dict_attr = {"first": NestedObservable()}
-
-    instance = MyObservable()
-    MyObserver(instance)
-    instance.dict_attr["first"].name = "Ciao"
-
-    assert "'dict_attr[\"first\"].name' changed to 'Ciao'" in caplog.text
-
-
-def test_class_dict_attribute(caplog: pytest.LogCaptureFixture) -> None:
-    class NestedObservable(Observable):
-        name = "Hello"
-
-    class MyObservable(Observable):
-        dict_attr = {"first": NestedObservable()}
-
-    instance = MyObservable()
-    MyObserver(instance)
-    instance.dict_attr["first"].name = "Ciao"
-
-    assert "'dict_attr[\"first\"].name' changed to 'Ciao'" in caplog.text
-
-
 def test_removed_observer_on_class_list_attr(caplog: pytest.LogCaptureFixture) -> None:
     class NestedObservable(Observable):
         name = "Hello"
@@ -152,44 +92,6 @@ def test_removed_observer_on_class_list_attr(caplog: pytest.LogCaptureFixture) -
     assert "'changed_list_attr[0].name' changed to 'Hi'" not in caplog.text
 
 
-def test_removed_observer_on_instance_dict_attr(
-    caplog: pytest.LogCaptureFixture,
-) -> None:
-    class NestedObservable(Observable):
-        def __init__(self) -> None:
-            super().__init__()
-            self.name = "Hello"
-
-    nested_instance = NestedObservable()
-
-    class MyObservable(Observable):
-        def __init__(self) -> None:
-            super().__init__()
-            self.nested_attr = nested_instance
-            self.changed_dict_attr = {"nested": nested_instance, 2.1: nested_instance}
-
-    instance = MyObservable()
-    MyObserver(instance)
-    instance.changed_dict_attr["nested"] = "Ciao"
-    instance.changed_dict_attr[2.1] = "foo"
-
-    assert "'changed_dict_attr[\"nested\"]' changed to 'Ciao'" in caplog.text
-    assert "'changed_dict_attr[2.1]' changed to 'foo'" in caplog.text
-    caplog.clear()
-
-    assert nested_instance._observers == {
-        '["nested"]': [],
-        "[2.1]": [],
-        "nested_attr": [instance],
-    }
-
-    instance.nested_attr.name = "Hi"
-
-    assert "'nested_attr.name' changed to 'Hi'" in caplog.text
-    assert "'changed_dict_attr[\"nested\"].name' changed to 'Hi'" not in caplog.text
-    assert "'changed_dict_attr[2.1].name' changed to 'Hi'" not in caplog.text
-
-
 def test_removed_observer_on_instance_list_attr(
     caplog: pytest.LogCaptureFixture,
 ) -> None:
@@ -219,86 +121,6 @@ def test_removed_observer_on_instance_list_attr(
     assert "'changed_list_attr[0].name' changed to 'Hi'" not in caplog.text
 
 
-def test_removed_observer_on_class_dict_attr(caplog: pytest.LogCaptureFixture) -> None:
-    class NestedObservable(Observable):
-        def __init__(self) -> None:
-            super().__init__()
-            self.name = "Hello"
-
-    nested_instance = NestedObservable()
-    assert nested_instance._observers == {}
-
-    class MyObservable(Observable):
-        nested_attr = nested_instance
-        changed_dict_attr = {"nested": nested_instance, 2.1: nested_instance}
-
-    instance = MyObservable()
-    MyObserver(instance)
-    instance.changed_dict_attr["nested"] = "Ciao"
-    instance.changed_dict_attr[2.1] = "foo"
-
-    assert "'changed_dict_attr[\"nested\"]' changed to 'Ciao'" in caplog.text
-    assert "'changed_dict_attr[2.1]' changed to 'foo'" in caplog.text
-    caplog.clear()
-
-    assert nested_instance._observers == {
-        '["nested"]': [],
-        "[2.1]": [],
-        "nested_attr": [instance],
-    }
-
-    instance.nested_attr.name = "Hi"
-
-    assert "'nested_attr.name' changed to 'Hi'" in caplog.text
-    assert "'changed_dict_attr[\"nested\"].name' changed to 'Hi'" not in caplog.text
-    assert "'changed_dict_attr[2.1].name' changed to 'Hi'" not in caplog.text
-
-
-def test_nested_dict_instances(caplog: pytest.LogCaptureFixture) -> None:
-    dict_instance = {"first": "Hello", "second": "World"}
-
-    class MyObservable(Observable):
-        def __init__(self) -> None:
-            super().__init__()
-            self.nested_dict_attr = {"nested": dict_instance}
-
-    instance = MyObservable()
-    MyObserver(instance)
-    instance.nested_dict_attr["nested"]["first"] = "Ciao"
-
-    assert "'nested_dict_attr[\"nested\"][\"first\"]' changed to 'Ciao'" in caplog.text
-
-
-def test_dict_in_list_instance(caplog: pytest.LogCaptureFixture) -> None:
-    dict_instance = {"first": "Hello", "second": "World"}
-
-    class MyObservable(Observable):
-        def __init__(self) -> None:
-            super().__init__()
-            self.dict_in_list = [dict_instance]
-
-    instance = MyObservable()
-    MyObserver(instance)
-    instance.dict_in_list[0]["first"] = "Ciao"
-
-    assert "'dict_in_list[0][\"first\"]' changed to 'Ciao'" in caplog.text
-
-
-def test_list_in_dict_instance(caplog: pytest.LogCaptureFixture) -> None:
-    list_instance: list[Any] = [1, 2, 3]
-
-    class MyObservable(Observable):
-        def __init__(self) -> None:
-            super().__init__()
-            self.list_in_dict = {"some_list": list_instance}
-
-    instance = MyObservable()
-    MyObserver(instance)
-    instance.list_in_dict["some_list"][0] = "Ciao"
-
-    assert "'list_in_dict[\"some_list\"][0]' changed to 'Ciao'" in caplog.text
-
-
 def test_list_append(caplog: pytest.LogCaptureFixture) -> None:
     class OtherObservable(Observable):
         def __init__(self) -> None: