fix(api): Support simulating PAPIv≥2.14 #13709
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
4 tasks
SyntaxColoring
force-pushed
the
stab_at_simulation
branch
from
b5902a3 to
163b8ba
Compare
SyntaxColoring
changed the base branch from
chore_release-7.0.1
to
stab_at_simulation_dev_integration
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## chore_release-7.0.1 #13709 +/- ##
=======================================================
- Coverage 71.23% 71.23% -0.01%
=======================================================
Files 2430 2430
Lines 68439 68383 -56
Branches 8043 8043
=======================================================
- Hits 48755 48713 -42
+ Misses 17786 17772 -14
Partials 1898 1898
Flags with carried forward coverage won't be shown. Click here to find out more.
|
* Mark CommandScraper and AccumulatingHandler as private. * Tighten up typing on CommandScraper queue. * Add comment about _CommandScraper setting the log level.
…cols. Rewrite simulate.py to be structured like execute.py.
This helps us deal with `ProtocolReader` requiring a filename to infer the protocol type, while `opentrons.simulate.simulate()` doesn't always have a trustworthy protocol filename to work with. By accepting a `Protocol` object as input, we can reuse `opentrons.protocols.parse`'s logic for guessing the protocol type.
SyntaxColoring
force-pushed
the
stab_at_simulation
branch
from
163b8ba to
3516a4f
Compare
SyntaxColoring
changed the base branch from
stab_at_simulation_dev_integration
to
chore_release-7.0.1
This comment was marked as resolved.
This comment was marked as resolved.
… internal errors.
SyntaxColoring
commented
Oct 11, 2023
Comment on lines
-260
to
+265
| filename=getattr(protocol, "co_filename", "<protocol>"), | ||
| filename=filename, |
There was a problem hiding this comment.
Falling back to "<protocol>" at this level was lossy. If we weren't given a filename, we want to preserve that information for the caller, by returning None, so they can choose their own fallback.
This comment was marked as resolved.
This comment was marked as resolved.
|
Running locally, so far so good, need to test standard and JSON protocols on a Flex, might I recommend a change here: opentrons/api/src/opentrons/simulate.py Line 928 in ca8da73 Should say something more like this to clarify support for the Flex: I'll update again once I have run this on actual Flex hardware. |
jbleon95
approved these changes
Oct 11, 2023
sanni-t
approved these changes
Oct 11, 2023
CaseyBatten
approved these changes
Oct 11, 2023
This was referenced Oct 12, 2023
SyntaxColoring
added a commit
that referenced
this pull request
Oct 19, 2023
Notable changes: * Rework `simulate.py` to support PAPIv≥2.14 protocols, via Protocol Engine. This rework mirrors what we did to `execute.py` in #12970. * Rework the `adapt_protocol_source()` helper to cope with protocols for which we don't know the filename. This is necessary to support `opentrons.simulate.simulate()`, whose `filename` argument is optional. Unfortunately, this requires modifications to `opentrons.protocols.parse` to make the filename more pass-through, so `adapt_protocol_source()` can tell when it wasn't provided. Plus various smaller refactors for type safety, deduplication, and consistency.
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
Closes RSS-322. Lets you run new Python protocols through
opentrons_simulate,opentrons.simulate.simulate(), andopentrons.simulate.get_protocol_api().Also fixes a straggling instance of RSS-156, incorrectly using the machine's current deck type in simulation, instead of the correct deck type to match the protocol.
Test Plan
See this document.
Changelog
Notable changes:
Rework
simulate.pyto support PAPIv≥2.14 protocols, via Protocol Engine. This rework mirrors what we did toexecute.pyin feat(api): Limited support for programmatically running PAPIv≥2.14 #12970.Rework the
adapt_protocol_source()helper to cope with protocols for which we don't know the filename. This is necessary to supportopentrons.simulate.simulate(), whosefilenameargument is optional.Unfortunately, this requires modifications to
opentrons.protocols.parseto make the filename more pass-through, soadapt_protocol_source()can tell when it wasn't provided.Plus various smaller refactors for type safety, deduplication, and consistency.
Code review requests
I suggest code-reviewing this in two ways:
simulate.pyfile side-by-side with the latestexecute.pyfile. They should mirror each other almost exactly.simulate.pyreturns the run log, whereas the stuff inexecute.pysends run log events to a callback.execute.pyhas a global hardware controller and globalProtocolEngines, whereassimulate.pyonly has the globalProtocolEngines.Some special things to watch out for:
simulate.pyto make it look likeexecute.py, make sure I didn't accidentally drop anything unique to the oldsimulate.pythat was important.adapt_protocol_source()andopentrons.protocols.parse.Risk assessment
Medium.
This touches some subtle parts of
opentrons.protocols.parseandopentrons.protocols.execute. The touches are light, but those areas are critical to protocol execution.It also touches the simulation of PAPIv≤2.13 and JSONv≤5 protocols, so we need regression testing on those. See the test plan.