Hackishly expose commandAnnotations in protocol analysis output.

api/src/opentrons/cli/analyze.py

@@ -105,6 +105,7 @@ async def _analyze(
  pipettes=analysis.state_summary.pipettes,
  modules=analysis.state_summary.modules,
  liquids=analysis.state_summary.liquids,
+ commandAnnotations=protocol_source.command_annotations,
  )
 
  await json_output.write_text(
@@ -156,3 +157,4 @@ class AnalyzeResults(BaseModel):
  modules: List[LoadedModule]
  liquids: List[Liquid]
  errors: List[ErrorOccurrence]
+ commandAnnotations: List[Any]

api/src/opentrons/protocol_reader/file_identifier.py

@@ -2,7 +2,7 @@
 
 import json
 from dataclasses import dataclass
-from typing import Any, Dict, Sequence, Union
+from typing import Any, Dict, List, Sequence, Union
 
 import anyio
 
@@ -44,6 +44,8 @@ class IdentifiedJsonMain:
  metadata: Metadata
  """The protocol metadata extracted from this file."""
 
+ command_annotations: List[Any]
+
 
 @dataclass(frozen=True)
 class IdentifiedPythonMain:
@@ -61,6 +63,8 @@ class IdentifiedPythonMain:
  metadata: Metadata
  """The protocol metadata extracted from this file."""
 
+ command_annotations: List[Any]
+
 
 @dataclass(frozen=True)
 class IdentifiedLabwareDefinition:
@@ -181,6 +185,7 @@ def _analyze_json_protocol(
  metadata = json_contents["metadata"]
  schema_version = json_contents["schemaVersion"]
  robot_type = json_contents["robot"]["model"]
+ command_annotations = json_contents.get("commandAnnotations", [])
  except KeyError as e:
  raise FileIdentificationError(error_message) from e
 
@@ -190,6 +195,9 @@ def _analyze_json_protocol(
  if not isinstance(metadata, dict):
  raise FileIdentificationError(error_message)
 
+ if not isinstance(command_annotations, list):
+ raise FileIdentificationError(error_message)
+
  if not isinstance(schema_version, int):
  raise FileIdentificationError(error_message)
 
@@ -202,6 +210,7 @@ def _analyze_json_protocol(
  schema_version=schema_version,
  robot_type=robot_type,
  metadata=metadata,
+ command_annotations=command_annotations,
  )
 
 
@@ -235,4 +244,5 @@ def _analyze_python_protocol(
  metadata=parsed.metadata or {},
  robot_type=parsed.robot_type,
  api_level=parsed.api_level,
+ command_annotations=[],
  )

api/src/opentrons/protocol_reader/protocol_reader.py

@@ -98,6 +98,7 @@ async def save(
  config=self._map_config(role_analysis),
  robot_type=role_analysis.main_file.robot_type,
  metadata=role_analysis.main_file.metadata,
+ command_annotations=role_analysis.main_file.command_annotations,
  )
 
  async def read_saved(
@@ -164,6 +165,7 @@ async def read_saved(
  config=self._map_config(role_analysis),
  robot_type=role_analysis.main_file.robot_type,
  metadata=role_analysis.main_file.metadata,
+ command_annotations=role_analysis.main_file.command_annotations,
  )
 
  @staticmethod

api/src/opentrons/protocol_reader/protocol_source.py

@@ -122,3 +122,4 @@ class ProtocolSource:
  metadata: Metadata
  robot_type: RobotType
  config: ProtocolConfig
+ command_annotations: List[Any]

robot-server/robot_server/protocols/analysis_models.py

@@ -2,7 +2,7 @@
 # TODO(mc, 2021-08-25): add modules to simulation result
 from enum import Enum
 from pydantic import BaseModel, Field
-from typing import List, Union
+from typing import Any, List, Union
 from typing_extensions import Literal
 
 from opentrons.protocol_engine import (
@@ -118,6 +118,7 @@ class CompletedAnalysis(BaseModel):
  default_factory=list,
  description="Liquids used by the protocol",
  )
+ commandAnnotations: List[Any] = Field(default_factory=list)
 
 
 ProtocolAnalysis = Union[PendingAnalysis, CompletedAnalysis]

robot-server/robot_server/protocols/analysis_store.py

@@ -3,7 +3,7 @@
 
 
 from logging import getLogger
-from typing import Dict, List, Optional
+from typing import Any, Dict, List, Optional
 from typing_extensions import Final
 
 import sqlalchemy
@@ -126,6 +126,7 @@ async def update(
  pipettes: List[LoadedPipette],
  errors: List[ErrorOccurrence],
  liquids: List[Liquid],
+ command_annotations: List[Any],
  ) -> None:
  """Promote a pending analysis to completed, adding details of its results.
 
@@ -162,6 +163,7 @@ async def update(
  pipettes=pipettes,
  errors=errors,
  liquids=liquids,
+ commandAnnotations=command_annotations,
  )
  completed_analysis_resource = CompletedAnalysisResource(
  id=completed_analysis.id,

robot-server/robot_server/protocols/protocol_analyzer.py

@@ -42,4 +42,5 @@ async def analyze(
  pipettes=result.state_summary.pipettes,
  errors=result.state_summary.errors,
  liquids=result.state_summary.liquids,
+ command_annotations=protocol_resource.source.command_annotations,
  )