feat(api): Bump Flex Stacker PAPI to 2.25 and update the stacker protocols to match. (#18773)

Author: vegano1

abr-testing/abr_testing/protocols/test_protocols/IDT xGen 96ch.py

@@ -18,7 +18,7 @@
 }
 requirements = {
     "robotType": "Flex",
-    "apiLevel": "2.23",
+    "apiLevel": "2.25",
 }
 
 

abr-testing/abr_testing/protocols/test_protocols/Illumina RNA all parts.py

@@ -21,7 +21,7 @@
 }
 requirements = {
     "robotType": "Flex",
-    "apiLevel": "2.23",
+    "apiLevel": "2.25",
 }
 
 

api/src/opentrons/protocol_api/module_contexts.py

@@ -1118,18 +1118,18 @@ class FlexStackerContext(ModuleContext):
     It should not be instantiated directly; instead, it should be
     created through :py:meth:`.ProtocolContext.load_module`.
 
-    .. versionadded:: 2.23
+    .. versionadded:: 2.25
     """
 
     _core: FlexStackerCore
 
     @property
-    @requires_version(2, 23)
+    @requires_version(2, 25)
     def serial_number(self) -> str:
         """Get the module's unique hardware serial number."""
         return self._core.get_serial_number()
 
-    @requires_version(2, 23)
+    @requires_version(2, 25)
     def retrieve(self) -> Labware:
         """Retrieve a labware from the Flex Stacker and place it on the shuttle.
 
@@ -1147,7 +1147,7 @@ def retrieve(self) -> Labware:
             ),
         )
 
-    @requires_version(2, 23)
+    @requires_version(2, 25)
     def store(self) -> None:
         """Move the labware currently on the Flex Stacker shuttle into the Flex Stacker."""
         self._core.store()
@@ -1167,7 +1167,7 @@ def _convert() -> Iterator[Labware]:
 
         return list(_convert())
 
-    @requires_version(2, 24)
+    @requires_version(2, 25)
     def get_max_storable_labware_from_list(
         self,
         labware: list[Labware],
@@ -1203,7 +1203,7 @@ def get_max_storable_labware_from_list(
             ),
         )
 
-    @requires_version(2, 24)
+    @requires_version(2, 25)
     def get_current_storable_labware_from_list(
         self, labware: list[Labware]
     ) -> list[Labware]:
@@ -1224,7 +1224,7 @@ def get_current_storable_labware_from_list(
             )
         )
 
-    @requires_version(2, 24)
+    @requires_version(2, 25)
     def get_max_storable_labware(self) -> int:
         """Get the number of labware that the Flex Stacker can store with its current stored labware configuration.
 
@@ -1234,7 +1234,7 @@ def get_max_storable_labware(self) -> int:
         """
         return self._core.get_max_storable_labware()
 
-    @requires_version(2, 24)
+    @requires_version(2, 25)
     def get_current_storable_labware(self) -> int:
         """Get the number of labware that the Flex Stacker currently has space for.
 
@@ -1243,7 +1243,7 @@ def get_current_storable_labware(self) -> int:
         """
         return self._core.get_current_storable_labware()
 
-    @requires_version(2, 24)
+    @requires_version(2, 25)
     def set_stored_labware_items(
         self,
         labware: list[Labware],
@@ -1293,7 +1293,7 @@ def set_stored_labware_items(
             stacking_offset_z=stacking_offset_z,
         )
 
-    @requires_version(2, 23)
+    @requires_version(2, 25)
     def set_stored_labware(
         self,
         load_name: str,
@@ -1369,33 +1369,17 @@ def set_stored_labware(
             stacking_offset_z=stacking_offset_z,
         )
 
-    @requires_version(2, 23)
+    @requires_version(2, 25)
     def fill(self, count: int | None = None, message: str | None = None) -> None:
         """Pause the protocol to add more labware to the Flex Stacker.
 
         :param message: A message to display in the Opentrons App to note what kind of labware to add.
         :param count: The amount of labware the Flex Stacker should hold after this command is executed.
                       If not specified, the Flex Stacker should be full after this command is executed.
         """
-        if self.api_version < APIVersion(2, 24):
-            # politeness: the order of the arguments changed in api 2.24. This wasn't released so it isn't
-            # a problem, but anybody using this probably would not like their protocols suddenly breaking
-            if isinstance(count, str):
-                checked_message = count
-                checked_count = message
-            elif (not isinstance(message, str)) and message is not None:
-                checked_count = message
-                checked_message = count
-            else:
-                checked_count = count
-                checked_message = message
-        else:
-            checked_count = count
-            checked_message = message
-
-        self._core.fill(checked_count, checked_message)
+        self._core.fill(count, message)
 
-    @requires_version(2, 24)
+    @requires_version(2, 25)
     def fill_items(self, labware: list[Labware], message: str | None = None) -> None:
         """Pause the protocol to add a specific list of labware to the Flex Stacker.
 
@@ -1410,7 +1394,7 @@ def fill_items(self, labware: list[Labware], message: str | None = None) -> None
         """
         self._core.fill_items(self._labware_to_cores(labware), message)
 
-    @requires_version(2, 23)
+    @requires_version(2, 25)
     def empty(self, message: str | None = None) -> None:
         """Pause the protocol to remove labware from the Flex Stacker.
 
@@ -1421,7 +1405,7 @@ def empty(self, message: str | None = None) -> None:
             message,
         )
 
-    @requires_version(2, 24)
+    @requires_version(2, 25)
     def get_stored_labware(self) -> list[Labware]:
         """Get the list of labware currently stored inside the stacker.
 

api/tests/opentrons/protocol_api/test_flex_stacker_context.py

@@ -71,7 +71,7 @@ def subject(
 
 
 @pytest.mark.parametrize(
-    "api_version", versions_at_or_above(from_version=APIVersion(2, 23))
+    "api_version", versions_at_or_above(from_version=APIVersion(2, 25))
 )
 def test_get_serial_number(
     decoy: Decoy, mock_core: FlexStackerCore, subject: FlexStackerContext
@@ -82,24 +82,8 @@ def test_get_serial_number(
     assert result == "12345"
 
 
-@pytest.mark.parametrize("api_version", [APIVersion(2, 23)])
 @pytest.mark.parametrize(
-    "message,count", [("hello", 2), ("hello", None), (None, 2), (None, None)]
-)
-def test_fill_old_args(
-    decoy: Decoy,
-    mock_core: FlexStackerCore,
-    subject: FlexStackerContext,
-    message: str | None,
-    count: int | None,
-) -> None:
-    """It should pass args to the core."""
-    subject.fill(message, count)  # type: ignore[arg-type]
-    decoy.verify(mock_core.fill(count, message))
-
-
-@pytest.mark.parametrize(
-    "api_version", versions_at_or_above(from_version=APIVersion(2, 23))
+    "api_version", versions_at_or_above(from_version=APIVersion(2, 25))
 )
 def test_fill(
     decoy: Decoy, mock_core: FlexStackerCore, subject: FlexStackerContext
@@ -110,7 +94,7 @@ def test_fill(
 
 
 @pytest.mark.parametrize(
-    "api_version", versions_at_or_above(from_version=APIVersion(2, 23))
+    "api_version", versions_at_or_above(from_version=APIVersion(2, 25))
 )
 def test_empty(
     decoy: Decoy, mock_core: FlexStackerCore, subject: FlexStackerContext
@@ -121,7 +105,7 @@ def test_empty(
 
 
 @pytest.mark.parametrize(
-    "api_version", versions_at_or_above(from_version=APIVersion(2, 23))
+    "api_version", versions_at_or_above(from_version=APIVersion(2, 25))
 )
 def test_set_stored_labware(
     decoy: Decoy, mock_core: FlexStackerCore, subject: FlexStackerContext
@@ -148,7 +132,7 @@ def test_set_stored_labware(
 
 
 @pytest.mark.parametrize(
-    "api_version", versions_at_or_above(from_version=APIVersion(2, 24))
+    "api_version", versions_at_or_above(from_version=APIVersion(2, 25))
 )
 def test_get_max_storable_labware_from_list(
     decoy: Decoy,
@@ -168,7 +152,7 @@ def test_get_max_storable_labware_from_list(
     base_lw = [
         Labware(
             core=core,
-            api_version=APIVersion(2, 24),
+            api_version=APIVersion(2, 25),
             protocol_core=mock_protocol_core,
             core_map=subject._core_map,
         )
@@ -181,7 +165,7 @@ def test_get_max_storable_labware_from_list(
 
 
 @pytest.mark.parametrize(
-    "api_version", versions_at_or_above(from_version=APIVersion(2, 24))
+    "api_version", versions_at_or_above(from_version=APIVersion(2, 25))
 )
 def test_get_current_storable_labware_from_list(
     decoy: Decoy,
@@ -201,7 +185,7 @@ def test_get_current_storable_labware_from_list(
     base_lw = [
         Labware(
             core=core,
-            api_version=APIVersion(2, 24),
+            api_version=APIVersion(2, 25),
             protocol_core=mock_protocol_core,
             core_map=subject._core_map,
         )
@@ -214,7 +198,7 @@ def test_get_current_storable_labware_from_list(
 
 
 @pytest.mark.parametrize(
-    "api_version", versions_at_or_above(from_version=APIVersion(2, 24))
+    "api_version", versions_at_or_above(from_version=APIVersion(2, 25))
 )
 def test_get_max_storable_labware(
     decoy: Decoy,
@@ -227,7 +211,7 @@ def test_get_max_storable_labware(
 
 
 @pytest.mark.parametrize(
-    "api_version", versions_at_or_above(from_version=APIVersion(2, 24))
+    "api_version", versions_at_or_above(from_version=APIVersion(2, 25))
 )
 def test_get_current_storable_labware(
     decoy: Decoy,
@@ -240,7 +224,7 @@ def test_get_current_storable_labware(
 
 
 @pytest.mark.parametrize(
-    "api_version", versions_at_or_above(from_version=APIVersion(2, 24))
+    "api_version", versions_at_or_above(from_version=APIVersion(2, 25))
 )
 def test_get_stored_labware(
     decoy: Decoy,
@@ -260,7 +244,7 @@ def test_get_stored_labware(
     base_lw = [
         Labware(
             core=core,
-            api_version=APIVersion(2, 24),
+            api_version=APIVersion(2, 25),
             protocol_core=mock_protocol_core,
             core_map=subject._core_map,
         )
@@ -271,7 +255,7 @@ def test_get_stored_labware(
 
 
 @pytest.mark.parametrize(
-    "api_version", versions_at_or_above(from_version=APIVersion(2, 24))
+    "api_version", versions_at_or_above(from_version=APIVersion(2, 25))
 )
 @pytest.mark.parametrize("message", ["hello", None])
 def test_fill_items(
@@ -291,7 +275,7 @@ def test_fill_items(
     base_lw = [
         Labware(
             core=core,
-            api_version=APIVersion(2, 24),
+            api_version=APIVersion(2, 25),
             protocol_core=mock_protocol_core,
             core_map=subject._core_map,
         )
@@ -302,7 +286,7 @@ def test_fill_items(
 
 
 @pytest.mark.parametrize(
-    "api_version", versions_at_or_above(from_version=APIVersion(2, 24))
+    "api_version", versions_at_or_above(from_version=APIVersion(2, 25))
 )
 def test_set_stored_labware_items(
     decoy: Decoy,
@@ -320,7 +304,7 @@ def test_set_stored_labware_items(
     base_lw = [
         Labware(
             core=core,
-            api_version=APIVersion(2, 24),
+            api_version=APIVersion(2, 25),
             protocol_core=mock_protocol_core,
             core_map=subject._core_map,
         )

hardware-testing/hardware_testing/modules/stacker_qc_protocol.py

@@ -10,7 +10,7 @@
 }
 requirements = {
     "robotType": "Flex",
-    "apiLevel": "2.23",
+    "apiLevel": "2.25",
 }
 
 

hardware-testing/hardware_testing/protocols/labware_stack_offset_test.py

@@ -11,7 +11,7 @@
 
 requirements = {
     "robotType": "Flex",
-    "apiLevel": "2.23",
+    "apiLevel": "2.25",
 }