Skip to content

Commit dc67def

Browse files
authored
refactor(api): rename visit_every_well argument in liquid class transfers (#18527)
Renames the `visit_every_well` argument of the three liquid class transfers to `group_well`, reversing the boolean logic as well for this argument.
1 parent 9a0cab7 commit dc67def

File tree

2 files changed

+17
-8
lines changed

2 files changed

+17
-8
lines changed

api/src/opentrons/protocol_api/_transfer_liquid_validation.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ def verify_and_normalize_transfer_args(
3333
last_tip_picked_up_from: Optional[Well],
3434
tip_racks: List[Labware],
3535
nozzle_map: NozzleMapInterface,
36-
target_all_wells: bool,
36+
group_wells_for_multi_channel: bool,
3737
current_volume: float,
3838
trash_location: Union[Location, Well, Labware, TrashBin, WasteChute],
3939
) -> TransferInfo:
@@ -43,7 +43,7 @@ def verify_and_normalize_transfer_args(
4343
else:
4444
# If trash bin or waste chute, set this to empty to have less isinstance checks after this
4545
flat_dests_list = []
46-
if not target_all_wells and nozzle_map.tip_count > 1:
46+
if group_wells_for_multi_channel and nozzle_map.tip_count > 1:
4747
flat_sources_list = tx_liquid_utils.group_wells_for_multi_channel_transfer(
4848
flat_sources_list, nozzle_map
4949
)

api/src/opentrons/protocol_api/instrument_context.py

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1794,7 +1794,7 @@ def transfer_with_liquid_class(
17941794
Union[types.Location, labware.Well, TrashBin, WasteChute]
17951795
] = None,
17961796
return_tip: bool = False,
1797-
visit_every_well: bool = False,
1797+
group_wells: bool = True,
17981798
) -> InstrumentContext:
17991799
"""Move a particular type of liquid from one well or group of wells to another.
18001800
@@ -1827,6 +1827,9 @@ def transfer_with_liquid_class(
18271827
tips. Depending on the liquid class, the pipette may also blow out liquid here.
18281828
:param return_tip: Whether to drop used tips in their original locations
18291829
in the tip rack, instead of the trash.
1830+
:param group_wells: For multi-channel transfers only. If set to ``True``, group together contiguous wells
1831+
given into a single transfer step, taking into account the tip configuration. If ``False``, target
1832+
each well given with the primary nozzle. Defaults to ``True``.
18301833
18311834
:meta private:
18321835
"""
@@ -1844,7 +1847,7 @@ def transfer_with_liquid_class(
18441847
last_tip_picked_up_from=self._last_tip_picked_up_from,
18451848
tip_racks=self._tip_racks,
18461849
nozzle_map=self._core.get_nozzle_map(),
1847-
target_all_wells=visit_every_well,
1850+
group_wells_for_multi_channel=group_wells,
18481851
current_volume=self.current_volume,
18491852
trash_location=(
18501853
trash_location if trash_location is not None else self.trash_container
@@ -1913,7 +1916,7 @@ def distribute_with_liquid_class(
19131916
Union[types.Location, labware.Well, TrashBin, WasteChute]
19141917
] = None,
19151918
return_tip: bool = False,
1916-
visit_every_well: bool = False,
1919+
group_wells: bool = True,
19171920
) -> InstrumentContext:
19181921
"""
19191922
Distribute a particular type of liquid from one well to a group of wells.
@@ -1943,6 +1946,9 @@ def distribute_with_liquid_class(
19431946
tips. Depending on the liquid class, the pipette may also blow out liquid here.
19441947
:param return_tip: Whether to drop used tips in their original locations
19451948
in the tip rack, instead of the trash.
1949+
:param group_wells: For multi-channel transfers only. If set to ``True``, group together contiguous wells
1950+
given into a single transfer step, taking into account the tip configuration. If ``False``, target
1951+
each well given with the primary nozzle. Defaults to ``True``.
19461952
19471953
:meta private:
19481954
"""
@@ -1960,7 +1966,7 @@ def distribute_with_liquid_class(
19601966
last_tip_picked_up_from=self._last_tip_picked_up_from,
19611967
tip_racks=self._tip_racks,
19621968
nozzle_map=self._core.get_nozzle_map(),
1963-
target_all_wells=visit_every_well,
1969+
group_wells_for_multi_channel=group_wells,
19641970
current_volume=self.current_volume,
19651971
trash_location=(
19661972
trash_location if trash_location is not None else self.trash_container
@@ -2035,7 +2041,7 @@ def consolidate_with_liquid_class(
20352041
Union[types.Location, labware.Well, TrashBin, WasteChute]
20362042
] = None,
20372043
return_tip: bool = False,
2038-
visit_every_well: bool = False,
2044+
group_wells: bool = True,
20392045
) -> InstrumentContext:
20402046
"""
20412047
Consolidate a particular type of liquid from a group of wells to one well.
@@ -2066,6 +2072,9 @@ def consolidate_with_liquid_class(
20662072
tips. Depending on the liquid class, the pipette may also blow out liquid here.
20672073
:param return_tip: Whether to drop used tips in their original locations
20682074
in the tip rack, instead of the trash.
2075+
:param group_wells: For multi-channel transfers only. If set to ``True``, group together contiguous wells
2076+
given into a single transfer step, taking into account the tip configuration. If ``False``, target
2077+
each well given with the primary nozzle. Defaults to ``True``.
20692078
20702079
:meta private:
20712080
"""
@@ -2083,7 +2092,7 @@ def consolidate_with_liquid_class(
20832092
last_tip_picked_up_from=self._last_tip_picked_up_from,
20842093
tip_racks=self._tip_racks,
20852094
nozzle_map=self._core.get_nozzle_map(),
2086-
target_all_wells=visit_every_well,
2095+
group_wells_for_multi_channel=group_wells,
20872096
current_volume=self.current_volume,
20882097
trash_location=(
20892098
trash_location if trash_location is not None else self.trash_container

0 commit comments

Comments
 (0)