Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(api): add scaffolding for opentrons.file_runner module #7757

Merged
merged 2 commits into from
May 3, 2021

Conversation

mcous
Copy link
Contributor

@mcous mcous commented May 3, 2021

Overview

This PR adds a few interfaces to support the buildout of a new protocol file runner module: opentrons.file_runner.

Closes #7644

Changelog

  • refactor(api): add scaffodling for opentrons.file_runner module

Review requests

Do these interfaces and xfail'd tests seem like a good starting point?

Risk assessment

None. Code added is not wired to anything, and doesn't do anything anyway

Verified

This commit was signed with the committer’s verified signature.
pdabelf5 Paul Abel
Closes #7644
@mcous mcous added the robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience). label May 3, 2021
@mcous mcous requested a review from a team as a code owner May 3, 2021 15:36
@codecov
Copy link

codecov bot commented May 3, 2021

Codecov Report

Merging #7757 (c6667d9) into edge (2b249d9) will decrease coverage by 10.25%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##             edge    #7757       +/-   ##
===========================================
- Coverage   93.42%   83.17%   -10.26%     
===========================================
  Files         114      331      +217     
  Lines        4763    22254    +17491     
===========================================
+ Hits         4450    18510    +14060     
- Misses        313     3744     +3431     
Impacted Files Coverage Δ
opentrons/hardware_control/simulator.py 85.10% <0.00%> (ø)
opentrons/api/util.py 92.59% <0.00%> (ø)
opentrons/hardware_control/dev_types.py 98.30% <0.00%> (ø)
opentrons/drivers/rpi_drivers/usb.py 90.80% <0.00%> (ø)
opentrons/protocol_engine/state/pipettes.py 98.61% <0.00%> (ø)
opentrons/hardware_control/pipette.py 87.43% <0.00%> (ø)
opentrons/protocols/execution/errors.py 100.00% <0.00%> (ø)
opentrons/file_runner/python_file_runner.py 100.00% <0.00%> (ø)
...ntrons/protocols/context/engine/labware_context.py 97.89% <0.00%> (ø)
opentrons/hardware_control/api.py 84.60% <0.00%> (ø)
... and 207 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2b249d9...c6667d9. Read the comment docs.

@mcous mcous changed the title refactor(api): add scaffodling for opentrons.file_runner module refactor(api): add scaffolding for opentrons.file_runner module May 3, 2021
"""Abstract interface for an object that can run protocol files."""

@abstractmethod
def load(self) -> None:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor nits:

  • I can't quite envision what an argument-less load method might do. Are you sure it is required in the abstract base class?
  • Should it be async?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, good point. Will omit for now

Verified

This commit was signed with the committer’s verified signature.
pdabelf5 Paul Abel
@mcous mcous merged commit 60df556 into edge May 3, 2021
@mcous mcous deleted the api_protocol-runner branch May 3, 2021 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience).
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create interface for running protocol files
2 participants