changed ProtocolRunResult to RunnerRunResult

api/src/opentrons/protocol_runner/__init__.py

@@ -5,7 +5,7 @@
 """
 from .protocol_runner import (
  AbstractRunner,
- ProtocolRunResult,
+ RunnerRunResult,
  create_protocol_runner,
  JsonRunner,
  PythonAndLegacyRunner,
@@ -15,7 +15,7 @@
 
 __all__ = [
  "AbstractRunner",
- "ProtocolRunResult",
+ "RunnerRunResult",
  "create_simulating_runner",
  "create_protocol_runner",
  "JsonRunner",

api/src/opentrons/protocol_runner/protocol_runner.py

@@ -31,7 +31,7 @@
 )
 
 
-class ProtocolRunResult(NamedTuple):
+class RunnerRunResult(NamedTuple):
  """Result data from a run, pulled from the ProtocolEngine."""
 
  commands: List[Command]
@@ -81,7 +81,7 @@ async def stop(self) -> None:
  async def run(
  self,
  protocol_source: Optional[ProtocolSource] = None,
- ) -> ProtocolRunResult:
+ ) -> RunnerRunResult:
  """Run a given protocol to completion."""
 
 
@@ -166,7 +166,7 @@ async def stop(self) -> None:
  async def run(
  self,
  protocol_source: Optional[ProtocolSource] = None,
- ) -> ProtocolRunResult:
+ ) -> RunnerRunResult:
  # TODO(mc, 2022-01-11): move load to runner creation, remove from `run`
  # currently `protocol_source` arg is only used by tests
  if protocol_source:
@@ -179,7 +179,7 @@ async def run(
 
  run_data = self._protocol_engine.state_view.get_summary()
  commands = self._protocol_engine.state_view.commands.get_all()
- return ProtocolRunResult(commands=commands, state_summary=run_data)
+ return RunnerRunResult(commands=commands, state_summary=run_data)
 
 
 class JsonRunner(AbstractRunner):
@@ -268,7 +268,7 @@ async def stop(self) -> None:
  async def run(
  self,
  protocol_source: Optional[ProtocolSource] = None,
- ) -> ProtocolRunResult:
+ ) -> RunnerRunResult:
  # TODO(mc, 2022-01-11): move load to runner creation, remove from `run`
  # currently `protocol_source` arg is only used by tests
  if protocol_source:
@@ -281,7 +281,7 @@ async def run(
 
  run_data = self._protocol_engine.state_view.get_summary()
  commands = self._protocol_engine.state_view.commands.get_all()
- return ProtocolRunResult(commands=commands, state_summary=run_data)
+ return RunnerRunResult(commands=commands, state_summary=run_data)
 
 
 class LiveRunner(AbstractRunner):
@@ -324,15 +324,12 @@ async def stop(self) -> None:
  async def run(
  self,
  protocol_source: Optional[ProtocolSource] = None,
- ) -> ProtocolRunResult:
- if protocol_source:
- self.load(protocol_source)
-
+ ) -> RunnerRunResult:
  await self._hardware_api.home()
 
  run_data = self._protocol_engine.state_view.get_summary()
  commands = self._protocol_engine.state_view.commands.get_all()
- return ProtocolRunResult(commands=commands, state_summary=run_data)
+ return RunnerRunResult(commands=commands, state_summary=run_data)
 
 
 def create_protocol_runner(

api/tests/opentrons/protocol_runner/test_protocol_runner.py

@@ -186,7 +186,7 @@ async def test_create_protocol_runner(
  json_file_reader=json_file_reader,
  json_translator=json_translator,
  ),
- type(runner_type),
+ runner_type,
  )
 
 

robot-server/robot_server/runs/engine_store.py

@@ -6,8 +6,8 @@
 from opentrons.config import feature_flags
 from opentrons.hardware_control import HardwareControlAPI
 from opentrons.protocol_runner import (
- ProtocolRunner,
- ProtocolRunResult,
+ AbstractRunner,
+ RunnerRunResult,
  create_protocol_runner,
 )
 from opentrons.protocol_engine import (
@@ -34,7 +34,7 @@ class RunnerEnginePair(NamedTuple):
  """A stored ProtocolRunner/ProtocolEngine pair."""
 
  run_id: str
- runner: ProtocolRunner
+ runner: AbstractRunner
  engine: ProtocolEngine
 
 
@@ -65,7 +65,7 @@ def engine(self) -> ProtocolEngine:
  return self._runner_engine_pair.engine
 
  @property
- def runner(self) -> ProtocolRunner:
+ def runner(self) -> AbstractRunner:
  """Get the "current" persisted ProtocolRunner."""
  assert self._runner_engine_pair is not None, "Runner not yet created."
  return self._runner_engine_pair.runner
@@ -162,7 +162,7 @@ async def create(
 
  return engine.state_view.get_summary()
 
- async def clear(self) -> ProtocolRunResult:
+ async def clear(self) -> RunnerRunResult:
  """Remove the persisted ProtocolEngine.
 
  Raises:
@@ -181,4 +181,4 @@ async def clear(self) -> ProtocolRunResult:
  commands = state_view.commands.get_all()
  self._runner_engine_pair = None
 
- return ProtocolRunResult(state_summary=run_data, commands=commands)
+ return RunnerRunResult(state_summary=run_data, commands=commands)

robot-server/tests/protocols/test_protocol_analyzer.py

@@ -107,7 +107,7 @@ async def test_analyze(
  ).then_return(json_runner)
 
  decoy.when(await json_runner.run(protocol_resource.source)).then_return(
- protocol_runner.ProtocolRunResult(
+ protocol_runner.RunnerRunResult(
  commands=[analysis_command],
  state_summary=StateSummary(
  status=EngineStatus.SUCCEEDED,

robot-server/tests/runs/test_engine_store.py

@@ -12,8 +12,8 @@
 from opentrons.hardware_control import HardwareControlAPI
 from opentrons.protocol_engine import ProtocolEngine, StateSummary, types as pe_types
 from opentrons.protocol_runner import (
- ProtocolRunResult,
- MaintenanceRunner,
+ RunnerRunResult,
+ LiveRunner,
 )
 from opentrons.protocol_reader import ProtocolReader, ProtocolSource
 
@@ -50,7 +50,7 @@ async def test_create_engine(subject: EngineStore) -> None:
 
  assert subject.current_run_id == "run-id"
  assert isinstance(result, StateSummary)
- assert isinstance(subject.runner, MaintenanceRunner)
+ assert isinstance(subject.runner, LiveRunner)
  assert isinstance(subject.engine, ProtocolEngine)
 
 
@@ -134,7 +134,7 @@ async def test_clear_engine(subject: EngineStore) -> None:
  result = await subject.clear()
 
  assert subject.current_run_id is None
- assert isinstance(result, ProtocolRunResult)
+ assert isinstance(result, RunnerRunResult)
 
  with pytest.raises(AssertionError):
  subject.engine

robot-server/tests/runs/test_run_controller.py

@@ -11,7 +11,7 @@
  commands as pe_commands,
  errors as pe_errors,
 )
-from opentrons.protocol_runner import ProtocolRunResult
+from opentrons.protocol_runner import RunnerRunResult
 
 from robot_server.service.task_runner import TaskRunner
 from robot_server.runs.action_models import RunAction, RunActionType
@@ -144,7 +144,7 @@ async def test_create_play_action_to_start(
  decoy.verify(mock_task_runner.run(background_task_captor))
 
  decoy.when(await mock_engine_store.runner.run()).then_return(
- ProtocolRunResult(
+ RunnerRunResult(
  commands=protocol_commands,
  state_summary=engine_state_summary,
  )

robot-server/tests/runs/test_run_data_manager.py

@@ -6,7 +6,7 @@
 from decoy import Decoy, matchers
 
 from opentrons.types import DeckSlotName
-from opentrons.protocol_runner import ProtocolRunResult
+from opentrons.protocol_runner import RunnerRunResult
 from opentrons.protocol_engine import (
  EngineStatus,
  StateSummary,
@@ -485,7 +485,7 @@ async def test_update_current(
  run_id = "hello world"
  decoy.when(mock_engine_store.current_run_id).then_return(run_id)
  decoy.when(await mock_engine_store.clear()).then_return(
- ProtocolRunResult(commands=[run_command], state_summary=engine_state_summary)
+ RunnerRunResult(commands=[run_command], state_summary=engine_state_summary)
  )
 
  decoy.when(
@@ -593,7 +593,7 @@ async def test_create_archives_existing(
 
  decoy.when(mock_engine_store.current_run_id).then_return(run_id_old)
  decoy.when(await mock_engine_store.clear()).then_return(
- ProtocolRunResult(commands=[run_command], state_summary=engine_state_summary)
+ RunnerRunResult(commands=[run_command], state_summary=engine_state_summary)
  )
 
  decoy.when(