Merge pull request #17 from tiqi-group/13-superfluous-parameter-access-when-using-service-persistence

13 superfluous parameter access when using service persistence

src/pydase/data_service/data_service.py

@@ -19,6 +19,7 @@ from pydase.utils.helpers import (
     get_component_class_names,
     get_nested_value_from_DataService_by_path_and_key,
     get_object_attr_from_path,
+    is_property_attribute,
     parse_list_attr_and_index,
     update_value_if_changed,
 )
@@ -58,13 +59,15 @@ class DataService(rpyc.Service, AbstractDataService):
         self._load_values_from_json()
 
     def __setattr__(self, __name: str, __value: Any) -> None:
-        current_value = getattr(self, __name, None)
-        # parse ints into floats if current value is a float
-        if isinstance(current_value, float) and isinstance(__value, int):
-            __value = float(__value)
+        # converting attributes that are not properties
+        if not isinstance(getattr(type(self), __name, None), property):
+            current_value = getattr(self, __name, None)
+            # parse ints into floats if current value is a float
+            if isinstance(current_value, float) and isinstance(__value, int):
+                __value = float(__value)
 
-        if isinstance(current_value, u.Quantity):
-            __value = u.convert_to_quantity(__value, str(current_value.u))
+            if isinstance(current_value, u.Quantity):
+                __value = u.convert_to_quantity(__value, str(current_value.u))
 
         super().__setattr__(__name, __value)
 
@@ -84,6 +87,27 @@ class DataService(rpyc.Service, AbstractDataService):
             if not attr_name.startswith("_DataService__"):
                 warn_if_instance_class_does_not_inherit_from_DataService(attr_value)
 
+    def __set_attribute_based_on_type(  # noqa:CFQ002
+        self,
+        target_obj: Any,
+        attr_name: str,
+        attr: Any,
+        value: Any,
+        index: Optional[int],
+        path_list: list[str],
+    ) -> None:
+        if isinstance(attr, Enum):
+            update_value_if_changed(target_obj, attr_name, attr.__class__[value])
+        elif isinstance(attr, list) and index is not None:
+            update_value_if_changed(attr, index, value)
+        elif isinstance(attr, DataService) and isinstance(value, dict):
+            for key, v in value.items():
+                self.update_DataService_attribute([*path_list, attr_name], key, v)
+        elif callable(attr):
+            process_callable_attribute(attr, value["args"])
+        else:
+            update_value_if_changed(target_obj, attr_name, value)
+
     def _rpyc_getattr(self, name: str) -> Any:
         if name.startswith("_"):
             # disallow special and private attributes
@@ -338,24 +362,19 @@ class DataService(rpyc.Service, AbstractDataService):
     ) -> None:
         # If attr_name corresponds to a list entry, extract the attr_name and the index
         attr_name, index = parse_list_attr_and_index(attr_name)
-
         # Traverse the object according to the path parts
         target_obj = get_object_attr_from_path(self, path_list)
 
-        attr = get_object_attr_from_path(target_obj, [attr_name])
+        # If the attribute is a property, change it using the setter without getting the
+        # property value (would otherwise be bad for expensive getter methods)
+        if is_property_attribute(target_obj, attr_name):
+            setattr(target_obj, attr_name, value)
+            return
 
+        attr = get_object_attr_from_path(target_obj, [attr_name])
         if attr is None:
             return
 
-        # Set the attribute at the terminal point of the path
-        if isinstance(attr, Enum):
-            update_value_if_changed(target_obj, attr_name, attr.__class__[value])
-        elif isinstance(attr, list) and index is not None:
-            update_value_if_changed(attr, index, value)
-        elif isinstance(attr, DataService) and isinstance(value, dict):
-            for key, v in value.items():
-                self.update_DataService_attribute([*path_list, attr_name], key, v)
-        elif callable(attr):
-            return process_callable_attribute(attr, value["args"])
-        else:
-            update_value_if_changed(target_obj, attr_name, value)
+        self.__set_attribute_based_on_type(
+            target_obj, attr_name, attr, value, index, path_list
+        )

src/pydase/utils/helpers.py

@@ -394,3 +394,7 @@ def get_component_class_names() -> list[str]:
     import pydase.components
 
     return pydase.components.__all__
+
+
+def is_property_attribute(target_obj: Any, attr_name: str) -> bool:
+    return isinstance(getattr(type(target_obj), attr_name, None), property)

tests/utils/test_helpers.py

@@ -1,6 +1,9 @@
+import pytest
+
 from pydase.utils.helpers import (
     extract_dict_or_list_entry,
     get_nested_value_from_DataService_by_path_and_key,
+    is_property_attribute,
 )
 
 # Sample data for the tests
@@ -62,3 +65,29 @@ def test_get_nested_value_with_invalid_path() -> None:
         data_sample, "class_attr.nonexistent_attr"
     )
     assert result is None
+
+
+@pytest.mark.parametrize(
+    "attr_name, expected",
+    [
+        ("regular_attribute", False),
+        ("my_property", True),
+        ("my_method", False),
+        ("non_existent_attr", False),
+    ],
+)
+def test_is_property_attribute(attr_name: str, expected: bool) -> None:
+    # Test Suite
+    class DummyClass:
+        def __init__(self) -> None:
+            self.regular_attribute = "I'm just an attribute"
+
+        @property
+        def my_property(self) -> str:
+            return "I'm a property"
+
+        def my_method(self) -> str:
+            return "I'm a method"
+
+    dummy = DummyClass()
+    assert is_property_attribute(dummy, attr_name) == expected