feat(api): publish pause and delay commands in python and JSON #3310
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
This adds an optional message parameter to the delay function in the python apiv2. The message is published to the run log appended to the standard timing message. The json executor for apiv1 and apiv2 is capable of receiving messages for both delays and pauses. This will allow PD user's input Pause step messages to be presented in the App's run log regardless of the duration (including indefinite holds) of a pause. Closes #3308
b-cooper
added
feature
Codecov Report
@@ Coverage Diff @@
## edge #3310 +/- ##
==========================================
- Coverage 53.63% 53.01% -0.63%
==========================================
Files 719 737 +18
Lines 21017 22088 +1071
==========================================
+ Hits 11272 11709 +437
- Misses 9745 10379 +634
Continue to review full report at Codecov.
|
Laura-Danielle
approved these changes
Apr 8, 2019
There was a problem hiding this comment.
Tested on 🌆 . @IanLondon said to wait to merge this until his PR is in
|
Please don't merge until #3312 thanks! |
IanLondon
suggested changes
Apr 10, 2019
| robot.pause(msg=message) | ||
| else: | ||
| text = f'Delaying for {datetime.timedelta(seconds=wait)}' | ||
| if message: | ||
| text = f"{text}. {message}" |
There was a problem hiding this comment.
this text var doesn't go anywhere, so APIv1 runs don't give a message for timed delays
| @@ -169,14 +169,15 @@ def dispatch_json(context: ProtocolContext, # noqa(C901) | |||
| pipette_name = protocol_pipette_data.get('model') | |||
|
|
|||
| if command_type == 'delay': | |||
| wait = params['wait'] | |||
| wait = params.get('wait') | |||
There was a problem hiding this comment.
wait is required in schema v1/2/3, so we can do params['wait'] no need to get. Message is optional so get is right there
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.
This adds an optional message parameter to the delay function in the python apiv2. The message is
published to the run log appended to the standard timing message eg "Delay for 10m 2s".
In addition, the JSON executor for apiv1 and apiv2 is now capable of receiving messages for both delays and pauses. This will allow PD user's input within Pause step messages to be presented in the App's run log regardless of the duration (including indefinite holds) of a pause.
Closes #3308
##Changelog
msgparam for python APIv2delayfunctionReview Requests