Merge branch 'develop'

Author: whitews

src/flowkit/_models/gating_strategy.py

@@ -234,6 +234,7 @@ def rename_gate(self, gate_name, new_gate_name, gate_path=None):
         gate_node = self._get_gate_node(gate_name, gate_path=gate_path)
         gate = gate_node.gate
         orig_full_gate_path = tuple(n.name for n in gate_node.path)
+        new_full_gate_path = orig_full_gate_path[:-1] + (new_gate_name,)  # needed for updating Boolean refs later
 
         # check successors for any Boolean gates that reference the renamed gate
         # Note, these needs to be retrieved before modifying the gate name
@@ -244,15 +245,6 @@ def rename_gate(self, gate_name, new_gate_name, gate_path=None):
         # so clear cached events
         self.clear_cache()
 
-        # Need to change the gate node name & the gate's gate_name attribute
-        gate_node.name = new_gate_name
-        gate.gate_name = new_gate_name
-        new_full_gate_path = tuple(n.name for n in gate_node.path)
-
-        # check for custom gates, need to change those too
-        for custom_gate in gate_node.custom_gates.values():
-            custom_gate.gate_name = new_gate_name
-
         # Check successor gates for a Boolean gate.
         # If present, it references the renamed gate & that reference needs updating
         for s_tuple in successor_node_tuples:
@@ -287,6 +279,14 @@ def rename_gate(self, gate_name, new_gate_name, gate_path=None):
                     # Any other case, the reference gate path is longer than the modified gate,
                     # so not affected by the change.
 
+        # Need to change the gate node name & the gate's gate_name attribute
+        gate_node.name = new_gate_name
+        gate.gate_name = new_gate_name
+
+        # check for custom gates, need to change those too
+        for custom_gate in gate_node.custom_gates.values():
+            custom_gate.gate_name = new_gate_name
+
         # rebuild DAG
         self._rebuild_dag()
 

src/flowkit/_version.py

@@ -1,4 +1,4 @@
 """
 FlowKit version
 """
-__version__ = "1.2.1"
+__version__ = "1.2.2b0"

tests/gating_strategy_modify_gate_tree_tests.py

@@ -8,11 +8,7 @@
 # noinspection PyProtectedMember
 from flowkit._models.gating_results import GatingResults
 
-from tests.test_config import (
-    test_samples_8c_full_set_dict,
-    csv_8c_comp_file_path,
-    detectors_8c,
-)
+from tests import test_config
 
 
 class GatingStrategyRemoveGatesTestCase(unittest.TestCase):
@@ -43,8 +39,8 @@ def setUp(self):
         :return: None
         """
         sample_id = "101_DEN084Y5_15_E01_008_clean.fcs"
-        sample = copy.deepcopy(test_samples_8c_full_set_dict[sample_id])
-        comp = fk.Matrix(csv_8c_comp_file_path, detectors_8c)
+        sample = copy.deepcopy(test_config.test_samples_8c_full_set_dict[sample_id])
+        comp = fk.Matrix(test_config.csv_8c_comp_file_path, test_config.detectors_8c)
 
         session = fk.Session()
         session.add_samples(sample)
@@ -355,6 +351,42 @@ def test_remove_gate_keep_children(self):
     #
     # Rename gate tests
     #
+    def test_rename_gate_with_children(self):
+        # This test covers the bug reported in issue #231
+        poly1_vertices = test_config.poly1_vertices
+        poly1_dims = test_config.poly1_dims
+
+        top1_gate = fk.gates.PolygonGate("top1", poly1_dims, poly1_vertices)
+        top2_gate = fk.gates.PolygonGate("top2", poly1_dims, poly1_vertices)
+        a_gate = fk.gates.PolygonGate("A", poly1_dims, poly1_vertices)
+        a1_gate = fk.gates.PolygonGate("A1", poly1_dims, poly1_vertices)
+        a2_gate = fk.gates.PolygonGate("A2", poly1_dims, poly1_vertices)
+
+        gs = fk.GatingStrategy()
+        gs.add_gate(top1_gate, gate_path=('root',))
+        gs.add_gate(top2_gate, gate_path=('root',))
+
+        gs.add_gate(a_gate, gate_path=('root', 'top1'))
+        gs.add_gate(copy.deepcopy(a_gate), gate_path=('root', 'top2'))
+
+        gs.add_gate(a1_gate, gate_path=('root', 'top1', 'A'))
+        gs.add_gate(a2_gate, gate_path=('root', 'top1', 'A'))
+
+        gs.add_gate(copy.deepcopy(a1_gate), gate_path=('root', 'top2', 'A'))
+        gs.add_gate(copy.deepcopy(a2_gate), gate_path=('root', 'top2', 'A'))
+
+        # now rename 'top1' > 'A'
+        # This step caused a GateReferenceError prior to #231 fix
+        gs.rename_gate('A', 'A_new', ('root', 'top1'))
+
+        # verify we can retrieve the gate by its new gate name
+        renamed_gate = gs.get_gate('A_new', gate_path=('root', 'top1'))
+        self.assertEqual(renamed_gate.gate_name, 'A_new')
+
+        # And verify the other 'A' gate name didn't change
+        other_a_gate = gs.get_gate('A', gate_path=('root', 'top2'))
+        self.assertEqual(other_a_gate.gate_name, 'A')
+
     def test_rename_gate_with_bool_dep(self):
         gs = copy.deepcopy(self.gating_strategy)
         gate_name_to_rename = "CD3-pos-range"

tests/test_config.py

@@ -51,9 +51,9 @@
 poly1_vertices = [[5, 5], [500, 5], [500, 500]]
 poly1_dim1 = fk.Dimension("FL2-H", compensation_ref="FCS")
 poly1_dim2 = fk.Dimension("FL3-H", compensation_ref="FCS")
-poly1_dims1 = [poly1_dim1, poly1_dim2]
+poly1_dims = [poly1_dim1, poly1_dim2]
 
-poly1_gate = fk.gates.PolygonGate("Polygon1", poly1_dims1, poly1_vertices)
+poly1_gate = fk.gates.PolygonGate("Polygon1", poly1_dims, poly1_vertices)
 
 quad1_div1 = fk.QuadrantDivider("FL2", "FL2-H", "FCS", [12.14748])
 quad1_div2 = fk.QuadrantDivider("FL4", "FL4-H", "FCS", [14.22417])