refactor(api, robot-server): Refactor ProtocolRunner per protocol type

api/src/opentrons/cli/analyze.py

@@ -76,7 +76,9 @@ async def _analyze(
  except ProtocolFilesInvalidError as error:
  raise click.ClickException(str(error))
 
- runner = await create_simulating_runner(robot_type=protocol_source.robot_type)
+ runner = await create_simulating_runner(
+ robot_type=protocol_source.robot_type, protocol_config=protocol_source.config
+ )
  analysis = await runner.run(protocol_source)
 
  if json_output:

api/src/opentrons/protocol_runner/__init__.py

@@ -1,13 +1,26 @@
 """Protocol run control and management.
 
-The main export of this module is the ProtocolRunner class. See
+The main export of this module is the AbstractRunner class. See
 protocol_runner.py for more details.
 """
-from .protocol_runner import ProtocolRunner, ProtocolRunResult
+from .protocol_runner import (
+ AbstractRunner,
+ RunResult,
+ create_protocol_runner,
+ JsonRunner,
+ PythonAndLegacyRunner,
+ LiveRunner,
+ RunnerType,
+)
 from .create_simulating_runner import create_simulating_runner
 
 __all__ = [
- "ProtocolRunner",
- "ProtocolRunResult",
+ "AbstractRunner",
+ "RunResult",
  "create_simulating_runner",
+ "create_protocol_runner",
+ "JsonRunner",
+ "PythonAndLegacyRunner",
+ "LiveRunner",
+ "RunnerType",
 ]

api/src/opentrons/protocol_runner/create_simulating_runner.py

@@ -1,20 +1,23 @@
-"""Simulating ProtocolRunner factory."""
+"""Simulating AbstractRunner factory."""
 
 from opentrons.config import feature_flags
 from opentrons.hardware_control import API as OT2API, HardwareControlAPI
 from opentrons.protocol_engine import (
  Config as ProtocolEngineConfig,
  create_protocol_engine,
 )
+from opentrons.protocol_reader.protocol_source import ProtocolConfig
 
 from opentrons_shared_data.robot.dev_types import RobotType
 
 from .legacy_wrappers import LegacySimulatingContextCreator
-from .protocol_runner import ProtocolRunner
+from .protocol_runner import create_protocol_runner, AbstractRunner
 
 
-async def create_simulating_runner(robot_type: RobotType) -> ProtocolRunner:
- """Create a ProtocolRunner wired to a simulating HardwareControlAPI.
+async def create_simulating_runner(
+ robot_type: RobotType, protocol_config: ProtocolConfig
+) -> AbstractRunner:
+ """Create a AbstractRunner wired to a simulating HardwareControlAPI.
 
  Example:
  ```python
@@ -24,15 +27,15 @@ async def create_simulating_runner(robot_type: RobotType) -> ProtocolRunner:
  from opentrons.protocol_runner import (
  ProtocolType,
  ProtocolFile,
- ProtocolRunner,
+ AbstractRunner,
  create_simulating_runner,
  )
 
  protocol = ProtocolFile(
  protocol_type=ProtocolType.PYTHON,
  files=[Path("/path/to/protocol.py")],
  )
- runner: ProtocolRunner = await create_simulating_runner()
+ runner: AbstractRunner = await create_simulating_runner()
  commands: List[Command] = await runner.run(protocol)
  ```
  """
@@ -62,7 +65,8 @@ async def create_simulating_runner(robot_type: RobotType) -> ProtocolRunner:
  protocol_engine=protocol_engine,
  )
 
- return ProtocolRunner(
+ return create_protocol_runner(
+ protocol_config=protocol_config,
  protocol_engine=protocol_engine,
  hardware_api=simulating_hardware_api,
  legacy_context_creator=simulating_legacy_context_creator,

api/src/opentrons/protocol_runner/legacy_wrappers.py

@@ -96,6 +96,8 @@ def read(
  )
 
 
+# TODO (spp, 2023-04-05): Remove 'legacy' wording since this is the context we are using
+# for all python protocols.
 class LegacyContextCreator:
  """Interface to construct Protocol API v2 contexts."""