Merge pull request #3957 from janezd/retain-selection

[FIX] Fix storing and retrieving selection, and unconditional auto commit

Author: VesnaT

Orange/widgets/data/owtable.py

@@ -536,7 +536,7 @@ def update(_):
             self.selected_cols = []
 
         self.set_selection()
-        self.commit()
+        self.unconditional_commit()
 
     def _setup_table_view(self, view, data):
         """Setup the `view` (QTableView) with `data` (Orange.data.Table)

Orange/widgets/data/tests/test_owtable.py

@@ -1,4 +1,5 @@
-from unittest.mock import Mock
+import unittest
+from unittest.mock import Mock, patch
 
 from Orange.widgets.data.owtable import OWDataTable
 from Orange.widgets.tests.base import WidgetTest, WidgetOutputsTestMixin
@@ -57,3 +58,14 @@ def test_attrs_appear_in_corner_text(self):
         # false positive, pylint: disable=unsubscriptable-object
         self.assertEqual(
             self.widget.set_corner_text.call_args[0][1], "\na\nb\nc")
+
+    def test_unconditional_commit_on_new_signal(self):
+        with patch.object(self.widget, 'unconditional_commit') as commit:
+            self.widget.auto_commit = False
+            commit.reset_mock()
+            self.send_signal(self.widget.Inputs.data, self.data)
+            commit.assert_called()
+
+
+if __name__ == "__main__":
+    unittest.main()

Orange/widgets/tests/base.py

@@ -614,7 +614,7 @@ def test_plot_once(self, timeout=DEFAULT_TIMEOUT):
         """Test if data is plotted only once but committed on every input change"""
         table = Table("heart_disease")
         self.widget.setup_plot = Mock()
-        self.widget.commit = Mock()
+        self.widget.commit = self.widget.unconditional_commit = Mock()
         self.send_signal(self.widget.Inputs.data, table)
         self.widget.setup_plot.assert_called_once()
         self.widget.commit.assert_called_once()

Orange/widgets/unsupervised/owdistancemap.py

@@ -225,6 +225,16 @@ def selections(self):
                  range(r.left(), r.right() + 1))
                 for r in selections]
 
+    def set_selections(self, ranges):
+        self.__clearSelections()
+        for y, x in ranges:
+            area = QRectF(x.start, y.start,
+                          x.stop - x.start - 1, y.stop - y.start - 1)
+            item = DistanceMapItem.SelectionRect(area, self)
+            item.setPen(QPen(Qt.red, 0))
+            self.__selections.append((item, area))
+        self.selectionChanged.emit()
+
     def hoverMoveEvent(self, event):
         super().hoverMoveEvent(event)
         i, j = self._cellAt(event.pos())
@@ -268,6 +278,7 @@ class Outputs:
     color_high = settings.Setting(1.0)
 
     annotation_idx = settings.ContextSetting(0)
+    pending_selection = settings.Setting(None, schema_only=True)
 
     autocommit = settings.Setting(True)
 
@@ -393,6 +404,14 @@ def __init__(self):
 
         self.grid_widget.scene().installEventFilter(self)
 
+        self.settingsAboutToBePacked.connect(self.pack_settings)
+
+    def pack_settings(self):
+        if self.matrix_item is not None:
+            self.pending_selection = self.matrix_item.selections()
+        else:
+            self.pending_selection = None
+
     @Inputs.distances
     def set_distances(self, matrix):
         self.closeContext()
@@ -473,6 +492,9 @@ def handleNewSignals(self):
             self._update_ordering()
             self._setup_scene()
             self._update_labels()
+            if self.pending_selection is not None:
+                self.matrix_item.set_selections(self.pending_selection)
+                self.pending_selection = None
         self.unconditional_commit()
 
     def _clear_plot(self):

Orange/widgets/unsupervised/tests/test_owdistancemap.py

@@ -1,6 +1,8 @@
 # Test methods with long descriptive names can omit docstrings
 # pylint: disable=missing-docstring
 import random
+import unittest
+
 from Orange.distance import Euclidean
 from Orange.widgets.unsupervised.owdistancemap import OWDistanceMap
 from Orange.widgets.tests.base import WidgetTest, WidgetOutputsTestMixin
@@ -24,3 +26,20 @@ def _select_data(self):
         self.widget._selection = selected_indices
         self.widget.commit()
         return selected_indices
+
+    def test_saved_selection(self):
+        self.widget.settingsHandler.pack_data(self.widget)
+        # no assert here, just test is doesn't crash on empty
+
+        self.send_signal(self.signal_name, self.signal_data)
+        random.seed(42)
+        self.widget.matrix_item.set_selections([(range(5, 10), range(8, 15))])
+        settings = self.widget.settingsHandler.pack_data(self.widget)
+
+        w = self.create_widget(OWDistanceMap, stored_settings=settings)
+        self.send_signal(self.signal_name, self.signal_data)
+        self.assertEqual(len(self.get_output(w.Outputs.selected_data)), 10)
+
+
+if __name__ == "__main__":
+    unittest.main()

Orange/widgets/unsupervised/tests/test_owmds.py

@@ -53,7 +53,7 @@ def test_plot_once(self, timeout=5000):
         """Test if data is plotted only once but committed on every input change"""
         table = Table("heart_disease")
         self.widget.setup_plot = Mock()
-        self.widget.commit = Mock()
+        self.widget.commit = self.widget.unconditional_commit = Mock()
         self.send_signal(self.widget.Inputs.data, table)
         self.widget.commit.reset_mock()
         self.wait_until_stop_blocking()

Orange/widgets/unsupervised/tests/test_owtsne.py

@@ -211,7 +211,7 @@ def _check_exaggeration(call, exaggeration):
     def test_plot_once(self):
         """Test if data is plotted only once but committed on every input change"""
         self.widget.setup_plot = Mock()
-        self.widget.commit = Mock()
+        self.widget.commit = self.widget.unconditional_commit = Mock()
 
         self.send_signal(self.widget.Inputs.data, self.data)
         # TODO: The base widget immediately calls `setup_plot` and `commit`

Orange/widgets/utils/tests/test_concurrent_example.py

@@ -44,7 +44,7 @@ def test_button_toggle(self):
     def test_plot_once(self):
         table = Table("heart_disease")
         self.widget.setup_plot = Mock()
-        self.widget.commit = Mock()
+        self.widget.commit = self.widget.unconditional_commit = Mock()
         self.send_signal(self.widget.Inputs.data, table)
         self.widget.setup_plot.assert_called_once()
         self.widget.commit.assert_called_once()

Orange/widgets/visualize/owheatmap.py

@@ -427,6 +427,7 @@ class Outputs:
 
     palette_index = settings.Setting(_default_palette_index)
     column_label_pos = settings.Setting(PositionTop)
+    selected_rows = settings.Setting(None, schema_only=True)
 
     auto_commit = settings.Setting(True)
 
@@ -454,6 +455,7 @@ class Warning(widget.OWWidget.Warning):
 
     def __init__(self):
         super().__init__()
+        self.__pending_selection = self.selected_rows
 
         # set default settings
         self.space_x = 10
@@ -719,7 +721,14 @@ def set_dataset(self, data=None):
             self.openContext(self.data)
             if self.annotation_index >= len(self.annotation_vars):
                 self.annotation_index = 0
+
         self.update_heatmaps()
+        if data is not None and self.__pending_selection is not None:
+            self.selection_manager.select_rows(self.__pending_selection)
+            self.selected_rows = self.__pending_selection
+            self.__pending_selection = None
+
+        self.unconditional_commit()
 
     def update_heatmaps(self):
         if self.data is not None:
@@ -739,13 +748,13 @@ def update_heatmaps(self):
                 self.selected_rows = []
         else:
             self.clear()
-        self.commit()
 
     def update_merge(self):
         self.kmeans_model = None
         self.merge_indices = None
         if self.data is not None and self.merge_kmeans:
             self.update_heatmaps()
+            self.commit()
 
     def _make_parts(self, data, group_var=None, group_key=None):
         """
@@ -1393,9 +1402,11 @@ def update_color_schema(self):
 
     def update_sorting_examples(self):
         self.update_heatmaps()
+        self.commit()
 
     def update_clustering_examples(self):
         self.update_heatmaps()
+        self.commit()
 
     def update_legend(self):
         for item in self.heatmap_scene.items():

Orange/widgets/visualize/owlineplot.py

@@ -547,7 +547,7 @@ def set_data(self, data):
 
         self.openContext(data)
         self.setup_plot()
-        self.commit()
+        self.unconditional_commit()
 
     def check_data(self):
         def error(err):