refactor(api): Delete dead private_result supporting code (#16621)

Opentrons · Oct 29, 2024 · 965bdf2 · 965bdf2
1 parent a20cb6f
commit 965bdf2
Show file tree

Hide file tree

Showing 154 changed files with 316 additions and 576 deletions.
diff --git a/api/src/opentrons/protocol_engine/actions/actions.py b/api/src/opentrons/protocol_engine/actions/actions.py
@@ -18,7 +18,6 @@
     Command,
     CommandCreate,
     CommandDefinedErrorData,
-    CommandPrivateResult,
 )
 from ..error_recovery_policy import ErrorRecoveryPolicy, ErrorRecoveryType
 from ..notes.notes import CommandNote
@@ -146,10 +145,6 @@ class SucceedCommandAction:
     command: Command
     """The command in its new succeeded state."""
 
-    # todo(mm, 2024-08-26): Remove when no state stores use this anymore.
-    # https://opentrons.atlassian.net/browse/EXEC-639
-    private_result: CommandPrivateResult
-
     state_update: StateUpdate = dataclasses.field(
         # todo(mm, 2024-08-26): This has a default only to make it easier to transition
         # old tests while https://opentrons.atlassian.net/browse/EXEC-639 is in

diff --git a/api/src/opentrons/protocol_engine/commands/__init__.py b/api/src/opentrons/protocol_engine/commands/__init__.py
@@ -38,7 +38,6 @@
     CommandCreate,
     CommandResult,
     CommandType,
-    CommandPrivateResult,
     CommandDefinedErrorData,
 )
 

diff --git a/api/src/opentrons/protocol_engine/commands/absorbance_reader/close_lid.py b/api/src/opentrons/protocol_engine/commands/absorbance_reader/close_lid.py
@@ -37,9 +37,7 @@ class CloseLidResult(BaseModel):
     """Result data from closing the lid on an aborbance reading."""
 
 
-class CloseLidImpl(
-    AbstractCommandImpl[CloseLidParams, SuccessData[CloseLidResult, None]]
-):
+class CloseLidImpl(AbstractCommandImpl[CloseLidParams, SuccessData[CloseLidResult]]):
     """Execution implementation of closing the lid on an Absorbance Reader."""
 
     def __init__(
@@ -53,9 +51,7 @@ def __init__(
         self._equipment = equipment
         self._labware_movement = labware_movement
 
-    async def execute(
-        self, params: CloseLidParams
-    ) -> SuccessData[CloseLidResult, None]:
+    async def execute(self, params: CloseLidParams) -> SuccessData[CloseLidResult]:
         """Execute the close lid command."""
         mod_substate = self._state_view.modules.get_absorbance_reader_substate(
             module_id=params.moduleId
@@ -142,7 +138,6 @@ async def execute(
 
         return SuccessData(
             public=CloseLidResult(),
-            private=None,
             state_update=state_update,
         )
 

diff --git a/api/src/opentrons/protocol_engine/commands/absorbance_reader/initialize.py b/api/src/opentrons/protocol_engine/commands/absorbance_reader/initialize.py
@@ -37,7 +37,7 @@ class InitializeResult(BaseModel):
 
 
 class InitializeImpl(
-    AbstractCommandImpl[InitializeParams, SuccessData[InitializeResult, None]]
+    AbstractCommandImpl[InitializeParams, SuccessData[InitializeResult]]
 ):
     """Execution implementation of initializing an Absorbance Reader."""
 
@@ -50,9 +50,7 @@ def __init__(
         self._state_view = state_view
         self._equipment = equipment
 
-    async def execute(
-        self, params: InitializeParams
-    ) -> SuccessData[InitializeResult, None]:
+    async def execute(self, params: InitializeParams) -> SuccessData[InitializeResult]:
         """Initiate a single absorbance measurement."""
         abs_reader_substate = self._state_view.modules.get_absorbance_reader_substate(
             module_id=params.moduleId
@@ -105,7 +103,6 @@ async def execute(
 
         return SuccessData(
             public=InitializeResult(),
-            private=None,
         )
 
 

diff --git a/api/src/opentrons/protocol_engine/commands/absorbance_reader/open_lid.py b/api/src/opentrons/protocol_engine/commands/absorbance_reader/open_lid.py
@@ -38,7 +38,7 @@ class OpenLidResult(BaseModel):
     """Result data from opening the lid on an aborbance reading."""
 
 
-class OpenLidImpl(AbstractCommandImpl[OpenLidParams, SuccessData[OpenLidResult, None]]):
+class OpenLidImpl(AbstractCommandImpl[OpenLidParams, SuccessData[OpenLidResult]]):
     """Execution implementation of opening the lid on an Absorbance Reader."""
 
     def __init__(
@@ -52,7 +52,7 @@ def __init__(
         self._equipment = equipment
         self._labware_movement = labware_movement
 
-    async def execute(self, params: OpenLidParams) -> SuccessData[OpenLidResult, None]:
+    async def execute(self, params: OpenLidParams) -> SuccessData[OpenLidResult]:
         """Move the absorbance reader lid from the module to the lid dock."""
         mod_substate = self._state_view.modules.get_absorbance_reader_substate(
             module_id=params.moduleId
@@ -137,7 +137,6 @@ async def execute(self, params: OpenLidParams) -> SuccessData[OpenLidResult, Non
 
         return SuccessData(
             public=OpenLidResult(),
-            private=None,
             state_update=state_update,
         )
 

diff --git a/api/src/opentrons/protocol_engine/commands/absorbance_reader/read.py b/api/src/opentrons/protocol_engine/commands/absorbance_reader/read.py
@@ -48,7 +48,7 @@ class ReadAbsorbanceResult(BaseModel):
 
 
 class ReadAbsorbanceImpl(
-    AbstractCommandImpl[ReadAbsorbanceParams, SuccessData[ReadAbsorbanceResult, None]]
+    AbstractCommandImpl[ReadAbsorbanceParams, SuccessData[ReadAbsorbanceResult]]
 ):
     """Execution implementation of an Absorbance Reader measurement."""
 
@@ -65,7 +65,7 @@ def __init__(
 
     async def execute(  # noqa: C901
         self, params: ReadAbsorbanceParams
-    ) -> SuccessData[ReadAbsorbanceResult, None]:
+    ) -> SuccessData[ReadAbsorbanceResult]:
         """Initiate an absorbance measurement."""
         abs_reader_substate = self._state_view.modules.get_absorbance_reader_substate(
             module_id=params.moduleId
@@ -168,12 +168,10 @@ async def execute(  # noqa: C901
                     public=ReadAbsorbanceResult(
                         data=asbsorbance_result, fileIds=file_ids
                     ),
-                    private=None,
                 )
 
         return SuccessData(
             public=ReadAbsorbanceResult(data=asbsorbance_result, fileIds=file_ids),
-            private=None,
         )
 
 

diff --git a/api/src/opentrons/protocol_engine/commands/aspirate.py b/api/src/opentrons/protocol_engine/commands/aspirate.py
@@ -52,7 +52,7 @@ class AspirateResult(BaseLiquidHandlingResult, DestinationPositionResult):
 
 
 _ExecuteReturn = Union[
-    SuccessData[AspirateResult, None],
+    SuccessData[AspirateResult],
     DefinedErrorData[OverpressureError],
 ]
 
@@ -167,7 +167,6 @@ async def execute(self, params: AspirateParams) -> _ExecuteReturn:
                     volume=volume_aspirated,
                     position=deck_point,
                 ),
-                private=None,
                 state_update=state_update,
             )
 

diff --git a/api/src/opentrons/protocol_engine/commands/aspirate_in_place.py b/api/src/opentrons/protocol_engine/commands/aspirate_in_place.py
@@ -49,7 +49,7 @@ class AspirateInPlaceResult(BaseLiquidHandlingResult):
 
 
 _ExecuteReturn = Union[
-    SuccessData[AspirateInPlaceResult, None],
+    SuccessData[AspirateInPlaceResult],
     DefinedErrorData[OverpressureError],
 ]
 
@@ -150,7 +150,6 @@ async def execute(self, params: AspirateInPlaceParams) -> _ExecuteReturn:
                 )
             return SuccessData(
                 public=AspirateInPlaceResult(volume=volume),
-                private=None,
                 state_update=state_update,
             )
 

diff --git a/api/src/opentrons/protocol_engine/commands/blow_out.py b/api/src/opentrons/protocol_engine/commands/blow_out.py
@@ -48,7 +48,7 @@ class BlowOutResult(DestinationPositionResult):
 
 
 _ExecuteReturn = Union[
-    SuccessData[BlowOutResult, None],
+    SuccessData[BlowOutResult],
     DefinedErrorData[OverpressureError],
 ]
 
@@ -116,7 +116,6 @@ async def execute(self, params: BlowOutParams) -> _ExecuteReturn:
         else:
             return SuccessData(
                 public=BlowOutResult(position=deck_point),
-                private=None,
                 state_update=state_update,
             )
 

diff --git a/api/src/opentrons/protocol_engine/commands/blow_out_in_place.py b/api/src/opentrons/protocol_engine/commands/blow_out_in_place.py
@@ -45,7 +45,7 @@ class BlowOutInPlaceResult(BaseModel):
 
 
 _ExecuteReturn = Union[
-    SuccessData[BlowOutInPlaceResult, None],
+    SuccessData[BlowOutInPlaceResult],
     DefinedErrorData[OverpressureError],
 ]
 
@@ -99,7 +99,9 @@ async def execute(self, params: BlowOutInPlaceParams) -> _ExecuteReturn:
                 ),
             )
         else:
-            return SuccessData(public=BlowOutInPlaceResult(), private=None)
+            return SuccessData(
+                public=BlowOutInPlaceResult(),
+            )
 
 
 class BlowOutInPlace(

diff --git a/api/src/opentrons/protocol_engine/commands/calibration/calibrate_gripper.py b/api/src/opentrons/protocol_engine/commands/calibration/calibrate_gripper.py
@@ -71,9 +71,7 @@ class CalibrateGripperResult(BaseModel):
 
 
 class CalibrateGripperImplementation(
-    AbstractCommandImpl[
-        CalibrateGripperParams, SuccessData[CalibrateGripperResult, None]
-    ]
+    AbstractCommandImpl[CalibrateGripperParams, SuccessData[CalibrateGripperResult]]
 ):
     """The implementation of a `calibrateGripper` command."""
 
@@ -87,7 +85,7 @@ def __init__(
 
     async def execute(
         self, params: CalibrateGripperParams
-    ) -> SuccessData[CalibrateGripperResult, None]:
+    ) -> SuccessData[CalibrateGripperResult]:
         """Execute a `calibrateGripper` command.
 
         1. Move from the current location to the calibration area on the deck.
@@ -126,7 +124,6 @@ async def execute(
                 ),
                 savedCalibration=calibration_data,
             ),
-            private=None,
         )
 
     @staticmethod

diff --git a/api/src/opentrons/protocol_engine/commands/calibration/calibrate_module.py b/api/src/opentrons/protocol_engine/commands/calibration/calibrate_module.py
@@ -49,7 +49,7 @@ class CalibrateModuleResult(BaseModel):
 
 
 class CalibrateModuleImplementation(
-    AbstractCommandImpl[CalibrateModuleParams, SuccessData[CalibrateModuleResult, None]]
+    AbstractCommandImpl[CalibrateModuleParams, SuccessData[CalibrateModuleResult]]
 ):
     """CalibrateModule command implementation."""
 
@@ -64,7 +64,7 @@ def __init__(
 
     async def execute(
         self, params: CalibrateModuleParams
-    ) -> SuccessData[CalibrateModuleResult, None]:
+    ) -> SuccessData[CalibrateModuleResult]:
         """Execute calibrate-module command."""
         ot3_api = ensure_ot3_hardware(
             self._hardware_api,
@@ -91,7 +91,6 @@ async def execute(
                 ),
                 location=slot,
             ),
-            private=None,
         )
 
 

diff --git a/api/src/opentrons/protocol_engine/commands/calibration/calibrate_pipette.py b/api/src/opentrons/protocol_engine/commands/calibration/calibrate_pipette.py
@@ -34,9 +34,7 @@ class CalibratePipetteResult(BaseModel):
 
 
 class CalibratePipetteImplementation(
-    AbstractCommandImpl[
-        CalibratePipetteParams, SuccessData[CalibratePipetteResult, None]
-    ]
+    AbstractCommandImpl[CalibratePipetteParams, SuccessData[CalibratePipetteResult]]
 ):
     """CalibratePipette command implementation."""
 
@@ -49,7 +47,7 @@ def __init__(
 
     async def execute(
         self, params: CalibratePipetteParams
-    ) -> SuccessData[CalibratePipetteResult, None]:
+    ) -> SuccessData[CalibratePipetteResult]:
         """Execute calibrate-pipette command."""
         # TODO (tz, 20-9-22): Add a better solution to determine if a command can be executed on an OT-3/OT-2
         ot3_api = ensure_ot3_hardware(
@@ -72,7 +70,6 @@ async def execute(
                     x=pipette_offset.x, y=pipette_offset.y, z=pipette_offset.z
                 )
             ),
-            private=None,
         )
 
 

diff --git a/api/src/opentrons/protocol_engine/commands/calibration/move_to_maintenance_position.py b/api/src/opentrons/protocol_engine/commands/calibration/move_to_maintenance_position.py
@@ -57,7 +57,7 @@ class MoveToMaintenancePositionResult(BaseModel):
 class MoveToMaintenancePositionImplementation(
     AbstractCommandImpl[
         MoveToMaintenancePositionParams,
-        SuccessData[MoveToMaintenancePositionResult, None],
+        SuccessData[MoveToMaintenancePositionResult],
     ]
 ):
     """Calibration set up position command implementation."""
@@ -73,7 +73,7 @@ def __init__(
 
     async def execute(
         self, params: MoveToMaintenancePositionParams
-    ) -> SuccessData[MoveToMaintenancePositionResult, None]:
+    ) -> SuccessData[MoveToMaintenancePositionResult]:
         """Move the requested mount to a maintenance deck slot."""
         ot3_api = ensure_ot3_hardware(
             self._hardware_api,
@@ -118,7 +118,9 @@ async def execute(
                 )
                 await ot3_api.disengage_axes([Axis.Z_R])
 
-        return SuccessData(public=MoveToMaintenancePositionResult(), private=None)
+        return SuccessData(
+            public=MoveToMaintenancePositionResult(),
+        )
 
 
 class MoveToMaintenancePosition(

diff --git a/api/src/opentrons/protocol_engine/commands/command.py b/api/src/opentrons/protocol_engine/commands/command.py
@@ -39,7 +39,6 @@
 _ResultT_co = TypeVar("_ResultT_co", bound=BaseModel, covariant=True)
 _ErrorT = TypeVar("_ErrorT", bound=ErrorOccurrence)
 _ErrorT_co = TypeVar("_ErrorT_co", bound=ErrorOccurrence, covariant=True)
-_PrivateResultT_co = TypeVar("_PrivateResultT_co", covariant=True)
 
 
 class CommandStatus(str, Enum):
@@ -108,19 +107,12 @@ class BaseCommandCreate(
 
 
 @dataclasses.dataclass(frozen=True)
-class SuccessData(Generic[_ResultT_co, _PrivateResultT_co]):
+class SuccessData(Generic[_ResultT_co]):
     """Data from the successful completion of a command."""
 
     public: _ResultT_co
     """Public result data. Exposed over HTTP and stored in databases."""
 
-    private: _PrivateResultT_co
-    """Additional result data, only given to `opentrons.protocol_engine` internals.
-
-    Deprecated:
-        Use `state_update` instead.
-    """
-
     state_update: StateUpdate = dataclasses.field(
         # todo(mm, 2024-08-22): Remove the default once all command implementations
         # use this, to make it harder to forget in new command implementations.
@@ -239,8 +231,6 @@ class BaseCommand(
                     # Our _ImplementationCls must return public result data that can fit
                     # in our `result` field:
                     _ResultT,
-                    # But we don't care (here) what kind of private result data it returns:
-                    object,
                 ],
                 DefinedErrorData[
                     # Our _ImplementationCls must return public error data that can fit
@@ -255,7 +245,7 @@ class BaseCommand(
 _ExecuteReturnT_co = TypeVar(
     "_ExecuteReturnT_co",
     bound=Union[
-        SuccessData[BaseModel, object],
+        SuccessData[BaseModel],
         DefinedErrorData[ErrorOccurrence],
     ],
     covariant=True,

diff --git a/api/src/opentrons/protocol_engine/commands/command_unions.py b/api/src/opentrons/protocol_engine/commands/command_unions.py
@@ -1,7 +1,7 @@
 """Union types of concrete command definitions."""
 
 from collections.abc import Collection
-from typing import Annotated, Literal, Type, Union, get_type_hints
+from typing import Annotated, Type, Union, get_type_hints
 
 from pydantic import Field
 
@@ -699,9 +699,6 @@
     unsafe.UnsafeUngripLabwareResult,
 ]
 
-# todo(mm, 2024-10-28): This has been obsoleted by StateUpdate. Delete this.
-# https://opentrons.atlassian.net/browse/EXEC-639
-CommandPrivateResult = Literal[None]
 
 # All `DefinedErrorData`s that implementations will actually return in practice.
 CommandDefinedErrorData = Union[