fix(api, app): display labware label (#9587)

Closes #9105, closes #9088

Co-authored-by: Brian Cooper <[email protected]>
Co-authored-by: Mike Cousins <[email protected]>

Author: 3 people

api/src/opentrons/protocol_api/load_info.py

@@ -40,6 +40,9 @@ class LabwareLoadInfo:
     # if there was one.
     offset_id: Optional[str]
 
+    # user-specified label if present
+    labware_display_name: Optional[str]
+
 
 @dataclass(frozen=True)
 class InstrumentLoadInfo:

api/src/opentrons/protocol_api/module_contexts.py

@@ -105,6 +105,7 @@ def load_labware_object(self, labware: Labware) -> Labware:
                 deck_slot=deck_slot,
                 on_module=True,
                 offset_id=provided_offset.offset_id,
+                labware_display_name=labware._implementation.get_label(),
             )
         )
         return mod_labware

api/src/opentrons/protocol_api/protocol_context.py

@@ -416,6 +416,7 @@ def load_labware_from_definition(
                 deck_slot=types.DeckSlotName.from_primitive(location),
                 on_module=False,
                 offset_id=provided_labware_offset.offset_id,
+                labware_display_name=implementation.get_label(),
             )
         )
 
@@ -483,6 +484,7 @@ def load_labware(
                 deck_slot=types.DeckSlotName.from_primitive(location),
                 on_module=False,
                 offset_id=provided_labware_offset.offset_id,
+                labware_display_name=implementation.get_label(),
             )
         )
 

api/src/opentrons/protocol_engine/commands/load_labware.py

@@ -36,6 +36,14 @@ class LoadLabwareParams(BaseModel):
         description="An optional ID to assign to this labware. If None, an ID "
         "will be generated.",
     )
+    displayName: Optional[str] = Field(
+        None,
+        description="An optional user-specified display name "
+        "or label for this labware.",
+        # NOTE: v4/5 JSON protocols will always have a displayName which will be the
+        #  user-specified label OR the displayName property of the labware's definition.
+        # TODO: Make sure v6 JSON protocols don't do that.
+    )
 
 
 class LoadLabwareResult(BaseModel):

api/src/opentrons/protocol_runner/legacy_command_mapper.py

@@ -201,6 +201,7 @@ def map_labware_load(
                 loadName=labware_load_info.labware_load_name,
                 namespace=labware_load_info.labware_namespace,
                 version=labware_load_info.labware_version,
+                displayName=labware_load_info.labware_display_name,
             ),
             result=pe_commands.LoadLabwareResult.construct(
                 labwareId=labware_id,

api/src/opentrons/protocols/context/labware.py

@@ -1,7 +1,7 @@
 """The interface that implements InstrumentContext."""
 
 from abc import abstractmethod
-from typing import List, Dict
+from typing import List, Dict, Optional
 
 from opentrons.protocols.geometry.deck_item import DeckItem
 from opentrons.protocols.geometry.labware_geometry import AbstractLabwareGeometry
@@ -23,6 +23,10 @@ def get_uri(self) -> str:
     def get_display_name(self) -> str:
         ...
 
+    @abstractmethod
+    def get_label(self) -> Optional[str]:
+        ...
+
     @abstractmethod
     def get_name(self) -> str:
         ...

api/src/opentrons/protocols/context/protocol_api/labware.py

@@ -35,8 +35,9 @@ def __init__(
         :param label: An optional label to use instead of the displayName
                       from the definition's metadata element
         """
+        self._label: Optional[str] = None
         if label:
-            dn = label
+            dn = self._label = label
             self._name = dn
         else:
             dn = definition["metadata"]["displayName"]
@@ -65,6 +66,9 @@ def get_uri(self) -> str:
     def get_display_name(self) -> str:
         return self._display_name
 
+    def get_label(self) -> Optional[str]:
+        return self._label
+
     def get_name(self) -> str:
         return self._name
 

api/tests/opentrons/protocol_api/test_labware_load.py

@@ -30,6 +30,7 @@ def test_get_mixed_case_labware_def():
 def test_load_label(ctx):
     labware = ctx.load_labware(labware_name, "1", "my cool labware")
     assert "my cool labware" in str(labware)
+    assert labware._implementation.get_label() == "my cool labware"
 
 
 def test_deprecated_load(ctx):

api/tests/opentrons/protocol_engine/commands/test_load_labware.py

@@ -39,6 +39,7 @@ async def test_load_labware_implementation(
         loadName="some-load-name",
         namespace="opentrons-test",
         version=1,
+        displayName="My custom display name",
     )
 
     decoy.when(

api/tests/opentrons/protocol_runner/test_legacy_command_mapper.py

@@ -241,6 +241,7 @@ def test_map_labware_load(minimal_labware_def: LabwareDefinition) -> None:
         deck_slot=DeckSlotName.SLOT_1,
         on_module=False,
         offset_id="labware-offset-id-123",
+        labware_display_name="My special labware",
     )
     expected_output = pe_commands.LoadLabware.construct(
         id=matchers.IsA(str),
@@ -254,6 +255,7 @@ def test_map_labware_load(minimal_labware_def: LabwareDefinition) -> None:
             namespace="some_namespace",
             loadName="some_load_name",
             version=123,
+            displayName="My special labware",
             labwareId=None,
         ),
         result=pe_commands.LoadLabwareResult.construct(
@@ -340,6 +342,7 @@ def test_map_module_labware_load(minimal_labware_def: LabwareDefinition) -> None
         labware_definition=minimal_labware_def,
         labware_namespace="some_namespace",
         labware_load_name="some_load_name",
+        labware_display_name="My very special module labware",
         labware_version=123,
         deck_slot=DeckSlotName.SLOT_1,
         on_module=True,
@@ -358,6 +361,7 @@ def test_map_module_labware_load(minimal_labware_def: LabwareDefinition) -> None
             namespace="some_namespace",
             loadName="some_load_name",
             version=123,
+            displayName="My very special module labware",
             labwareId=None,
         ),
         result=pe_commands.LoadLabwareResult.construct(