Refactor start()

Author: VesnaT

Orange/widgets/utils/concurrent.py

@@ -832,7 +832,7 @@ def is_interruption_requested(self) -> bool:
         return self.__interruption_requested
 
     def start(self, executor: concurrent.futures.Executor,
-              func: Callable[[], Any]=None) -> Future:
+              func: Callable[[], Any] = None) -> Future:
         assert self.future is None
         assert not self.__interruption_requested
         self.__future = executor.submit(func)
@@ -863,15 +863,11 @@ def __init__(self):
     def task(self) -> TaskState:
         return self.__task
 
-    def _prepare_task(self, state: TaskState) -> Callable[[], Any]:
-        raise NotImplementedError
-
     def _on_partial_result(self, result: Any) -> None:
         raise NotImplementedError
 
     def _on_done(self, result: Any) -> None:
-        # NOTE: All of these have already been set by _on_partial_result,
-        # we double check that they are aliases
+        """ Invoked when task is done. """
         raise NotImplementedError
 
     def __set_state_ready(self):
@@ -893,7 +889,7 @@ def __start_task(self, task: Callable[[], Any], state: TaskState):
         state.setParent(self)
         self.__task = state
 
-    def __cancel_task(self, wait: bool=True):
+    def __cancel_task(self, wait: bool = True):
         if self.__task is not None:
             state, self.__task = self.__task, None
             state.cancel()
@@ -909,7 +905,6 @@ def __cancel_task(self, wait: bool=True):
                 w.done.connect(state.deleteLater)
 
     def __on_task_done(self, future: Future):
-        """ Invoked when task is done. """
         assert future.done()
         assert self.__task is not None
         assert self.__task.future is future
@@ -920,16 +915,18 @@ def __on_task_done(self, future: Future):
         result = future.result()
         self._on_done(result)
 
-    def start(self):
+    def start(self, task: Callable, *args):
         """ Call to start the task. """
         self.__cancel_task(wait=False)
 
         if self.data is None:
             self.__set_state_ready()
             return
 
+        assert callable(task), "`task` must be callable!"
         state = TaskState(self)
-        task = self._prepare_task(state)
+        task = partial(task, *(args + (state,)))
+
         self.__set_state_busy()
         self.__start_task(task, state)
 

Orange/widgets/utils/tests/concurrent_example.py

@@ -1,7 +1,6 @@
 # pylint: disable=too-many-ancestors
 from typing import Optional
 from types import SimpleNamespace as namespace
-from functools import partial
 
 import numpy as np
 
@@ -28,8 +27,6 @@ def run(data: Table, embedding: Optional[np.ndarray], state: TaskState):
             x_data = np.array(np.mean(data.X, axis=1))
             if x_data.ndim == 2:
                 x_data = x_data.ravel()
-            y_data = np.ones(len(x_data))
-            y_data[::2] = step % 2
             y_data = np.random.rand(len(x_data))
             # Needs a copy because projection should not be modified
             # inplace. If it is modified inplace, the widget and the thread
@@ -70,7 +67,7 @@ def _add_controls(self):
         super()._add_controls()
 
     def __param_combo_changed(self):
-        super().start()
+        self._run()
 
     def _toggle_run(self):
         if self.data is None:
@@ -83,12 +80,13 @@ def _toggle_run(self):
             self.commit()
         # Resume task
         else:
-            self.start()
+            self._run()
 
-    # extend ConcurrentWidgetMixin
-    def _prepare_task(self, state: TaskState):
-        return partial(run, self.data, embedding=self.embedding, state=state)
+    def _run(self):
+        self.run_button.setText("Stop")
+        self.start(run, self.data, self.embedding)
 
+    # ConcurrentWidgetMixin
     def _on_partial_result(self, result: Result):
         assert isinstance(result.embedding, np.ndarray)
         assert len(result.embedding) == len(self.data)
@@ -101,21 +99,19 @@ def _on_partial_result(self, result: Result):
             self.graph.update_density()
 
     def _on_done(self, result: Result):
+        # NOTE: All of these have already been set by _on_partial_result,
+        # we double check that they are aliases
         assert isinstance(result.embedding, np.ndarray)
         assert len(result.embedding) == len(self.data)
         self.embedding = result.embedding
         self.run_button.setText("Start")
         self.commit()
 
-    def start(self):
-        self.run_button.setText("Stop")
-        super().start()
-
-    # extend OWDataProjectionWidget
+    # OWDataProjectionWidget
     def set_data(self, data: Table):
         super().set_data(data)
         if self._invalidated:
-            self.start()
+            self._run()
 
     def get_embedding(self):
         if self.embedding is None:

Orange/widgets/visualize/owfreeviz.py

@@ -1,7 +1,6 @@
 # pylint: disable=too-many-ancestors
 from enum import IntEnum
 from types import SimpleNamespace as namespace
-from functools import partial
 
 import numpy as np
 
@@ -187,7 +186,7 @@ def __init_combo_changed(self):
         self.setup_plot()
         self.commit()
         if self.task is not None:
-            super().start()
+            self._run()
 
     def _toggle_run(self):
         if self.data is None:
@@ -199,15 +198,15 @@ def _toggle_run(self):
             self.run_button.setText("Resume")
             self.commit()
         else:
-            self.start()
+            self._run()
 
-    # extend ConcurrentWidgetMixin
-    def _prepare_task(self, state: TaskState):
-        return partial(run_freeviz, self.effective_data,
-                       projector=self.projector,
-                       projection=self.projection,
-                       state=state)
+    def _run(self):
+        self.graph.set_sample_size(self.SAMPLE_SIZE)
+        self.run_button.setText("Stop")
+        self.start(run_freeviz, self.effective_data,
+                   self.projector, self.projection)
 
+    # ConcurrentWidgetMixin
     def _on_partial_result(self, result: Result):
         assert isinstance(result.projector, FreeViz)
         assert isinstance(result.projection, FreeVizModel)
@@ -225,10 +224,26 @@ def _on_done(self, results: Result):
         self.run_button.setText("Start")
         self.commit()
 
-    def start(self):
-        self.graph.set_sample_size(self.SAMPLE_SIZE)
-        self.run_button.setText("Stop")
-        super().start()
+    # OWAnchorProjectionWidget
+    def set_data(self, data):
+        super().set_data(data)
+        if self._invalidated:
+            self.init_projection()
+
+    def init_projection(self):
+        if self.data is None:
+            return
+        anchors = FreeViz.init_radial(len(self.effective_variables)) \
+            if self.initialization == InitType.Circular \
+            else FreeViz.init_random(len(self.effective_variables), 2)
+        self.projector = FreeViz(scale=False, center=False,
+                                 initial=anchors, maxiter=10)
+        data = self.projector.preprocess(self.effective_data)
+        self.projector.domain = data.domain
+        self.projector.components_ = anchors.T
+        self.projection = FreeVizModel(self.projector, self.projector.domain, 2)
+        self.projection.pre_domain = data.domain
+        self.projection.name = self.projector.name
 
     def check_data(self):
         def error(err):
@@ -255,26 +270,6 @@ def error(err):
                     self.Warning.removed_features()
         self.run_button.setEnabled(self.data is not None)
 
-    def set_data(self, data):
-        super().set_data(data)
-        if self._invalidated:
-            self.init_projection()
-
-    def init_projection(self):
-        if self.data is None:
-            return
-        anchors = FreeViz.init_radial(len(self.effective_variables)) \
-            if self.initialization == InitType.Circular \
-            else FreeViz.init_random(len(self.effective_variables), 2)
-        self.projector = FreeViz(scale=False, center=False,
-                                 initial=anchors, maxiter=10)
-        data = self.projector.preprocess(self.effective_data)
-        self.projector.domain = data.domain
-        self.projector.components_ = anchors.T
-        self.projection = FreeVizModel(self.projector, self.projector.domain, 2)
-        self.projection.pre_domain = data.domain
-        self.projection.name = self.projector.name
-
     def get_coordinates_data(self):
         embedding = self.get_embedding()
         if embedding is None: