Switch/Optional widget fields setter/getter

src/ess/reduce/widgets/_base.py

@@ -1,6 +1,7 @@
 # SPDX-License-Identifier: BSD-3-Clause
 # Copyright (c) 2024 Scipp contributors (https://github.com/scipp)
 import warnings
+from collections.abc import Iterable
 from typing import Any, Protocol, runtime_checkable
 
 from ipywidgets import Widget
@@ -13,18 +14,22 @@ def set_fields(self, new_values: dict[str, Any]) -> None: ...
     def get_fields(self) -> dict[str, Any]: ...
 
 
+def _warn_invalid_field(invalid_fields: Iterable[str]) -> None:
+    for field_name in invalid_fields:
+        warning_msg = f"Cannot set field '{field_name}'."
+        " The field does not exist in the widget."
+        "The field value will be ignored."
+        warnings.warn(warning_msg, UserWarning, stacklevel=2)
+
+
 class WidgetWithFieldsMixin:
     def set_fields(self, new_values: dict[str, Any]) -> None:
         # Extract valid fields
         new_field_names = set(new_values.keys())
         valid_field_names = new_field_names & set(self.fields.keys())
         # Warn for invalid fields
         invalid_field_names = new_field_names - valid_field_names
-        for field_name in invalid_field_names:
-            warning_msg = f"Cannot set field '{field_name}'."
-            " The field does not exist in the widget."
-            "The field value will be ignored."
-            warnings.warn(warning_msg, UserWarning, stacklevel=1)
+        _warn_invalid_field(invalid_field_names)
         # Set valid fields
         for field_name in valid_field_names:
             self.fields[field_name].value = new_values[field_name]
@@ -36,28 +41,87 @@ def get_fields(self) -> dict[str, Any]:
         }
 
 
-def _has_widget_value_setter(widget: Widget) -> bool:
-    widget_type = type(widget)
-    return (
-        widget_property := getattr(widget_type, 'value', None)
-    ) is not None and getattr(widget_property, 'fset', None) is not None
+def set_fields(widget: Widget, new_values: dict[str, Any]) -> None:
+    """Set the fields of a widget with the given values.
+
+    Parameters
+    ----------
+    widget:
+        The widget to set the fields. It should either be an instance of
+        ``WidgetWithFieldsProtocol`` or have a value property setter.
+    new_values:
+        The new values to set for the fields.
+        i.e. ``{'field_name': field_value}``
+        If the widget does not have a ``set_fields/get_fields`` method,
+        (e.g. it is not an instance of ``WidgetWithFieldsProtocol``),
+        it will try to set the value of the widget directly.
+        The value of the widget should be available in the ``new_values`` dictionary
+        with the key 'value'.
+        i.e. ``{'value': widget_value}``
+
+    Raises
+    ------
+    TypeError:
+        If ``new_values`` is not a dictionary.
 
+    """
+    if not isinstance(new_values, dict):
+        raise TypeError(f"new_values must be a dictionary, got {type(new_values)}")
 
-def set_fields(widget: Widget, new_values: Any) -> None:
     if isinstance(widget, WidgetWithFieldsProtocol) and isinstance(new_values, dict):
         widget.set_fields(new_values)
-    elif _has_widget_value_setter(widget):
-        widget.value = new_values
     else:
-        warnings.warn(
-            f"Cannot set value or fields for widget of type {type(widget)}."
-            " The new_value(s) will be ignored.",
-            UserWarning,
-            stacklevel=1,
-        )
+        try:
+            # Use value property setter if ``new_values`` contains 'value'
+            if 'value' in new_values:
+                widget.value = new_values['value']
+            # Warn if there is any other fields in new_values
+            _warn_invalid_field(set(new_values.keys()) - {'value'})
+        except AttributeError as error:
+            # Checking if the widget value property has a setter in advance, i.e.
+            # ```python
+            # (widget_property := getattr(type(widget), 'value', None)) is not None
+            # and getattr(widget_property, 'fset', None) is not None
+            # ```
+            # does not work with a class that inherits Traitlets class.
+            # In those classes, even if a property has a setter,
+            # it may not have `fset` attribute.
+            # It is not really feasible to check all possible cases of value setters.
+            # Instead, we try setting the value and catch the AttributeError.
+            # to determine if the widget has a value setter.
+            warnings.warn(
+                f"Cannot set value for widget of type {type(widget)}."
+                " The new_value(s) will be ignored."
+                f" Setting value caused the following error: {error}",
+                UserWarning,
+                stacklevel=1,
+            )
 
 
-def get_fields(widget: Widget) -> Any:
+def get_fields(widget: Widget) -> dict[str, Any] | None:
+    """Get the fields of a widget.
+
+    If the widget is an instance of ``WidgetWithFieldsProtocol``,
+    it will return the fields of the widget.
+    i.e. ``{'field_name': field_value}``
+    Otherwise, it will try to get the value of the widget and return a dictionary
+    with the key 'value' and the value of the widget.
+    i.e. ``{'value': widget_value}``
+
+    Parameters
+    ----------
+    widget:
+        The widget to get the fields. It should either be an instance of
+        ``WidgetWithFieldsProtocol`` or have a value property.
+
+    """
     if isinstance(widget, WidgetWithFieldsProtocol):
         return widget.get_fields()
-    return widget.value
+    try:
+        return {'value': widget.value}
+    except AttributeError:
+        warnings.warn(
+            f"Cannot get value or fields for widget of type {type(widget)}.",
+            UserWarning,
+            stacklevel=1,
+        )

src/ess/reduce/widgets/_optional_widget.py

@@ -4,6 +4,7 @@
 
 from ipywidgets import HTML, HBox, Layout, RadioButtons, Widget
 
+from ._base import get_fields, set_fields
 from ._config import default_style
 
 
@@ -64,3 +65,26 @@ def value(self, value: Any) -> None:
         else:
             self._option_box.value = self.name
             self.wrapped.value = value
+
+    def set_fields(self, new_values: dict[str, Any]) -> None:
+        new_values = dict(new_values)
+        # Set the value of the option box
+        opted_out_flag = new_values.pop(
+            # We assume ``essreduce-opted-out`` is not used in any wrapped widget
+            'essreduce-opted-out',
+            self._option_box.value is None,
+        )
+        if not isinstance(opted_out_flag, bool):
+            raise ValueError(
+                f"Invalid value for 'essreduce-opted-out' field: {opted_out_flag}."
+                " The value should be a boolean."
+            )
+        self._option_box.value = None if opted_out_flag else self.name
+        # Set the value of the wrapped widget
+        set_fields(self.wrapped, new_values)
+
+    def get_fields(self) -> dict[str, Any] | None:
+        return {
+            **(get_fields(self.wrapped) or {}),
+            'essreduce-opted-out': self._option_box.value is None,
+        }

src/ess/reduce/widgets/_switchable_widget.py

@@ -4,6 +4,7 @@
 
 from ipywidgets import Checkbox, HBox, Label, Stack, Widget
 
+from ._base import get_fields, set_fields
 from ._config import default_style
 
 
@@ -49,3 +50,17 @@ def value(self) -> Any:
     @value.setter
     def value(self, value: Any) -> None:
         self.wrapped.value = value
+
+    def set_fields(self, new_values: dict[str, Any]) -> None:
+        # Retrieve and set the enabled flag first
+        new_values = dict(new_values)
+        enabled_flag = new_values.pop('enabled', self.enabled)
+        if not isinstance(enabled_flag, bool):
+            raise ValueError(f"`enabled` must be a boolean, got {enabled_flag}")
+        self.enabled = enabled_flag
+        # Set the rest of the fields
+        set_fields(self.wrapped, new_values)
+
+    def get_fields(self) -> dict[str, Any]:
+        wrapped_fields = get_fields(self.wrapped)
+        return {'enabled': self.enabled, **(wrapped_fields or {})}

tests/widget_test.py

@@ -14,10 +14,12 @@
     FilenameParameter,
     MultiFilenameParameter,
     Parameter,
+    Vector3dParameter,
     parameter_registry,
 )
 from ess.reduce.ui import ResultBox, WorkflowWidget, workflow_widget
 from ess.reduce.widgets import OptionalWidget, SwitchWidget, create_parameter_widget
+from ess.reduce.widgets._base import WidgetWithFieldsProtocol, get_fields, set_fields
 from ess.reduce.workflow import register_workflow, workflow_registry
 
 SwitchableInt = NewType('SwitchableInt', int)
@@ -173,6 +175,46 @@ def test_switchable_optional_parameter_switchable_first() -> None:
     assert isinstance(dummy_widget.wrapped, OptionalWidget)
 
 
+def test_optional_widget_set_value_get_fields() -> None:
+    optional_param = IntParam('a', 'a', 1, optional=True)
+    optional_widget = create_parameter_widget(optional_param)
+    assert isinstance(optional_widget, WidgetWithFieldsProtocol)
+    assert isinstance(optional_widget, OptionalWidget)
+    # Check initial state
+    assert optional_widget._option_box.value is None
+    assert get_fields(optional_widget) == {'essreduce-opted-out': True, 'value': 1}
+    # Update the value of the wrapped widget and check the fields
+    set_fields(optional_widget, {'value': 2})
+    assert optional_widget.value is None  # Opted-out is not changed
+    assert get_fields(optional_widget) == {'essreduce-opted-out': True, 'value': 2}
+    optional_widget.value = 3
+    assert get_fields(optional_widget) == {'essreduce-opted-out': False, 'value': 3}
+
+
+def test_optional_widget_set_fields_get_fields() -> None:
+    optional_param = Vector3dParameter(
+        'a', 'a', sc.vector([1, 2, 3], unit='m'), optional=True
+    )
+    optional_widget = create_parameter_widget(optional_param)
+    assert isinstance(optional_widget, WidgetWithFieldsProtocol)
+    assert isinstance(optional_widget, OptionalWidget)
+    # Check initial state
+    assert optional_widget._option_box.value is None
+    expected = {'essreduce-opted-out': True, 'x': 1, 'y': 2, 'z': 3, 'unit': 'm'}
+    assert optional_widget.get_fields() == expected
+    # Update the value of the wrapped widget
+    optional_widget.set_fields(
+        {'essreduce-opted-out': True, 'x': 4, 'y': 5, 'z': 6, 'unit': 'm'}
+    )
+    assert optional_widget.value is None  # Opted-out is not changed
+    optional_widget.set_fields({'essreduce-opted-out': False})
+    assert optional_widget.value == sc.vector([4, 5, 6], unit='m')
+    # Check the fields and the option box value
+    expected = {'essreduce-opted-out': False, 'x': 4, 'y': 5, 'z': 6, 'unit': 'm'}
+    assert optional_widget.get_fields() == expected
+    assert optional_widget._option_box.value == optional_param.name
+
+
 def test_optional_widget_dispatch() -> None:
     optional_param = Parameter('a', 'a', 1, optional=True)
     assert isinstance(create_parameter_widget(optional_param), OptionalWidget)
@@ -431,6 +473,76 @@ def run_workflow():
     assert was_called
 
 
+def test_switchable_widget_set_values() -> None:
+    param = IntParam('a', 'a', 1, switchable=True)
+    widget = create_parameter_widget(param)
+    assert isinstance(widget, SwitchWidget)
+    assert not widget.enabled
+    widget.set_fields({'enabled': True})
+    assert widget.enabled
+    widget.set_fields({'enabled': False})
+    assert not widget.enabled
+    widget.set_fields({'enabled': True, 'value': 2})
+    assert widget.enabled
+    assert widget.value == 2
+    widget.set_fields({'enabled': False, 'value': 3})
+    assert not widget.enabled
+    assert widget.value == 3
+    widget.set_fields({'value': 4})
+    assert not widget.enabled
+    assert widget.value == 4
+
+
+def test_switchable_widget_get_fields_only_value() -> None:
+    param = IntParam('a', 'a', 1, switchable=True)
+    widget = create_parameter_widget(param)
+    assert isinstance(widget, SwitchWidget)
+    assert widget.get_fields() == {'enabled': False, 'value': 1}
+    widget.enabled = True
+    assert widget.get_fields() == {'enabled': True, 'value': 1}
+    widget.value = 2
+    assert widget.get_fields() == {'enabled': True, 'value': 2}
+    widget.enabled = False
+    assert widget.get_fields() == {'enabled': False, 'value': 2}
+
+
+def test_switchable_widget_set_fields() -> None:
+    param = Vector3dParameter('a', 'a', sc.vector([1, 2, 3], unit='m'), switchable=True)
+    widget = create_parameter_widget(param)
+    assert isinstance(widget, SwitchWidget)
+    assert not widget.enabled
+    assert widget.value == sc.vector([1, 2, 3], unit='m')
+    widget.set_fields({'enabled': True, 'x': 4, 'y': 5, 'z': 6, 'unit': 'm'})
+    assert widget.enabled
+    assert widget.value == sc.vector([4, 5, 6], unit='m')
+    widget.set_fields({'x': 7, 'y': 8})
+    assert widget.enabled
+    assert widget.value == sc.vector([7, 8, 6], unit='m')
+
+
+def test_switchable_widget_get_fields_sub_fields() -> None:
+    param = Vector3dParameter('a', 'a', sc.vector([1, 2, 3], unit='m'), switchable=True)
+    widget = create_parameter_widget(param)
+    assert isinstance(widget, SwitchWidget)
+    assert widget.get_fields() == {
+        'enabled': False,
+        'x': 1,
+        'y': 2,
+        'z': 3,
+        'unit': 'm',
+    }
+    widget.enabled = True
+    assert widget.get_fields() == {'enabled': True, 'x': 1, 'y': 2, 'z': 3, 'unit': 'm'}
+    widget.set_fields({'enabled': False, 'x': 4, 'y': 5, 'unit': 'mm'})
+    assert widget.get_fields() == {
+        'enabled': False,
+        'x': 4,
+        'y': 5,
+        'z': 3,
+        'unit': 'mm',
+    }
+
+
 FilenameSampleRun = NewType('FilenameSampleRun', str)
 parameter_registry[FilenameSampleRun] = FilenameParameter.from_type(
     FilenameSampleRun, default="SampleRun.hdf"