fix: keep wizard candidate color stable

Author: rossant

phy/cluster/supervisor.py

@@ -1118,7 +1118,8 @@ def _clusters_selected(self, sender, obj, **kwargs):
             return
         cluster_ids = obj['selected']
         next_cluster = obj['next']
-        kwargs = obj.get('kwargs', {})
+        kwargs = dict(obj.get('kwargs', {}))
+        kwargs.pop('_selection_intent', None)
         logger.debug('Clusters selected: %s (%s)', cluster_ids, next_cluster)
         change = self.selection.set_normal_selection(cluster_ids)
         change = self._set_table_presentation_order(change)
@@ -1147,12 +1148,16 @@ def _similar_selected(self, sender, obj):
             return
         similar = obj['selected']
         next_similar = obj['next']
-        kwargs = obj.get('kwargs', {})
+        kwargs = dict(obj.get('kwargs', {}))
+        selection_intent = kwargs.pop('_selection_intent', None)
         logger.debug('Similar clusters selected: %s (%s)', similar, next_similar)
         presentation_order = self._presentation_order_from_tables(
             self.selection.state, similar_ids=similar
         )
-        self.selection.set_similarity_selection(similar, presentation_order)
+        if selection_intent == 'navigation' and not self.selection.state.is_merge_mode:
+            self.selection.navigate_similarity_selection(similar, presentation_order)
+        else:
+            self.selection.set_similarity_selection(similar, presentation_order)
         self._update_selection_colors()
         self._project_merge_view()
         self.task_logger.log(self.similarity_view, 'select', similar, output=obj)

phy/cluster/tests/test_supervisor.py

@@ -610,6 +610,14 @@ def test_merge_mode_next_navigates_similarity_not_cluster(supervisor):
     assert supervisor.selection.state.merge is before.merge
     assert supervisor.selected_clusters == []
     assert len(supervisor.selected_similar) == 1
+    first_candidate = supervisor.selected_similar[0]
+    first_colors = supervisor.selection_color_order
+
+    supervisor.next()
+    supervisor.block()
+
+    assert supervisor.selection_color_order[: len(first_colors)] == first_colors
+    assert supervisor.selected_similar != [first_candidate]
 
 
 def test_merge_mode_merge_undo_redo_restores_workspace(supervisor):
@@ -1735,19 +1743,26 @@ def test_supervisor_reset(qtbot, supervisor):
     supervisor.select_actions.next()
     supervisor.block()
     _assert_selected(supervisor, [30, 20])
+    assert supervisor.similarity_view._selected_color_index(20) == 1
 
     supervisor.select_actions.next()
     supervisor.block()
     _assert_selected(supervisor, [30, 11])
+    assert supervisor.similarity_view._selected_color_index(11) == 1
 
     supervisor.select_actions.previous()
     supervisor.block()
     _assert_selected(supervisor, [30, 20])
+    assert supervisor.similarity_view._selected_color_index(20) == 1
 
     supervisor.select_actions.unselect_similar()
     supervisor.block()
     _assert_selected(supervisor, [30])
 
+    supervisor.select_actions.next()
+    supervisor.block()
+    assert supervisor.similarity_view._selected_color_index(supervisor.selected_similar[0]) == 1
+
 
 def test_supervisor_nav(qtbot, supervisor):
     supervisor.select_actions.reset_wizard()

phy/gui/tests/test_widgets.py

@@ -494,13 +494,23 @@ def test_table_nav_last(qtbot, table):
 
 
 def test_table_nav_0(qtbot, table):
+    payloads = []
+
+    @connect(event='select', sender=table)
+    def on_select(sender, obj):
+        payloads.append(obj)
+
     table.select([4])
+    assert payloads[-1]['kwargs'] == {}
 
     table.next()
     _assert(table.get_selected, [6])
+    assert payloads[-1]['kwargs'] == {'_selection_intent': 'navigation'}
 
     table.previous()
     _assert(table.get_selected, [4])
+    assert payloads[-1]['kwargs'] == {'_selection_intent': 'navigation'}
+    unconnect(on_select)
 
 
 def test_table_navigation_skip_masked_policy(qtbot, table):

phy/gui/widgets.py

@@ -1315,18 +1315,18 @@ def get_sibling_id(self, row_id=None, direction='next'):
 
     def _move_to_sibling(self, row_id=None, direction='next'):
         if not self.get_selected_ids():
-            return self._select_first_or_last('first')
+            return self._select_first_or_last('first', _selection_intent='navigation')
         new_id = self.get_sibling_id(row_id, direction)
         if new_id is None:
             return None
-        return self.select([new_id])
+        return self.select([new_id], _selection_intent='navigation')
 
-    def _select_first_or_last(self, which):
+    def _select_first_or_last(self, which, **kwargs):
         visible = self._visible_ids()
         ordered = visible if which == 'first' else list(reversed(visible))
         for row_id in ordered:
             if self._is_navigable_id(row_id):
-                return self.select([row_id])
+                return self.select([row_id], **kwargs)
         return None
 
     def sort_by(self, name, sort_dir='asc'):