Skip to content

Commit 4237321

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat(client): add support for aiohttp
1 parent b8df915 commit 4237321

22 files changed

+194
-22
lines changed

‎README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,38 @@ asyncio.run(main())
6464

6565
Functionality between the synchronous and asynchronous clients is otherwise identical.
6666

67+
### With aiohttp
68+
69+
By default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.
70+
71+
You can enable this by installing `aiohttp`:
72+
73+
```sh
74+
# install from PyPI
75+
pip install runloop_api_client[aiohttp]
76+
```
77+
78+
Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
79+
80+
```python
81+
import os
82+
import asyncio
83+
from runloop_api_client import DefaultAioHttpClient
84+
from runloop_api_client import AsyncRunloop
85+
86+
87+
async def main() -> None:
88+
async with AsyncRunloop(
89+
bearer_token=os.environ.get("RUNLOOP_API_KEY"), # This is the default and can be omitted
90+
http_client=DefaultAioHttpClient(),
91+
) as client:
92+
devbox_view = await client.devboxes.create()
93+
print(devbox_view.id)
94+
95+
96+
asyncio.run(main())
97+
```
98+
6799
## Using types
68100

69101
Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:

‎pyproject.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ classifiers = [
3737
Homepage = "https://github.com/runloopai/api-client-python"
3838
Repository = "https://github.com/runloopai/api-client-python"
3939

40+
[project.optional-dependencies]
41+
aiohttp = ["aiohttp", "httpx_aiohttp>=0.1.6"]
4042

4143
[tool.rye]
4244
managed = true

‎requirements-dev.lock

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,24 @@
1010
# universal: false
1111

1212
-e file:.
13+
aiohappyeyeballs==2.6.1
14+
# via aiohttp
15+
aiohttp==3.12.8
16+
# via httpx-aiohttp
17+
# via runloop-api-client
18+
aiosignal==1.3.2
19+
# via aiohttp
1320
annotated-types==0.6.0
1421
# via pydantic
1522
anyio==4.4.0
1623
# via httpx
1724
# via runloop-api-client
1825
argcomplete==3.1.2
1926
# via nox
27+
async-timeout==5.0.1
28+
# via aiohttp
29+
attrs==25.3.0
30+
# via aiohttp
2031
certifi==2023.7.22
2132
# via httpcore
2233
# via httpx
@@ -34,23 +45,33 @@ execnet==2.1.1
3445
# via pytest-xdist
3546
filelock==3.12.4
3647
# via virtualenv
48+
frozenlist==1.6.2
49+
# via aiohttp
50+
# via aiosignal
3751
h11==0.14.0
3852
# via httpcore
3953
httpcore==1.0.2
4054
# via httpx
4155
httpx==0.28.1
56+
# via httpx-aiohttp
4257
# via respx
4358
# via runloop-api-client
59+
httpx-aiohttp==0.1.6
60+
# via runloop-api-client
4461
idna==3.4
4562
# via anyio
4663
# via httpx
64+
# via yarl
4765
importlib-metadata==7.0.0
4866
iniconfig==2.0.0
4967
# via pytest
5068
markdown-it-py==3.0.0
5169
# via rich
5270
mdurl==0.1.2
5371
# via markdown-it-py
72+
multidict==6.4.4
73+
# via aiohttp
74+
# via yarl
5475
mypy==1.14.1
5576
mypy-extensions==1.0.0
5677
# via mypy
@@ -65,6 +86,9 @@ platformdirs==3.11.0
6586
# via virtualenv
6687
pluggy==1.5.0
6788
# via pytest
89+
propcache==0.3.1
90+
# via aiohttp
91+
# via yarl
6892
pydantic==2.10.3
6993
# via runloop-api-client
7094
pydantic-core==2.27.1
@@ -97,12 +121,15 @@ tomli==2.0.2
97121
# via pytest
98122
typing-extensions==4.12.2
99123
# via anyio
124+
# via multidict
100125
# via mypy
101126
# via pydantic
102127
# via pydantic-core
103128
# via pyright
104129
# via runloop-api-client
105130
virtualenv==20.24.5
106131
# via nox
132+
yarl==1.20.0
133+
# via aiohttp
107134
zipp==3.17.0
108135
# via importlib-metadata

‎requirements.lock

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,27 +10,51 @@
1010
# universal: false
1111

1212
-e file:.
13+
aiohappyeyeballs==2.6.1
14+
# via aiohttp
15+
aiohttp==3.12.8
16+
# via httpx-aiohttp
17+
# via runloop-api-client
18+
aiosignal==1.3.2
19+
# via aiohttp
1320
annotated-types==0.6.0
1421
# via pydantic
1522
anyio==4.4.0
1623
# via httpx
1724
# via runloop-api-client
25+
async-timeout==5.0.1
26+
# via aiohttp
27+
attrs==25.3.0
28+
# via aiohttp
1829
certifi==2023.7.22
1930
# via httpcore
2031
# via httpx
2132
distro==1.8.0
2233
# via runloop-api-client
2334
exceptiongroup==1.2.2
2435
# via anyio
36+
frozenlist==1.6.2
37+
# via aiohttp
38+
# via aiosignal
2539
h11==0.14.0
2640
# via httpcore
2741
httpcore==1.0.2
2842
# via httpx
2943
httpx==0.28.1
44+
# via httpx-aiohttp
45+
# via runloop-api-client
46+
httpx-aiohttp==0.1.6
3047
# via runloop-api-client
3148
idna==3.4
3249
# via anyio
3350
# via httpx
51+
# via yarl
52+
multidict==6.4.4
53+
# via aiohttp
54+
# via yarl
55+
propcache==0.3.1
56+
# via aiohttp
57+
# via yarl
3458
pydantic==2.10.3
3559
# via runloop-api-client
3660
pydantic-core==2.27.1
@@ -40,6 +64,9 @@ sniffio==1.3.0
4064
# via runloop-api-client
4165
typing-extensions==4.12.2
4266
# via anyio
67+
# via multidict
4368
# via pydantic
4469
# via pydantic-core
4570
# via runloop-api-client
71+
yarl==1.20.0
72+
# via aiohttp

‎src/runloop_api_client/__init__.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
UnprocessableEntityError,
2727
APIResponseValidationError,
2828
)
29-
from ._base_client import DefaultHttpxClient, DefaultAsyncHttpxClient
29+
from ._base_client import DefaultHttpxClient, DefaultAioHttpClient, DefaultAsyncHttpxClient
3030
from ._utils._logs import setup_logging as _setup_logging
3131

3232
__all__ = [
@@ -68,6 +68,7 @@
6868
"DEFAULT_CONNECTION_LIMITS",
6969
"DefaultHttpxClient",
7070
"DefaultAsyncHttpxClient",
71+
"DefaultAioHttpClient",
7172
]
7273

7374
if not _t.TYPE_CHECKING:

‎src/runloop_api_client/_base_client.py

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1289,6 +1289,24 @@ def __init__(self, **kwargs: Any) -> None:
12891289
super().__init__(**kwargs)
12901290

12911291

1292+
try:
1293+
import httpx_aiohttp
1294+
except ImportError:
1295+
1296+
class _DefaultAioHttpClient(httpx.AsyncClient):
1297+
def __init__(self, **_kwargs: Any) -> None:
1298+
raise RuntimeError("To use the aiohttp client you must have installed the package with the `aiohttp` extra")
1299+
else:
1300+
1301+
class _DefaultAioHttpClient(httpx_aiohttp.HttpxAiohttpClient): # type: ignore
1302+
def __init__(self, **kwargs: Any) -> None:
1303+
kwargs.setdefault("timeout", DEFAULT_TIMEOUT)
1304+
kwargs.setdefault("limits", DEFAULT_CONNECTION_LIMITS)
1305+
kwargs.setdefault("follow_redirects", True)
1306+
1307+
super().__init__(**kwargs)
1308+
1309+
12921310
if TYPE_CHECKING:
12931311
DefaultAsyncHttpxClient = httpx.AsyncClient
12941312
"""An alias to `httpx.AsyncClient` that provides the same defaults that this SDK
@@ -1297,8 +1315,12 @@ def __init__(self, **kwargs: Any) -> None:
12971315
This is useful because overriding the `http_client` with your own instance of
12981316
`httpx.AsyncClient` will result in httpx's defaults being used, not ours.
12991317
"""
1318+
1319+
DefaultAioHttpClient = httpx.AsyncClient
1320+
"""An alias to `httpx.AsyncClient` that changes the default HTTP transport to `aiohttp`."""
13001321
else:
13011322
DefaultAsyncHttpxClient = _DefaultAsyncHttpxClient
1323+
DefaultAioHttpClient = _DefaultAioHttpClient
13021324

13031325

13041326
class AsyncHttpxClientWrapper(DefaultAsyncHttpxClient):

‎tests/api_resources/benchmarks/test_runs.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,9 @@ def test_path_params_list_scenario_runs(self, client: Runloop) -> None:
216216

217217

218218
class TestAsyncRuns:
219-
parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
219+
parametrize = pytest.mark.parametrize(
220+
"async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
221+
)
220222

221223
@parametrize
222224
async def test_method_retrieve(self, async_client: AsyncRunloop) -> None:

‎tests/api_resources/devboxes/test_browsers.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,9 @@ def test_path_params_retrieve(self, client: Runloop) -> None:
8989

9090

9191
class TestAsyncBrowsers:
92-
parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
92+
parametrize = pytest.mark.parametrize(
93+
"async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
94+
)
9395

9496
@parametrize
9597
async def test_method_create(self, async_client: AsyncRunloop) -> None:

‎tests/api_resources/devboxes/test_computers.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,9 @@ def test_path_params_screen_interaction(self, client: Runloop) -> None:
245245

246246

247247
class TestAsyncComputers:
248-
parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
248+
parametrize = pytest.mark.parametrize(
249+
"async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
250+
)
249251

250252
@parametrize
251253
async def test_method_create(self, async_client: AsyncRunloop) -> None:

‎tests/api_resources/devboxes/test_disk_snapshots.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,9 @@ def test_path_params_query_status(self, client: Runloop) -> None:
182182

183183

184184
class TestAsyncDiskSnapshots:
185-
parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
185+
parametrize = pytest.mark.parametrize(
186+
"async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
187+
)
186188

187189
@parametrize
188190
async def test_method_update(self, async_client: AsyncRunloop) -> None:

‎tests/api_resources/devboxes/test_executions.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,9 @@ def test_path_params_kill(self, client: Runloop) -> None:
226226

227227

228228
class TestAsyncExecutions:
229-
parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
229+
parametrize = pytest.mark.parametrize(
230+
"async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
231+
)
230232

231233
@parametrize
232234
async def test_method_retrieve(self, async_client: AsyncRunloop) -> None:

‎tests/api_resources/devboxes/test_logs.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,9 @@ def test_path_params_list(self, client: Runloop) -> None:
6666

6767

6868
class TestAsyncLogs:
69-
parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
69+
parametrize = pytest.mark.parametrize(
70+
"async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
71+
)
7072

7173
@parametrize
7274
async def test_method_list(self, async_client: AsyncRunloop) -> None:

‎tests/api_resources/devboxes/test_lsp.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -822,7 +822,9 @@ def test_path_params_set_watch_directory(self, client: Runloop) -> None:
822822

823823

824824
class TestAsyncLsp:
825-
parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
825+
parametrize = pytest.mark.parametrize(
826+
"async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
827+
)
826828

827829
@parametrize
828830
async def test_method_apply_code_action(self, async_client: AsyncRunloop) -> None:

‎tests/api_resources/scenarios/test_runs.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,9 @@ def test_path_params_score(self, client: Runloop) -> None:
206206

207207

208208
class TestAsyncRuns:
209-
parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
209+
parametrize = pytest.mark.parametrize(
210+
"async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
211+
)
210212

211213
@parametrize
212214
async def test_method_retrieve(self, async_client: AsyncRunloop) -> None:

‎tests/api_resources/scenarios/test_scorers.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,9 @@ def test_path_params_validate(self, client: Runloop) -> None:
250250

251251

252252
class TestAsyncScorers:
253-
parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
253+
parametrize = pytest.mark.parametrize(
254+
"async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
255+
)
254256

255257
@parametrize
256258
async def test_method_create(self, async_client: AsyncRunloop) -> None:

‎tests/api_resources/test_benchmarks.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,9 @@ def test_streaming_response_start_run(self, client: Runloop) -> None:
307307

308308

309309
class TestAsyncBenchmarks:
310-
parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
310+
parametrize = pytest.mark.parametrize(
311+
"async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
312+
)
311313

312314
@parametrize
313315
async def test_method_create(self, async_client: AsyncRunloop) -> None:

‎tests/api_resources/test_blueprints.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,9 @@ def test_streaming_response_preview(self, client: Runloop) -> None:
304304

305305

306306
class TestAsyncBlueprints:
307-
parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
307+
parametrize = pytest.mark.parametrize(
308+
"async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
309+
)
308310

309311
@parametrize
310312
async def test_method_create(self, async_client: AsyncRunloop) -> None:

‎tests/api_resources/test_devboxes.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -967,7 +967,9 @@ def test_path_params_write_file_contents(self, client: Runloop) -> None:
967967

968968

969969
class TestAsyncDevboxes:
970-
parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
970+
parametrize = pytest.mark.parametrize(
971+
"async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
972+
)
971973

972974
@parametrize
973975
async def test_method_create(self, async_client: AsyncRunloop) -> None:

‎tests/api_resources/test_repositories.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,9 @@ def test_path_params_refresh(self, client: Runloop) -> None:
263263

264264

265265
class TestAsyncRepositories:
266-
parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
266+
parametrize = pytest.mark.parametrize(
267+
"async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
268+
)
267269

268270
@parametrize
269271
async def test_method_create(self, async_client: AsyncRunloop) -> None:

0 commit comments

Comments
 (0)