Skip to content

Commit 23e625b

Browse files
committed
changed scenario run methods to run and run_async, updated parameter TypedDicts appropriately
1 parent dc8a68e commit 23e625b

7 files changed

Lines changed: 21 additions & 17 deletions

File tree

src/runloop_api_client/sdk/_types.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,5 +175,9 @@ class SDKScenarioListParams(ScenarioListParams, BaseRequestOptions):
175175
pass
176176

177177

178-
class SDKScenarioRunParams(ScenarioStartRunBaseParams, LongRequestOptions):
178+
class SDKScenarioRunAsyncParams(ScenarioStartRunBaseParams, LongRequestOptions):
179179
pass
180+
181+
182+
class SDKScenarioRunParams(ScenarioStartRunBaseParams, LongPollingRequestOptions):
183+
pass

src/runloop_api_client/sdk/async_scenario.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
from typing_extensions import Unpack, override
77

88
from ..types import ScenarioView
9-
from ._types import BaseRequestOptions, LongRequestOptions, SDKScenarioRunParams
9+
from ._types import BaseRequestOptions, LongRequestOptions, SDKScenarioRunAsyncParams, SDKScenarioRunParams
1010
from .._client import AsyncRunloop
1111
from .async_scenario_run import AsyncScenarioRun
1212

@@ -89,9 +89,9 @@ async def update(
8989
**options,
9090
)
9191

92-
async def run(
92+
async def run_async(
9393
self,
94-
**params: Unpack[SDKScenarioRunParams],
94+
**params: Unpack[SDKScenarioRunAsyncParams],
9595
) -> AsyncScenarioRun:
9696
"""Start a new scenario run.
9797
@@ -109,7 +109,7 @@ async def run(
109109
)
110110
return AsyncScenarioRun(self._client, run_view.id, run_view.devbox_id)
111111

112-
async def run_and_await_env_ready(
112+
async def run(
113113
self,
114114
**params: Unpack[SDKScenarioRunParams],
115115
) -> AsyncScenarioRun:

src/runloop_api_client/sdk/scenario.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
from typing_extensions import Unpack, override
77

88
from ..types import ScenarioView
9-
from ._types import BaseRequestOptions, LongRequestOptions, SDKScenarioRunParams
9+
from ._types import BaseRequestOptions, LongRequestOptions, SDKScenarioRunAsyncParams, SDKScenarioRunParams
1010
from .._client import Runloop
1111
from .scenario_run import ScenarioRun
1212

@@ -89,9 +89,9 @@ def update(
8989
**options,
9090
)
9191

92-
def run(
92+
def run_async(
9393
self,
94-
**params: Unpack[SDKScenarioRunParams],
94+
**params: Unpack[SDKScenarioRunAsyncParams],
9595
) -> ScenarioRun:
9696
"""Start a new scenario run.
9797
@@ -109,7 +109,7 @@ def run(
109109
)
110110
return ScenarioRun(self._client, run_view.id, run_view.devbox_id)
111111

112-
def run_and_await_env_ready(
112+
def run(
113113
self,
114114
**params: Unpack[SDKScenarioRunParams],
115115
) -> ScenarioRun:

tests/sdk/test_async_scenario.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ async def test_run(self, mock_async_client: AsyncMock, scenario_run_view: MockSc
5050
mock_async_client.scenarios.start_run = AsyncMock(return_value=scenario_run_view)
5151

5252
scenario = AsyncScenario(mock_async_client, "scn_123")
53-
run = await scenario.run(run_name="test-run")
53+
run = await scenario.run_async(run_name="test-run")
5454

5555
assert run.id == "run_123"
5656
assert run.devbox_id == "dev_123"
@@ -66,7 +66,7 @@ async def test_run_and_await_env_ready(
6666
mock_async_client.scenarios.start_run_and_await_env_ready = AsyncMock(return_value=scenario_run_view)
6767

6868
scenario = AsyncScenario(mock_async_client, "scn_123")
69-
run = await scenario.run_and_await_env_ready(run_name="test-run")
69+
run = await scenario.run(run_name="test-run")
7070

7171
assert run.id == "run_123"
7272
assert run.devbox_id == "dev_123"

tests/sdk/test_scenario.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ def test_run(self, mock_client: Mock, scenario_run_view: MockScenarioRunView) ->
5050
mock_client.scenarios.start_run.return_value = scenario_run_view
5151

5252
scenario = Scenario(mock_client, "scn_123")
53-
run = scenario.run(run_name="test-run")
53+
run = scenario.run_async(run_name="test-run")
5454

5555
assert run.id == "run_123"
5656
assert run.devbox_id == "dev_123"
@@ -64,7 +64,7 @@ def test_run_and_await_env_ready(self, mock_client: Mock, scenario_run_view: Moc
6464
mock_client.scenarios.start_run_and_await_env_ready.return_value = scenario_run_view
6565

6666
scenario = Scenario(mock_client, "scn_123")
67-
run = scenario.run_and_await_env_ready(run_name="test-run")
67+
run = scenario.run(run_name="test-run")
6868

6969
assert run.id == "run_123"
7070
assert run.devbox_id == "dev_123"

tests/smoketests/sdk/test_async_scenario.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ async def test_scenario_run_lifecycle(self, async_sdk_client: AsyncRunloopSDK) -
8585
scenario = scenarios[0]
8686

8787
# Start a run
88-
run = await scenario.run(run_name="sdk-smoketest-async-run")
88+
run = await scenario.run_async(run_name="sdk-smoketest-async-run")
8989

9090
try:
9191
assert run.id is not None
@@ -121,7 +121,7 @@ async def test_scenario_run_and_await_env_ready(self, async_sdk_client: AsyncRun
121121
scenario = scenarios[0]
122122

123123
# Start a run and wait for environment in one call
124-
run = await scenario.run_and_await_env_ready(run_name="sdk-smoketest-async-await")
124+
run = await scenario.run(run_name="sdk-smoketest-async-await")
125125

126126
try:
127127
assert run.id is not None

tests/smoketests/sdk/test_scenario.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ def test_scenario_run_lifecycle(self, sdk_client: RunloopSDK) -> None:
8585
scenario = scenarios[0]
8686

8787
# Start a run
88-
run = scenario.run(run_name="sdk-smoketest-run")
88+
run = scenario.run_async(run_name="sdk-smoketest-run")
8989

9090
try:
9191
assert run.id is not None
@@ -121,7 +121,7 @@ def test_scenario_run_and_await_env_ready(self, sdk_client: RunloopSDK) -> None:
121121
scenario = scenarios[0]
122122

123123
# Start a run and wait for environment in one call
124-
run = scenario.run_and_await_env_ready(run_name="sdk-smoketest-await")
124+
run = scenario.run(run_name="sdk-smoketest-await")
125125

126126
try:
127127
assert run.id is not None

0 commit comments

Comments
 (0)