opentrons 8.4.0a3__py2.py3-none-any.whl → 8.4.0a5__py2.py3-none-any.whl

opentrons/legacy_commands/commands.py

@@ -1,12 +1,18 @@
 from __future__ import annotations
-from typing import TYPE_CHECKING, List, Union, overload
+from typing import TYPE_CHECKING, List, Sequence, Union, overload
 
 
-from .helpers import stringify_location, stringify_disposal_location, listify
+from .helpers import (
+    stringify_location,
+    stringify_disposal_location,
+    stringify_well_list,
+    listify,
+)
 from . import types as command_types
 
 from opentrons.types import Location
 from opentrons.protocol_api.disposal_locations import TrashBin, WasteChute
+from opentrons.protocol_api._liquid import LiquidClass
 
 if TYPE_CHECKING:
     from opentrons.protocol_api import InstrumentContext
@@ -317,6 +323,81 @@ def move_to_disposal_location(
     }
 
 
+def transfer_with_liquid_class(
+    instrument: InstrumentContext,
+    liquid_class: LiquidClass,
+    volume: float,
+    source: Union[Well, Sequence[Well], Sequence[Sequence[Well]]],
+    destination: Union[Well, Sequence[Well], Sequence[Sequence[Well]]],
+) -> command_types.TransferWithLiquidClassCommand:
+    text = (
+        "Transferring "
+        + f"{volume} uL of {liquid_class.display_name} liquid class from "
+        + f"{stringify_well_list(source)} to {stringify_well_list(destination)}"
+    )
+    return {
+        "name": command_types.TRANSFER_WITH_LIQUID_CLASS,
+        "payload": {
+            "instrument": instrument,
+            "liquid_class": liquid_class,
+            "volume": volume,
+            "source": source,
+            "destination": destination,
+            "text": text,
+        },
+    }
+
+
+def distribute_with_liquid_class(
+    instrument: InstrumentContext,
+    liquid_class: LiquidClass,
+    volume: float,
+    source: Union[Well, Sequence[Well], Sequence[Sequence[Well]]],
+    destination: Union[Well, Sequence[Well], Sequence[Sequence[Well]]],
+) -> command_types.DistributeWithLiquidClassCommand:
+    text = (
+        "Distributing "
+        + f"{volume} uL of {liquid_class.display_name} liquid class from "
+        + f"{stringify_well_list(source)} to {stringify_well_list(destination)}"
+    )
+    return {
+        "name": command_types.DISTRIBUTE_WITH_LIQUID_CLASS,
+        "payload": {
+            "instrument": instrument,
+            "liquid_class": liquid_class,
+            "volume": volume,
+            "source": source,
+            "destination": destination,
+            "text": text,
+        },
+    }
+
+
+def consolidate_with_liquid_class(
+    instrument: InstrumentContext,
+    liquid_class: LiquidClass,
+    volume: float,
+    source: Union[Well, Sequence[Well], Sequence[Sequence[Well]]],
+    destination: Union[Well, Sequence[Well], Sequence[Sequence[Well]]],
+) -> command_types.ConsolidateWithLiquidClassCommand:
+    text = (
+        "Consolidating "
+        + f"{volume} uL of {liquid_class.display_name} liquid class from "
+        + f"{stringify_well_list(source)} to {stringify_well_list(destination)}"
+    )
+    return {
+        "name": command_types.CONSOLIDATE_WITH_LIQUID_CLASS,
+        "payload": {
+            "instrument": instrument,
+            "liquid_class": liquid_class,
+            "volume": volume,
+            "source": source,
+            "destination": destination,
+            "text": text,
+        },
+    }
+
+
 def seal(
     instrument: InstrumentContext,
     location: Well,

opentrons/legacy_commands/helpers.py

@@ -1,4 +1,4 @@
-from typing import List, Union
+from typing import List, Union, Sequence
 
 from opentrons.protocol_api.labware import Well, Labware
 from opentrons.protocol_api.module_contexts import ModuleContext
@@ -48,6 +48,64 @@ def stringify_disposal_location(location: Union[TrashBin, WasteChute]) -> str:
         return "Waste Chute"
 
 
+def _group_wells_by_labware(wells: List[Well]) -> List[List[Well]]:
+    wells_by_labware: List[List[Well]] = []
+    sub_list = []
+    active_parent_labware = None
+    for well in wells:
+        if well.parent == active_parent_labware:
+            sub_list.append(well)
+        else:
+            active_parent_labware = well.parent
+            if sub_list:
+                wells_by_labware.append(sub_list)
+            sub_list = [well]
+    if sub_list:
+        wells_by_labware.append(sub_list)
+
+    return wells_by_labware
+
+
+def _stringify_multiple_wells_for_labware(wells: List[Well]) -> str:
+    if len(wells) == 0:
+        return ""
+    elif len(wells) == 1:
+        return str(wells[0])
+    # TODO(jbl 2025-04-10) this logic can be improved to more intelligently group wells
+    elif len(wells) < 9:  # At most we'll print out a full column's worth of well
+        return ", ".join([well.well_name for well in wells[:-1]]) + f", {wells[-1]}"
+    else:  # Otherwise print the first and last three
+        return (
+            ", ".join([well.well_name for well in wells[:3]])
+            + ", ... "
+            + ", ".join([well.well_name for well in wells[-3:-1]])
+            + f", {wells[-1]}"
+        )
+
+
+def stringify_well_list(
+    wells: Union[Well, Sequence[Well], Sequence[Sequence[Well]]]
+) -> str:
+    """Takes an arbitrary sequence of wells and returns a string representation of each well, associated by labware."""
+    if isinstance(wells, Well):
+        well_list = [wells]
+    elif len(wells) == 0:
+        well_list = []
+    elif isinstance(wells, list) and isinstance(wells[0], list):
+        well_list = [well for sub_well_list in wells for well in sub_well_list]
+    elif isinstance(wells, list):
+        well_list = wells
+    else:
+        return ""
+
+    return "; ".join(
+        [
+            _stringify_multiple_wells_for_labware(wells_by_labware)
+            for wells_by_labware in _group_wells_by_labware(well_list)
+        ]
+    )
+
+
 def _stringify_labware_movement_location(
     location: Union[
         DeckLocation, OffDeckType, Labware, ModuleContext, WasteChute, TrashBin

opentrons/legacy_commands/types.py

@@ -8,6 +8,7 @@ if TYPE_CHECKING:
     from opentrons.protocol_api import InstrumentContext
     from opentrons.protocol_api.labware import Well
     from opentrons.protocol_api.disposal_locations import TrashBin, WasteChute
+    from opentrons.protocol_api._liquid import LiquidClass
 
 from opentrons.types import Location
 
@@ -43,6 +44,9 @@ TOUCH_TIP: Final = "command.TOUCH_TIP"
 RETURN_TIP: Final = "command.RETURN_TIP"
 MOVE_TO: Final = "command.MOVE_TO"
 MOVE_TO_DISPOSAL_LOCATION: Final = "command.MOVE_TO_DISPOSAL_LOCATION"
+TRANSFER_WITH_LIQUID_CLASS: Final = "command.TRANSFER_WITH_LIQUID_CLASS"
+DISTRIBUTE_WITH_LIQUID_CLASS: Final = "command.DISTRIBUTE_WITH_LIQUID_CLASS"
+CONSOLIDATE_WITH_LIQUID_CLASS: Final = "command.CONSOLIDATE_WITH_LIQUID_CLASS"
 SEAL: Final = "command.SEAL"
 UNSEAL: Final = "command.UNSEAL"
 PRESSURIZE: Final = "command.PRESSURIZE"
@@ -540,6 +544,28 @@ class MoveLabwareCommandPayload(TextOnlyPayload):
     pass
 
 
+class LiquidClassCommandPayload(TextOnlyPayload, SingleInstrumentPayload):
+    liquid_class: LiquidClass
+    volume: float
+    source: Union[Well, Sequence[Well], Sequence[Sequence[Well]]]
+    destination: Union[Well, Sequence[Well], Sequence[Sequence[Well]]]
+
+
+class TransferWithLiquidClassCommand(TypedDict):
+    name: Literal["command.TRANSFER_WITH_LIQUID_CLASS"]
+    payload: LiquidClassCommandPayload
+
+
+class DistributeWithLiquidClassCommand(TypedDict):
+    name: Literal["command.DISTRIBUTE_WITH_LIQUID_CLASS"]
+    payload: LiquidClassCommandPayload
+
+
+class ConsolidateWithLiquidClassCommand(TypedDict):
+    name: Literal["command.CONSOLIDATE_WITH_LIQUID_CLASS"]
+    payload: LiquidClassCommandPayload
+
+
 class SealCommandPayload(TextOnlyPayload):
     instrument: InstrumentContext
     location: Union[None, Location, Well]
@@ -622,6 +648,9 @@ Command = Union[
     MoveToCommand,
     MoveToDisposalLocationCommand,
     MoveLabwareCommand,
+    TransferWithLiquidClassCommand,
+    DistributeWithLiquidClassCommand,
+    ConsolidateWithLiquidClassCommand,
     SealCommand,
     UnsealCommand,
     PressurizeCommand,
@@ -674,6 +703,7 @@ CommandPayload = Union[
     MoveToCommandPayload,
     MoveToDisposalLocationCommandPayload,
     MoveLabwareCommandPayload,
+    LiquidClassCommandPayload,
     SealCommandPayload,
     UnsealCommandPayload,
     PressurizeCommandPayload,