fix(api): simulation allows aspirating and dispensing on a tip rack

.gitignore

@@ -52,6 +52,7 @@ pip-delete-this-directory.txt
 
 # node packages
 node_modules
+package-lock.json
 
 # Unit test / coverage reports
 htmlcov/

api/docs/v2/versioning.rst

@@ -114,6 +114,8 @@ This table lists the correspondence between Protocol API versions and robot soft
 +-------------+-----------------------------+
 |     2.10    |          4.3.0              |
 +-------------+-----------------------------+
+|     2.11    |          4.3.1              |
++-------------+-----------------------------+
 
 
 Changes in API Versions
@@ -207,3 +209,7 @@ Version 2.9
 Version 2.10
 ++++++++++++
 - In Python protocols requesting API version 2.10, moving to the same well twice in a row with different pipettes no longer results in strange diagonal movements.
+
+Version 2.11
+++++++++++++
+- In Python protocols requesting API version 2.11, validation to prevent aspiration and dispensation to tip-racks.

api/src/opentrons/protocol_api/instrument_context.py

@@ -12,7 +12,7 @@
 from opentrons.protocols.advanced_control.mix import mix_from_kwargs
 from opentrons.protocols.api_support.instrument import \
     validate_blowout_location, tip_length_for, validate_tiprack, \
-    determine_drop_target
+    determine_drop_target, validate_can_aspirate, validate_can_dispense
 from opentrons.protocols.api_support.labware_like import LabwareLike
 from opentrons.protocol_api.module_contexts import ThermocyclerContext
 from opentrons.protocols.api_support.util import (
@@ -183,6 +183,7 @@ def aspirate(self,
                 " method that moves to a location (such as move_to or "
                 "dispense) must previously have been called so the robot "
                 "knows where it is.")
+        validate_can_aspirate(dest)
 
         if self.current_volume == 0:
             # Make sure we're at the top of the labware and clear of any
@@ -286,6 +287,7 @@ def dispense(self,
                 " method that moves to a location (such as move_to or "
                 "aspirate) must previously have been called so the robot "
                 "knows where it is.")
+        validate_can_dispense(loc)
 
         c_vol = self.current_volume if not volume else volume
 

api/src/opentrons/protocols/api_support/definitions.py

@@ -1,6 +1,6 @@
 from .types import APIVersion
 
-MAX_SUPPORTED_VERSION = APIVersion(2, 10)
+MAX_SUPPORTED_VERSION = APIVersion(2, 11)
 #: The maximum supported protocol API version in this release
 
 V2_MODULE_DEF_VERSION = APIVersion(2, 3)

api/src/opentrons/protocols/api_support/instrument.py

@@ -1,5 +1,5 @@
 import logging
-from typing import Optional, Any
+from typing import Optional, Any, Union
 
 from opentrons import types
 from opentrons.calibration_storage import get
@@ -104,3 +104,47 @@ def determine_drop_target(
         assert tr.is_tiprack
         z_height = return_height * tr.tip_length
         return location.top(-z_height)
+
+
+def validate_can_aspirate(
+        location: Union[Labware, Well, types.Location]) -> None:
+    """ Can one aspirate on the given `location` or not? This method is
+    pretty basic and will probably remain so (?) as the future holds neat
+    ambitions for how validation is implemented. And as robots become more
+    intelligent more rigorous testing will be possible
+
+    Args:
+        location: target for aspiration
+
+    Raises:
+        RuntimeError:
+    """
+    if _is_tiprack(location):
+        raise RuntimeError("Cannot aspirate a tiprack")
+
+
+def validate_can_dispense(location: types.Location) -> None:
+    """ Can one dispense to the given `location` or not? This method is
+    pretty basic and will probably remain so (?) as the future holds neat
+    ambitions for how validation is implemented. And as robots become more
+    intelligent more rigorous testing will be possible
+
+    Args:
+        location: target for dispense
+
+    Raises:
+        RuntimeError:
+    """
+    labware = location.labware.as_labware()
+    if labware.parent and labware.parent.is_tiprack:
+        raise RuntimeError("Cannot dispense to a tiprack")
+
+
+def _is_tiprack(location: Union[Labware, Well, types.Location]) -> bool:
+    if isinstance(location, Labware):
+        return location.is_tiprack
+    elif isinstance(location, Well):
+        return location.parent.is_tiprack
+    else:
+        labware = location.labware.as_labware()
+        return labware.parent and labware.parent.is_tiprack

api/tests/opentrons/data/bug_aspirate_tip.py

@@ -0,0 +1,22 @@
+from opentrons import protocol_api
+
+# metadata
+metadata = {
+    'protocolName': 'Bug 7552',
+    'author': 'Name <[email protected]>',
+    'description': 'Simulation allows aspirating and dispensing on a tip rack',
+    'apiLevel': '2.7'
+}
+
+
+# protocol run function. the part after the colon lets your editor know
+# where to look for autocomplete suggestions
+def run(protocol: protocol_api.ProtocolContext):
+    # labware
+    plate = protocol.load_labware('geb_96_tiprack_10ul', 4)
+
+    # pipettes
+    pipette = protocol.load_instrument('p300_single', 'left', tip_racks=[plate])
+
+    # commands
+    pipette.transfer(5, plate.wells_by_name()['A1'], plate.wells_by_name()['B1'])

api/tests/opentrons/protocols/api_support/test_instrument.py

@@ -2,7 +2,9 @@
 
 import pytest
 from opentrons.protocol_api.labware import Well
-from opentrons.protocols.api_support.instrument import determine_drop_target
+from opentrons.protocols.api_support.instrument import determine_drop_target, \
+    validate_can_aspirate, \
+    validate_can_dispense
 from opentrons.protocols.geometry.well_geometry import WellGeometry
 from opentrons.protocols.context.well import WellImplementation
 from opentrons.protocols.api_support.types import APIVersion
@@ -48,3 +50,28 @@ def test_determine_drop_target(
     r = determine_drop_target(api_version, well, 0.5)
     assert r.labware.object == well
     assert r.point == expected_point
+
+
+def test_validate_can_aspirate(ctx):
+    well_plate = ctx.load_labware('corning_96_wellplate_360ul_flat', 1)
+    tip_rack = ctx.load_labware('opentrons_96_tiprack_300ul', 2)
+    # test type `Labware`
+    validate_can_aspirate(well_plate)
+    # test type `Well`
+    validate_can_aspirate(well_plate.wells()[0])
+    # test type `Location`
+    validate_can_aspirate(well_plate.wells()[0].top())
+    with pytest.raises(RuntimeError):
+        validate_can_aspirate(tip_rack)
+    with pytest.raises(RuntimeError):
+        validate_can_aspirate(tip_rack.wells_by_name()['A1'])
+    with pytest.raises(RuntimeError):
+        validate_can_aspirate(tip_rack.wells_by_name()['A1'].top())
+
+
+def test_validate_can_dispense(ctx):
+    well_plate = ctx.load_labware('corning_96_wellplate_360ul_flat', 1)
+    tip_rack = ctx.load_labware('opentrons_96_tiprack_300ul', 2)
+    validate_can_dispense(well_plate.wells()[0].top())
+    with pytest.raises(RuntimeError):
+        validate_can_dispense(tip_rack.wells_by_name()['A1'].top())

api/tests/opentrons/test_simulate.py

@@ -116,3 +116,10 @@ def test_simulate_extra_labware(protocol, protocol_file, monkeypatch):
     ctx = simulate.get_protocol_api('2.0')
     with pytest.raises(FileNotFoundError):
         ctx.load_labware("fixture_12_trough", 1, namespace='fixture')
+
+
+@pytest.mark.parametrize('protocol_file', ['bug_aspirate_tip.py'])
+def test_simulate_aspirate_tip(protocol, protocol_file, monkeypatch):
+    monkeypatch.setenv('OT_API_FF_allowBundleCreation', '1')
+    with pytest.raises(ExceptionInProtocolError):
+        simulate.simulate(protocol.filelike, 'bug_aspirate_tip.py')