Add check_callback parameter to FloatArrayItem and update tests

Author: PierreRaybaut

CHANGELOG.md

@@ -17,6 +17,11 @@
     set_validation_mode(ValidationMode.STRICT)
     ```
 
+* New `check_callback` parameter for `FloatArrayItem`:
+  * The `check_callback` parameter allows you to specify a custom validation function for the item.
+  * This function will be called to validate the item's value whenever it is set.
+  * If the function returns `False`, the value will be considered invalid.
+
 * New `allow_none` parameter for `DataItem` objects:
   * The `allow_none` parameter allows you to specify whether `None` is a valid value for the item, which can be especially useful when validation modes are used.
   * If `allow_none` is set to `True`, `None` is considered a valid value regardless of other constraints.

guidata/dataset/dataitems.py

@@ -1095,6 +1095,10 @@ class FloatArrayItem(DataItem):
         variable_size: if True, allows to add/remove row/columns on all axis
         allow_none: if True, None is a valid value regardless of other constraints
          (optional, default=True)
+        check_callback: additional callback to check the value
+         (function of two arguments (value, raise_exception) returning a boolean,
+         where value is the value to check and raise_exception is a boolean
+         indicating whether to raise an exception on invalid value)
     """
 
     type = np.ndarray
@@ -1110,12 +1114,14 @@ def __init__(
         check: bool = True,
         variable_size=False,
         allow_none: bool = True,
+        check_callback: Callable[[np.ndarray, bool], bool] | None = None,
     ) -> None:
         super().__init__(
             label, default=default, help=help, check=check, allow_none=allow_none
         )
         self.set_prop("display", format=format, transpose=transpose, minmax=minmax)
         self.set_prop("edit", variable_size=variable_size)
+        self.check_callback = check_callback
 
     def check_value(self, value: np.ndarray, raise_exception: bool = False) -> bool:
         """Override DataItem method"""
@@ -1125,6 +1131,8 @@ def check_value(self, value: np.ndarray, raise_exception: bool = False) -> bool:
             if raise_exception:
                 raise TypeError(f"Expected {self.type}, got {type(value)}")
             return False
+        if self.check_callback is not None:
+            return self.check_callback(value, raise_exception)
         return True
 
     def format_string(

guidata/tests/dataset/test_all_features.py

@@ -16,6 +16,7 @@
 import numpy as np
 
 import guidata.dataset as gds
+from guidata.config import ValidationMode, get_validation_mode, set_validation_mode
 from guidata.dataset.qtitemwidgets import DataSetWidget
 from guidata.dataset.qtwidgets import DataSetEditLayout, DataSetShowLayout
 from guidata.env import execenv
@@ -65,10 +66,10 @@ class Parameters(gds.DataSet):
             "float_col": 1.0,
         },
     )
-    string = gds.StringItem("String")
+    string = gds.StringItem("String", default="")
     string_regexp = gds.StringItem("String", regexp=r"^[a-z]+[0-9]$", default="abcd9")
-    password = gds.StringItem("Password", password=True)
-    text = gds.TextItem("Text")
+    password = gds.StringItem("Password", default="", password=True)
+    text = gds.TextItem("Text", default="")
     _bg = gds.BeginGroup("A sub group")
     float_slider = gds.FloatItem(
         "Float (with slider)", default=0.5, min=0, max=1, step=0.01, slider=True
@@ -121,11 +122,13 @@ class Parameters(gds.DataSet):
     integer_slider = gds.IntItem(
         "Integer (with slider)", default=5, min=-50, max=50, slider=True
     )
-    integer = gds.IntItem("Integer", default=5, min=3, max=6).set_pos(col=1)
+    integer = gds.IntItem("Integer", default=5, min=3, max=60).set_pos(col=1)
 
 
 def test_all_features():
     """Test all guidata item/group features"""
+    old_mode = get_validation_mode()
+    set_validation_mode(ValidationMode.STRICT)
     with execenv.context(accept_dialogs=True):
         with qt_app_context():
             prm1 = Parameters()
@@ -137,8 +140,8 @@ def test_all_features():
                 execenv.print(prm1)
             prm1.view()
 
-            prm2 = Parameters.create(integer=10101010, string="Using `create`")
-            assert prm2.integer == 10101010
+            prm2 = Parameters.create(integer=59, string="Using `create`")
+            assert prm2.integer == 59
             print(prm2)
 
             try:
@@ -150,6 +153,7 @@ def test_all_features():
                 raise AssertionError("AttributeError not raised")
 
             execenv.print("OK")
+    set_validation_mode(old_mode)
 
 
 if __name__ == "__main__":

guidata/tests/unit/test_validationmodes.py

@@ -7,19 +7,42 @@
 
 import os.path as osp
 
+import numpy as np
 import pytest
 
 import guidata.dataset as gds
 from guidata.config import ValidationMode, get_validation_mode, set_validation_mode
 from guidata.env import execenv
 
 
+def check_array(value: np.ndarray, raise_exception: bool = False) -> bool:
+    """Check if value is a valid 2D array of floats.
+
+    Args:
+        value: value to check
+        raise_exception: if True, raise an exception on invalid value
+
+    Returns:
+        True if value is valid, False otherwise
+    """
+    if (
+        not isinstance(value, np.ndarray)
+        or value.ndim != 2
+        or not np.issubdtype(value.dtype, np.floating)
+    ):
+        if raise_exception:
+            raise TypeError("Float array must be a 2D numpy array of floats")
+        return False
+    return True
+
+
 class Parameters(gds.DataSet):
     """Example dataset"""
 
     fitem = gds.FloatItem("Float", min=1, max=250)
     iitem = gds.IntItem("Integer", max=20, nonzero=True)
     sitem = gds.StringItem("String", notempty=True)
+    aitem = gds.FloatArrayItem("Array", check_callback=check_array)
     fileopenitem = gds.FileOpenItem("File", ("py",))
     filesopenitem = gds.FilesOpenItem("Files", ("py",))
     filesaveitem = gds.FileSaveItem("Save file", ("py",))
@@ -30,6 +53,7 @@ class Parameters(gds.DataSet):
     "fitem": 100.0,
     "iitem": 10,
     "sitem": "test",
+    "aitem": np.array([[1.0, 2.0], [3.0, 4.0]]),
     "fileopenitem": __file__,
     "filesopenitem": [
         __file__,
@@ -50,6 +74,10 @@ class Parameters(gds.DataSet):
         "test",  # Not an integer
         23.2323,  # Not an integer
     ),
+    "aitem": (
+        np.array([1.0, 2.0]),  # Not a 2D array
+        np.array([[1, 2], [3, 4]]),  # Not a float array
+    ),
     "sitem": (
         "",  # Empty string not allowed
         123,  # Not a string
@@ -74,18 +102,45 @@ def test_default_validation_mode():
     execenv.print("OK")
 
 
+def __check_assigned_value_is_equal(assigned_value, expected_value):
+    """Check if the assigned value is correctly set"""
+    if isinstance(expected_value, np.ndarray):
+        # For arrays, we check if the value is set correctly
+        assert isinstance(assigned_value, np.ndarray)
+        assert assigned_value.shape == expected_value.shape
+        assert np.all(assigned_value == expected_value)
+    else:
+        # For other types, we check if the value is set correctly
+        assert assigned_value == expected_value
+
+
+def __check_assigned_value_is_not_equal(assigned_value, expected_value):
+    """Check if the assigned value is not equal to the real value"""
+    if isinstance(expected_value, np.ndarray):
+        # For arrays, we check if the value is set correctly
+        if isinstance(assigned_value, np.ndarray):
+            assert assigned_value.shape == expected_value.shape
+            assert not np.all(assigned_value == expected_value)
+        else:
+            assert assigned_value is None
+    else:
+        # For other types, we check if the value is set correctly
+        assert assigned_value != expected_value
+
+
 def test_valid_data():
     """Test valid data"""
     params = Parameters()
     execenv.print("Testing valid data: ", end="")
     for name, value in VALID_DATA.items():
         setattr(params, name, value)
-        assert getattr(params, name) == value
+        __check_assigned_value_is_equal(getattr(params, name), value)
     execenv.print("OK")
 
 
 def test_invalid_data_with_no_validation():
     """Test invalid data with validation disabled"""
+    old_mode = get_validation_mode()
     params = Parameters()
     set_validation_mode(ValidationMode.DISABLED)
     assert get_validation_mode() == ValidationMode.DISABLED
@@ -95,11 +150,13 @@ def test_invalid_data_with_no_validation():
             execenv.print(f"  Testing {name} with value: {value}")
             setattr(params, name, value)
             # No exception should be raised
-            assert getattr(params, name) == value
+            __check_assigned_value_is_equal(getattr(params, name), value)
+    set_validation_mode(old_mode)
 
 
 def test_invalid_data_with_enabled_validation():
     """Test invalid data with validation enabled"""
+    old_mode = get_validation_mode()
     params = Parameters()
     set_validation_mode(ValidationMode.ENABLED)
     assert get_validation_mode() == ValidationMode.ENABLED
@@ -111,11 +168,13 @@ def test_invalid_data_with_enabled_validation():
             with pytest.warns(gds.DataItemValidationWarning):
                 setattr(params, name, value)
             # The value should be set anyway
-            assert getattr(params, name) == value
+            __check_assigned_value_is_equal(getattr(params, name), value)
+    set_validation_mode(old_mode)
 
 
 def test_invalid_data_with_strict_validation():
     """Test invalid data with strict validation"""
+    old_mode = get_validation_mode()
     params = Parameters()
     set_validation_mode(ValidationMode.STRICT)
     assert get_validation_mode() == ValidationMode.STRICT
@@ -127,7 +186,8 @@ def test_invalid_data_with_strict_validation():
             with pytest.raises(gds.DataItemValidationError):
                 setattr(params, name, value)
             # The value should not be set
-            assert getattr(params, name) != value
+            __check_assigned_value_is_not_equal(getattr(params, name), value)
+    set_validation_mode(old_mode)
 
 
 if __name__ == "__main__":