bug(gates): fix create_population argument handling

Author: gegnew

cellengine/resources/experiment.py

@@ -394,65 +394,59 @@ def delete_gate(
         """
         return self.client.delete_gate(self._id, _id, gid, exclude)
 
-    def create_rectangle_gate(self, *args, **kwargs) -> RectangleGate:
+    def create_rectangle_gate(self, *args, create_population=True, **kwargs) -> RectangleGate:
         """Create a RectangleGate.
 
         Accepts all args and kwargs available for
         [`RectangleGate.create()`][cellengine.resources.gate.RectangleGate.create].
         """
         gate = RectangleGate.create(self._id, *args, **kwargs)
-        gate.update()
-        return gate
+        return ce.APIClient().create(gate, createPopulation=create_population)
 
-    def create_polygon_gate(self, *args, **kwargs) -> PolygonGate:
+    def create_polygon_gate(self, *args, create_population=True, **kwargs) -> PolygonGate:
         """Create a PolygonGate.
 
         Accepts all args and kwargs available for
         [`PolygonGate.create()`][cellengine.resources.gate.PolygonGate.create].
         """
         gate = PolygonGate.create(self._id, *args, **kwargs)
-        gate.update()
-        return gate
+        return ce.APIClient().create(gate, createPopulation=create_population)
 
-    def create_ellipse_gate(self, *args, **kwargs):
+    def create_ellipse_gate(self, *args, create_population=True, **kwargs):
         """Create a EllipseGate.
 
         Accepts all args and kwargs available for
         [`EllipseGate.create()`][cellengine.resources.gate.EllipseGate.create].
         """
         gate = EllipseGate.create(self._id, *args, **kwargs)
-        gate.update()
-        return gate
+        return ce.APIClient().create(gate, createPopulation=create_population)
 
-    def create_range_gate(self, *args, **kwargs) -> RangeGate:
+    def create_range_gate(self, *args, create_population=True, **kwargs) -> RangeGate:
         """Create a RangeGate.
 
         Accepts all args and kwargs available for
         [`RangeGate.create()`][cellengine.resources.gate.RangeGate.create].
         """
         gate = RangeGate.create(self._id, *args, **kwargs)
-        gate.update()
-        return gate
+        return ce.APIClient().create(gate, createPopulation=create_population)
 
-    def create_split_gate(self, *args, **kwargs) -> SplitGate:
+    def create_split_gate(self, *args, create_population=True, **kwargs) -> SplitGate:
         """Create a SplitGate.
 
         Accepts all args and kwargs available for
         [`SplitGate.create()`][cellengine.resources.gate.SplitGate.create].
         """
         gate = SplitGate.create(self._id, *args, **kwargs)
-        gate.update()
-        return gate
+        return ce.APIClient().create(gate, createPopulation=create_population)
 
-    def create_quadrant_gate(self, *args, **kwargs) -> QuadrantGate:
+    def create_quadrant_gate(self, *args, create_population=True, **kwargs) -> QuadrantGate:
         """Create a QuadrantGate.
 
         Accepts all args and kwargs available for
         [`QuadrantGate.create()`][cellengine.resources.gate.QuadrantGate.create].
         """
         gate = QuadrantGate.create(self._id, *args, **kwargs)
-        gate.update()
-        return gate
+        return ce.APIClient().create(gate, createPopulation=create_population)
 
     def create_population(self, population: Dict) -> Population:
         """Create a complex population

cellengine/resources/gate.py

@@ -104,7 +104,6 @@ def create(
         tailored_per_file: bool = False,
         fcs_file_id: str = None,
         fcs_file: str = None,
-        create_population: bool = True,
     ) -> RectangleGate:
         """Formats a rectangle gate for posting to the CellEngine API.
 
@@ -135,7 +134,6 @@ def create(
                 by name is slower than using the ID, as this requires
                 additional requests to the server. If specified, do not specify
                 ``fcs_file_id``.
-            create_population (bool): Automatically create corresponding population.
 
         Returns:
             A RectangleGate object.
@@ -179,7 +177,6 @@ def create(
             model=model,
             y_channel=y_channel,
             name=name,
-            # TODO: create_population
         )  # type: ignore
 
 
@@ -199,7 +196,6 @@ def create(
         tailored_per_file: Optional[bool] = False,
         fcs_file_id: Optional[str] = None,
         fcs_file: Optional[str] = None,
-        create_population: Optional[bool] = True,
     ) -> PolygonGate:
         """Formats a polygon gate for posting to the CellEngine API.
 
@@ -224,7 +220,6 @@ def create(
                 files by name is slower than using the ID, as this requires
                 additional requests to the server. If specified, do not specify
                 ``fcs_file_id``.
-            create_population (bool): Automatically create corresponding population.
 
         Returns:
             A PolygonGate object.
@@ -268,7 +263,6 @@ def create(
             model=model,
             y_channel=y_channel,
             name=name,
-            # TODO: create_population
         )  # type: ignore
 
 
@@ -292,7 +286,6 @@ def create(
         tailored_per_file: bool = False,
         fcs_file_id: str = None,
         fcs_file: str = None,
-        create_population: bool = True,
     ) -> EllipseGate:
         """Formats an ellipse gate for posting to the CellEngine API.
 
@@ -324,8 +317,6 @@ def create(
                 files by name is slower than using the ID, as this requires
                 additional requests to the server. If specified, do not specify
                 ``fcs_file_id``.
-            create_population (optional, bool): Automatically create corresponding
-                population.
 
         Returns:
             EllipseGate: An EllipseGate object.
@@ -372,7 +363,6 @@ def create(
             model=model,
             y_channel=y_channel,
             name=name,
-            # TODO: create_population
         )  # type: ignore
 
 
@@ -393,7 +383,6 @@ def create(
         tailored_per_file: bool = False,
         fcs_file_id: str = None,
         fcs_file: str = None,
-        create_population: bool = True,
     ) -> RangeGate:
         """Formats a range gate for posting to the CellEngine API.
 
@@ -421,7 +410,6 @@ def create(
                 files by name is slower than using the ID, as this requires
                 additional requests to the server. If specified, do not specify
                 ``fcs_file_id``.
-            create_population (bool): Automatically create corresponding population.
 
         Returns:
             A RangeGate object.
@@ -464,7 +452,6 @@ def create(
             model=model,
             y_channel=None,
             name=name,
-            # TODO: create_population
         )  # type: ignore
 
 
@@ -488,7 +475,6 @@ def create(
         tailored_per_file: bool = False,
         fcs_file_id: str = None,
         fcs_file: str = None,
-        create_population: bool = True,
     ) -> QuadrantGate:
         """Formats a quadrant gate for posting to the CellEngine API.
 
@@ -523,7 +509,6 @@ def create(
                 files by name is slower than using the ID, as this requires
                 additional requests to the server. If specified, do not specify
                 ``fcs_file_id``.
-            create_population (bool): Automatically create corresponding population.
 
         Returns:
             A QuadrantGate object.
@@ -593,7 +578,6 @@ def create(
             model=model,
             y_channel=y_channel,
             names=names,
-            # TODO: create_population
         )  # type: ignore
 
 
@@ -614,7 +598,6 @@ def create(
         tailored_per_file: bool = False,
         fcs_file_id: str = None,
         fcs_file: str = None,
-        create_population: bool = True,
     ) -> SplitGate:
         """
         Formats a split gate for posting to the CellEngine API.
@@ -648,7 +631,6 @@ def create(
                 files by name is slower than using the ID, as this requires
                 additional requests to the server. If specified, do not specify
                 ``fcs_file_id``.
-            create_population (bool): Automatically create corresponding population.
 
         Returns:
             A SplitGate object.
@@ -709,5 +691,4 @@ def create(
             model=model,
             y_channel=None,
             names=names,
-            # TODO: create_population
         )  # type: ignore

cellengine/utils/api_client/APIClient.py

@@ -147,6 +147,7 @@ def create(self, entity: CE, **kwargs) -> CE:
         if body["_id"] == "None" or body["_id"] is None:
             del body["_id"]  # https://github.com/primitybio/cellengine/issues/5800
 
+        import pdb; pdb.set_trace() #fmt: skip
         res = self._post(path, json=body, params=kwargs)
         return converter.structure(res, structure_class)  # type: ignore
 

tests/unit/resources/test_gates.py

@@ -268,6 +268,30 @@ def test_create_rectangle_gate(ENDPOINT_BASE, client, experiment, rectangle_gate
     assert m["y2"] == 215000
 
 
+@responses.activate
+def test_create_rectangle_gate_without_create_population(
+    ENDPOINT_BASE, client, experiment, rectangle_gate
+):
+    """Regression test for #118."""
+    responses.add(
+        responses.POST,
+        f"{ENDPOINT_BASE}/experiments/{EXP_ID}/gates",
+        status=201,
+        json=rectangle_gate,
+    )
+    rectangle_gate = experiment.create_rectangle_gate(
+        x_channel="FSC-A",
+        y_channel="FSC-W",
+        name="my gate",
+        x1=60000,
+        x2=200000,
+        y1=75000,
+        y2=215000,
+        create_population=False,
+    )
+    assert "createPopulation=false" in responses.calls[0].request.url
+
+
 @responses.activate
 def test_create_ellipse_gate(ENDPOINT_BASE, client, experiment, ellipse_gate):
     responses.add(