overhaul of parameters panel_parameters property in CodeExercise and ParameterPanel

* panel_parameters returns now only parameters that are tunable in the panel
* parameter now returns all parameters

Author: agoscinski

src/scwidgets/code/_widget_parameter_panel.py

@@ -1,6 +1,6 @@
 from typing import Callable, Dict, List, Union
 
-from ipywidgets import Output, VBox, Widget, interactive
+from ipywidgets import Output, VBox, Widget, fixed, interactive
 from traitlets.utils.sentinel import Sentinel
 
 from ..check import Check
@@ -52,15 +52,28 @@ def parameters_trait(self) -> List[str]:
 
     @property
     def parameters(self) -> dict:
+        """
+        :return: All parameters that were given on input are returned. Including also
+            fixed parameters.
+        """
         return self._interactive_widget.kwargs.copy()
 
     @parameters.setter
     def parameters(self, parameters: dict):
-        # self._interactive_widget.kwargs is not sync with the trait
-        # we assume that kwargs has the same order as in the widget children
-        # to change the value of the children
-        for i, key in enumerate(self._interactive_widget.kwargs):
-            self._interactive_widget.children[i].value = parameters[key]
+        for i, key in enumerate(self._interactive_widget.kwargs.keys()):
+            self._interactive_widget.kwargs_widgets[i].value = parameters[key]
+
+    @property
+    def panel_parameters(self) -> dict:
+        """
+        :return: Only parameters that are tunable in the parameter panel are returned.
+            Fixed parameters are ignored.
+        """
+        return {
+            key: self._interactive_widget.kwargs_widgets[i].value
+            for i, key in enumerate(self._interactive_widget.kwargs.keys())
+            if not (isinstance(self._interactive_widget.kwargs_widgets[i], fixed))
+        }
 
     def observe_parameters(
         self,

src/scwidgets/exercise/_widget_code_exercise.py

@@ -149,16 +149,12 @@ def __init__(
         self._output = CueOutput()
 
         self._parameter_panel: Union[ParameterPanel, None]
-        self._parameters: Union[dict, None]
         if isinstance(parameters, dict):
             self._parameter_panel = ParameterPanel(**parameters)
-            self._parameters = self._parameter_panel.parameters
         elif isinstance(parameters, ParameterPanel):
             self._parameter_panel = parameters
-            self._parameters = self._parameter_panel.parameters
         else:
             self._parameter_panel = None
-            self._parameters = None
 
         self._cue_code = self._code
         self._cue_outputs = cue_outputs
@@ -476,6 +472,21 @@ def answer(self, answer: dict):
 
     @property
     def panel_parameters(self) -> Dict[str, Check.FunInParamT]:
+        """
+        :return: Only parameters that are tunable in the parameter panel are returned.
+            Fixed parameters are ignored.
+        """
+        if self._parameter_panel is not None:
+            parameter_panel = self._parameter_panel
+            return parameter_panel.panel_parameters
+        return {}
+
+    @property
+    def parameters(self) -> Dict[str, Check.FunInParamT]:
+        """
+        :return: All parameters that were given on input are returned. Including also
+            fixed parameters.
+        """
         if self._parameter_panel is not None:
             parameter_panel = self._parameter_panel
             return parameter_panel.parameters
@@ -623,7 +634,7 @@ def _on_click_update_action(self) -> bool:
                 if self._update_func is not None:
                     self._update_func(self)
                 elif self._code is not None:
-                    self.run_code(**self.panel_parameters)
+                    self.run_code(**self.parameters)
 
                 for cue_output in self.cue_outputs:
                     if hasattr(cue_output, "draw_display"):

tests/test_code.py

@@ -103,7 +103,7 @@ def get_code_exercise(
         parameters = None
 
     def update_print(code_ex: CodeExercise):
-        output = code_ex.run_code(**code_ex.panel_parameters)
+        output = code_ex.run_code(**code_ex.parameters)
         code_ex.cue_outputs[0].display_object = f"Output:\n{output}"
 
     code_ex = CodeExercise(
@@ -198,7 +198,7 @@ def test_compute_and_set_references(self, code_ex):
         ],
     )
     def test_run_code(self, code_ex):
-        output = code_ex.run_code(**code_ex.panel_parameters)
+        output = code_ex.run_code(**code_ex.parameters)
         assert np.allclose((output,), code_ex.checks[0].outputs_references[0])
 
     @pytest.mark.parametrize(
@@ -214,4 +214,4 @@ def test_erroneous_run_code(self, code_ex):
             CodeValidationError,
             match="NameError in code input: name 'bug' is not defined.*",
         ):
-            code_ex.run_code(**code_ex.panel_parameters)
+            code_ex.run_code(**code_ex.parameters)