refactor(api): add explicit Flex hardware protocol #14091
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Conflicts: # api/src/opentrons/hardware_control/protocols/configurable.py
sfoster1
approved these changes
Dec 5, 2023
| @@ -302,6 +302,9 @@ async def build_hardware_simulator( | |||
| def __repr__(self) -> str: | |||
| return "<{} using backend {}>".format(type(self), type(self._backend)) | |||
|
|
|||
| def get_robot_type(self) -> RobotTypeEnum: | |||
There was a problem hiding this comment.
If you define this to return an enum literal Literal[RobotTypeEnum.OT2], and define the Flex protocol's version of the method to return Literal[RobotTypeEnum.FLEX] (or however we spelled it), then in theory that should let the union of the two protocols get narrowed by the result of calling get_robot_type() which should remove some casts
| raise HardwareNotSupportedError( | ||
| error_msg or "This command is supported by OT-3 only." | ||
| ) | ||
|
|
||
| return hardware_api | ||
| return hardware_api # type: ignore |
There was a problem hiding this comment.
here this cast should be removable if you do the enum-literal thing above
…types for robot models
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## edge #14091 +/- ##
==========================================
- Coverage 70.40% 70.39% -0.01%
==========================================
Files 2510 2510
Lines 71201 71188 -13
Branches 8971 8971
==========================================
- Hits 50127 50113 -14
Misses 18880 18880
- Partials 2194 2195 +1
Flags with carried forward coverage won't be shown. Click here to find out more.
|
sfoster1
approved these changes
Dec 8, 2023
|
|
||
| if TYPE_CHECKING: | ||
| from opentrons.hardware_control.ot3api import OT3API | ||
| from opentrons.hardware_control import HardwareControlAPI | ||
| from opentrons.hardware_control import HardwareControlAPI, OT3HardwareControlAPI |
There was a problem hiding this comment.
here too - shouldn't need TYPE_CHECKING?
| @@ -49,7 +49,7 @@ | |||
| from robot_server.subsystems.router import status_route_for, update_route_for | |||
|
|
|||
| if TYPE_CHECKING: | |||
| from opentrons.hardware_control.ot3api import OT3API | |||
| from opentrons.hardware_control import OT3HardwareControlAPI | |||
# Conflicts: # api/tests/opentrons/protocol_engine/execution/test_labware_movement_handler.py
ncdiehl11
pushed a commit
that referenced
this pull request
Dec 19, 2023
* pass around mypy protocol instead of OT3API * Explicit parameterization of config types * Fix some tests with the protocol engine related to protocol changes * Added a `FlexInstrumentConfigurer` for flex-specific configuration extensions * Update test mocks to differentiate ot2/ot3 hardware * Modifed `get_robot_type` to be parameterized on some singleton class types for robot models * remove unnecessary TYPE_CHECKING import * Add tip presence protocol functions to satisfy edits to tip manager
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
We currently differentiate between the OT3 and OT2 API classes with a simple
isinstancecheck. This works okay when the simulator for each class is an instance of the normal hardware API, but there are a few reasons that we want to move over to having a separate simulator class for each API that does not depend on the hardware-specific code. In that case, checking the types to differentiate the robot model doesn't work.This PR establishes extensions to the Hardware API MyPy protocols in order to explicitly differentiate an OT-2 from an OT-3. It also adds a function that returns the enumerated model of the robot (OT2 or FLEX). This is preferable to type-checking the class because
isinstanceis slow/not recommended on Protocol classes.Test Plan
Check that
GET /instrumentson OT-2)Changelog
Review requests
Risk assessment
Medium. Touches some core stuff but doesn't really change any behavior.