fix(api): Error handling for unsupported pipette configuration behavior with partial column and row #15961
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
ecormany
reviewed
Aug 12, 2024
Co-authored-by: Ed Cormany <[email protected]>
Co-authored-by: Ed Cormany <[email protected]>
Co-authored-by: Ed Cormany <[email protected]>
Co-authored-by: Ed Cormany <[email protected]>
Co-authored-by: Ed Cormany <[email protected]>
Co-authored-by: Ed Cormany <[email protected]>
Co-authored-by: Ed Cormany <[email protected]>
sanni-t
reviewed
Aug 14, 2024
Comment on lines
2113
to
2121
| raise ValueError( | ||
| f"A partial column configuration with 'start'={start} cannot have its 'end' parameter be in row A." | ||
| ) | ||
| back_left_resolved = end | ||
| elif start == "A1" or start == "A12": | ||
| if "H" in end: | ||
| raise ValueError( | ||
| f"A partial column configuration with 'start'={start} cannot have its 'end' parameter be in row H." | ||
| ) |
There was a problem hiding this comment.
I feel like this should explain that a column configured to use nozzles A through H does not constitute a 'partial' column and that the user should use an ALL configuration instead. (Can you configure an 8-channel with a COLUMN configuration?)
| raise ValueError( | ||
| f"Parameters 'front_right' and 'back_left' cannot be used with {style.value} Nozzle Configuration Layout." | ||
| ) | ||
| if style == NozzleLayout.ROW: |
There was a problem hiding this comment.
Should we repeat the same check for COLUMN style too?
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
Covers PLAT-457
The 96ch does not currently have any approved nozzle maps supporting partial column configuration, so we want to raise a more helpful error when attempting it. Also, if the user provided a configuration that spanned A1 through H1 or H1 through H12 the partial column would accept it (maps existed for these). We want to block off this improper use of the API. The 8ch pipette similarly will now raise an error when attempting a ROW configuration, which is only meant for the 96ch.
Test Plan and Hands on Testing
Changelog
configure_nozzle_layoutAPI has new error cases and test cases to prevent improper use of API 2.20 layouts.Review requests
Risk assessment
Low, this simply enforces proper use of new behavior for 8.0.0. Eventually, if we want to enable partial column on the 96ch we will need to remove it's error case, but for now this makes use cases clearer with better feedback from analysis.