Parameter Fitter: Allow dots in sequences

Author: janezd

Orange/widgets/evaluate/owparameterfitter.py

@@ -21,6 +21,7 @@
 from Orange.util import dummy_callback
 from Orange.widgets import gui
 from Orange.widgets.settings import Setting
+from Orange.widgets.utils import userinput
 from Orange.widgets.utils.concurrent import ConcurrentWidgetMixin, TaskState
 from Orange.widgets.utils.multi_target import check_multiple_targets_input
 from Orange.widgets.utils.widgetpreview import WidgetPreview
@@ -332,10 +333,7 @@ class Error(OWWidget.Error):
         unknown_err = Msg("{}")
         not_enough_data = Msg(f"At least {N_FOLD} instances are needed.")
         incompatible_learner = Msg("{}")
-        manual_steps_error = Msg("Invalid list of values for {}:\n{}")
-        manual_invalid_minmax = Msg("Value for {} must be between {} and {}")
-        manual_invalid_minimum = Msg("Value for {} must be at least {}")
-        manual_invalid_maximum = Msg("Value for {} must be at most {}")
+        manual_steps_error = Msg("Invalid values for '{}': {}")
         min_max_error = Msg("Minimum must be less than maximum.")
 
     class Warning(OWWidget.Warning):
@@ -404,7 +402,7 @@ def _add_controls(self):
         gui.appendRadioButton(buttons, "Manual:")
         layout.addWidget(buttons, 4, 0)
         self.edit = gui.lineEdit(None, self, "manual_steps",
-                            placeholderText="10, 20, 30",
+                            placeholderText="e.g. 10, 20, ..., 50",
                             callback=self.__on_manual_changed)
         layout.addWidget(self.edit, 4, 1)
 
@@ -461,19 +459,16 @@ def initial_parameters(self) -> dict:
         return self._learner.params
 
     @property
-    def steps(self) -> tuple[int]:
+    def steps(self) -> tuple[int, ...]:
         self.Error.min_max_error.clear()
         self.Error.manual_steps_error.clear()
-        self.Error.manual_invalid_minimum.clear()
-        self.Error.manual_invalid_maximum.clear()
-        self.Error.manual_invalid_minmax.clear()
 
         if self.type == self.FROM_RANGE:
             return self._steps_from_range()
         else:
             return self._steps_from_manual()
 
-    def _steps_from_range(self) -> tuple[int]:
+    def _steps_from_range(self) -> tuple[int, ...]:
         if self.maximum < self.minimum:
             self.Error.min_max_error()
             return ()
@@ -491,29 +486,14 @@ def _steps_from_range(self) -> tuple[int]:
 
     def _steps_from_manual(self) -> tuple[int, ...]:
         param = self.fitted_parameters[self.parameter_index]
-        steps = self.manual_steps
-        if not steps:
-            return ()
         try:
-            steps = tuple(sorted(set(map(int, steps.split(",")))))
-        except ValueError as exc:
-            self.Error.manual_steps_error(param.name, exc)
-            return ()
-
-        self.manual_steps = ", ".join(map(str, steps))
-
-        under = param.min is not None and steps[0] < param.min
-        over = param.max is not None and steps[-1] > param.max
-        if under or over:
-            if under and over:
-                self.Error.manual_invalid_minmax(param.name, param.min, param.max)
-            elif under:
-                self.Error.manual_invalid_minimum(param.name, param.min)
-            else:
-                assert over
-                self.Error.manual_invalid_maximum(param.name, param.max)
+            steps = userinput.numbers_from_list(
+                self.manual_steps, int, param.min, param.max)
+        except ValueError as ex:
+            self.Error.manual_steps_error(param.label, ex)
             return ()
-
+        if steps and "..." not in self.manual_steps:
+            self.manual_steps = ", ".join(map(str, steps))
         return steps
 
     @Inputs.data
@@ -589,7 +569,7 @@ def _set_range_controls(self):
                 self.__spin_max.setMaximum(MIN_MAX_SPIN)
                 self.maximum = self.initial_parameters[param.name]
 
-        tip = "Enter a list of comma-separated values"
+        tip = "Enter a list of values"
         if param.min is not None:
             if param.max is not None:
                 self.edit.setToolTip(f"{tip} between {param.min} and {param.max}.")

Orange/widgets/evaluate/tests/test_owparameterfitter.py

@@ -137,15 +137,13 @@ def test_manual_steps(self):
     def test_manual_steps_limits(self):
         w = self.widget
 
-        def test_errors(act):
-            err = w.Error
-            for error in (err.manual_steps_error, err.manual_invalid_minmax,
-                          err.manual_invalid_minimum, err.manual_invalid_maximum):
-                self.assertIs(error.is_shown(), error is act)
-
-        def enter(text):
-            w.controls.manual_steps.setText(text)
-            w.controls.manual_steps.returnPressed.emit()
+        def check(cases):
+            for setting, steps in cases:
+                w.controls.manual_steps.setText(setting)
+                w.controls.manual_steps.returnPressed.emit()
+                self.assertEqual(w.steps, steps, f"setting: {setting}")
+                self.assertIs(w.Error.manual_steps_error.is_shown(), not steps,
+                              f"setting: {setting}")
 
         self.send_signal(w.Inputs.data, self._housing)
         self.send_signal(w.Inputs.learner, self._dummy)
@@ -154,61 +152,37 @@ def enter(text):
         # 5 to None
         simulate.combobox_activate_index(w.controls.parameter_index, 0)
         self.wait_until_finished()
-
-        enter("6, 9, 7")
-        self.assertEqual(w.steps, (6, 7, 9))
-        test_errors(None)
-
-        enter("6, 9, 7, 3")
-        self.assertEqual(w.steps, ())
-        test_errors(w.Error.manual_invalid_minimum)
-
-        enter("6, 9, 7")
-        self.assertEqual(w.steps, (6, 7, 9))
-        test_errors(None)
-
-        enter("6, 9, 7, 3")
+        check([("6, 9, 7", (6, 7, 9)),
+               ("6, 9, 7, 3", ()),
+               ("6, 9, 7", (6, 7, 9)),
+               ("6, 9, 7, 3", ())])
 
         # None to 10
         simulate.combobox_activate_index(w.controls.parameter_index, 2)
         self.wait_until_finished()
+        self.assertFalse(w.Error.manual_steps_error.is_shown())
 
-        test_errors(None)
-
-        enter("12, 1, 3, -5")
-        self.assertEqual(w.steps, ())
-        test_errors(w.Error.manual_invalid_maximum)
-
-        enter("1, 3, -5")
-        self.assertEqual(w.steps, (-5, 1, 3))
-        test_errors(None)
-
-        enter("12, 1, 3, -5")
+        check([("12, 1, 3, -5", ()),
+               ("1, 3, -5", (-5, 1, 3)),
+               ("12, 1, 3, -5", ())])
 
         # No limits
         simulate.combobox_activate_index(w.controls.parameter_index, 3)
         self.wait_until_finished()
+
         self.assertEqual(w.steps, (-5, 1, 3, 12))
-        test_errors(None)
+        self.assertFalse(w.Error.manual_steps_error.is_shown())
 
         # 5 to 10
         simulate.combobox_activate_index(w.controls.parameter_index, 1)
         self.wait_until_finished()
 
         self.assertEqual(w.steps, ())
-        test_errors(w.Error.manual_invalid_minmax)
-
-        enter("12, 8, 7, 5")
-        self.assertEqual(w.steps, ())
-        test_errors(w.Error.manual_invalid_maximum)
-
-        enter("8, 7, -5")
-        self.assertEqual(w.steps, ())
-        test_errors(w.Error.manual_invalid_minimum)
+        self.assertTrue(w.Error.manual_steps_error.is_shown())
 
-        enter("8, 7, 5")
-        self.assertEqual(w.steps, (5, 7, 8))
-        test_errors(None)
+        check([("12, 8, 7, 5", ()),
+               ("8, 7, -5", ()),
+                ("8, 7, 5", (5, 7, 8))])
 
     def test_steps_preview(self):
         self.send_signal(self.widget.Inputs.data, self._housing)
@@ -443,7 +417,7 @@ def test_steps_from_manual_error(self):
         self.send_signal(w.Inputs.learner, None)
         self.assertFalse(w.Error.manual_steps_error.is_shown())
 
-    def test_steps_from_manual(self):
+    def test_steps_from_manual_no_dots(self):
         w: OWParameterFitter = self.widget
         self.send_signal(w.Inputs.data, self._housing)
         self.send_signal(w.Inputs.learner, self._dummy)
@@ -460,6 +434,104 @@ def test_steps_from_manual(self):
         w.manual_steps = "1, 2, 10,   3, 4, 123, 5, 6"
         self.assertEqual(w.steps, (1, 2, 3, 4, 5, 6, 10, 123))
 
+    def test_steps_from_manual_dots(self):
+        def check(cases):
+            for settings, steps in cases:
+                w.manual_steps = settings
+                self.assertEqual(w.steps, steps, f"setting: {settings}")
+                self.assertIs(w.Error.manual_steps_error.is_shown(), not steps,
+                              f"setting: {settings}")
+
+        w: OWParameterFitter = self.widget
+        self.send_signal(w.Inputs.data, self._housing)
+        self.send_signal(w.Inputs.learner, self._dummy)
+        self.wait_until_finished()
+        w.type = w.MANUAL
+
+        # No limits
+        simulate.combobox_activate_index(w.controls.parameter_index, 3)
+        self.wait_until_finished()
+        check([("1, 2, ..., 5", (1, 2, 3, 4, 5)),
+               ("1, 2, 3, ..., 5, 6, 7", (1, 2, 3, 4, 5, 6, 7)),
+               ("3, ..., 5, 6", (3, 4, 5, 6)),
+               ("..., 5, 6", ()),
+               ("5, 6, ...", ()),
+               ("1, 2, 3, 4, 5, ...", ()),
+               ("1, ..., 5", ()),
+               ("1, 2, ..., 5, 6, ..., 8", ())])
+
+        # 5 to 10
+        simulate.combobox_activate_index(w.controls.parameter_index, 1)
+        self.wait_until_finished()
+        check([("4, 5, ..., 8", ()),
+               ("5, 6, ..., 12", ()),
+               ("5, 6, ..., 9", (5, 6, 7, 8, 9)),
+               ("6, 7, ..., 9", (6, 7, 8, 9)),
+               ("6, 7, ..., 8, 9", (6, 7, 8, 9)),
+               ("..., 8, 9", (5, 6, 7, 8, 9)),
+               ("6, 7, ...", (6, 7, 8, 9, 10)),
+               ("6, 7, 8, 9, ...", (6, 7, 8, 9, 10)),
+               ("..., 8, 9", (5, 6, 7, 8, 9)),
+               ])
+
+        # 5 to None
+        simulate.combobox_activate_index(w.controls.parameter_index, 0)
+        self.wait_until_finished()
+        check([("4, 5, ..., 8", ()),
+               ("5, 6, ..., 12", (5, 6, 7, 8, 9, 10, 11, 12)),
+               ("6, 7, ..., 9", (6, 7, 8, 9)),
+               ("6, 7, ..., 8, 9", (6, 7, 8, 9)),
+               ("..., 8, 9", (5, 6, 7, 8, 9)),
+               ("6, 7, ...", ())
+               ])
+
+        # None to 10
+        simulate.combobox_activate_index(w.controls.parameter_index, 2)
+        self.wait_until_finished()
+        check([("4, 5, ..., 8", (4, 5, 6, 7, 8)),
+               ("5, 6, ..., 12", ()),
+               ("5, 6, ..., 9", (5, 6, 7, 8, 9)),
+               ("6, 7, ..., 9", (6, 7, 8, 9)),
+               ("..., 8, 9", ()),
+               ("6, 7, ...", (6, 7, 8, 9, 10)),
+               ("6, 7, 8, 9, ...", (6, 7, 8, 9, 10)),
+               ("..., 8, 9", ()),
+               ])
+
+    def test_steps_from_manual_dots_corrections(self):
+        w: OWParameterFitter = self.widget
+        self.send_signal(w.Inputs.data, self._housing)
+        self.send_signal(w.Inputs.learner, self._dummy)
+        self.wait_until_finished()
+        w.type = w.MANUAL
+
+        # 5 to 10
+        simulate.combobox_activate_index(w.controls.parameter_index, 1)
+        self.wait_until_finished()
+
+        for settings, steps in [
+            ("5, 6..., 8", (5,6,7,8)),
+            ("5,6...,8", (5,6,7,8)),
+            ("5,6...8", (5,6,7,8)),
+            ("5,   6  ...  8", (5,6,7,8)),
+            ("5,   6  ...  8", (5,6,7,8)),
+            ("5,   6  ...  ", (5,6,7,8,9,10)),
+            ("..., 7, 8", (5,6,7,8)),
+            ("..., 7, 8, ...", ()),
+            ("5, 6, ..., 7, 8, ...", ()),
+            ("5, 6, 8, ...", ()),
+            ("5, 6, 8, ...", ()),
+            ("5, 6, ..., 8, 10", ()),
+            ("5, 7, ..., 8, 10", ()),
+            ("8, 7, 6, ...", ()),
+            ("5, 6, 7, ..., 7, 8", ()),
+        ]:
+            w.manual_steps = settings
+            self.assertEqual(w.steps, steps, f"setting: {settings}")
+            self.assertIs(w.Error.manual_steps_error.is_shown(), not steps,
+                           f"setting: {settings}")
+
+
     def test_manual_tooltip(self):
         w: OWParameterFitter = self.widget
         self.send_signal(w.Inputs.data, self._housing)
@@ -478,5 +550,6 @@ def test_manual_tooltip(self):
         simulate.combobox_activate_index(w.controls.parameter_index, 3)
         self.assertEqual("", w.edit.toolTip())
 
+
 if __name__ == "__main__":
     unittest.main()