Add FuncPropMulti operator property and update tests for complex dependencies

Author: PierreRaybaut

CHANGELOG.md

@@ -4,6 +4,11 @@
 
 💥 New features:
 
+* New operator property `FuncPropMulti` for handling multiple properties:
+  * This property allows you to apply a function to multiple item properties at once.
+  * It can be used to create more complex dependencies between items in a dataset.
+  * See the `guidata.tests.dataset.test_activable_items` module for an example of usage.
+
 * New script `gbuild` for building the package:
   * This script is a wrapper around the `guidata.utils.securebuild` module, which ensures that the build process is secure and reproducible.
   * It checks that the `pyproject.toml` file is present in the root of the repository, and that it is committed to Git.

guidata/dataset/__init__.py

@@ -47,6 +47,7 @@
     EndTabGroup,
     FormatProp,
     FuncProp,
+    FuncPropMulti,
     GetAttrProp,
     GroupItem,
     ItemProperty,

guidata/dataset/datatypes.py

@@ -53,6 +53,9 @@
 
 .. autoclass:: guidata.dataset.FuncProp
     :members:
+
+.. autoclass:: guidata.dataset.FuncPropMulti
+    :members:
 """
 
 # pylint: disable-msg=W0622
@@ -249,6 +252,42 @@ def set(self, instance: DataSet, item: DataItem, value: Any) -> None:
         self.property.set(instance, item, self.inverse_function(value))
 
 
+class FuncPropMulti(ItemProperty):
+    """An 'operator property' for multiple properties
+
+    Args:
+        props (list[ItemProperty]): properties to apply function to
+        func (function): function to apply
+        invfunc (function): inverse function (default: func)
+    """
+
+    def __init__(
+        self,
+        props: list[ItemProperty],
+        func: Callable,
+        invfunc: Callable | None = None,
+    ) -> None:
+        self.properties = props
+        self.function = func
+        if invfunc is None:
+            invfunc = func
+        self.inverse_function = invfunc
+
+    def __call__(self, instance: DataSet, item: DataItem, value: Any) -> Any:
+        return self.function(*[prop(instance, item, value) for prop in self.properties])
+
+    def set(self, instance: DataSet, item: DataItem, value: Any) -> None:
+        """Sets the value of the property given an instance, item and value
+
+        Args:
+            instance (DataSet): instance of the DataSet
+            item (Any): item to set the value of
+            value (Any): value to set
+        """
+        for prop in self.properties:
+            prop.set(instance, item, self.inverse_function(value))
+
+
 class DataItem(ABC):
     """DataSet data item
 

guidata/tests/dataset/test_activable_items.py

@@ -10,29 +10,35 @@
 
 # guitest: show
 
-from guidata.dataset import (
-    BoolItem,
-    ChoiceItem,
-    DataSet,
-    FloatItem,
-    FuncProp,
-    GetAttrProp,
-)
+import guidata.dataset as gds
 from guidata.env import execenv
 from guidata.qthelpers import qt_app_context
 
 choices = (("A", "Choice #1: A"), ("B", "Choice #2: B"), ("C", "Choice #3: C"))
 
 
-class Parameters(DataSet):
+class Parameters(gds.DataSet):
     """Example dataset"""
 
-    _prop = GetAttrProp("choice")
-    choice = ChoiceItem("Choice", choices).set_prop("display", store=_prop)
-    x1 = FloatItem("x1")
-    x2 = FloatItem("x2").set_prop("display", active=FuncProp(_prop, lambda x: x == "B"))
-    x3 = FloatItem("x3").set_prop("display", active=FuncProp(_prop, lambda x: x == "C"))
-    b1 = BoolItem("b1").set_prop("display", active=FuncProp(_prop, lambda x: x == "C"))
+    _prop1 = gds.GetAttrProp("choice1")
+    choice1 = gds.ChoiceItem("Choice 1", choices).set_prop("display", store=_prop1)
+    _prop2 = gds.GetAttrProp("choice2")
+    choice2 = gds.ChoiceItem("Choice 2", choices).set_prop("display", store=_prop2)
+    x1 = gds.FloatItem("x1")
+    x2 = gds.FloatItem("x2").set_prop(
+        "display", active=gds.FuncProp(_prop1, lambda x: x == "B")
+    )
+    x3 = gds.FloatItem("x3").set_prop(
+        "display", active=gds.FuncProp(_prop1, lambda x: x == "C")
+    )
+    b1 = gds.BoolItem("A and C").set_prop(
+        "display",
+        active=gds.FuncPropMulti([_prop1, _prop2], lambda x, y: x == "A" and y == "C"),
+    )
+    b2 = gds.BoolItem("A or B").set_prop(
+        "display",
+        active=gds.FuncPropMulti([_prop1, _prop2], lambda x, y: x == "A" or y == "B"),
+    )
 
 
 def test_activable_items():