Skip to content

Commit 9529a96

Browse files
feat(client): add support for aiohttp
1 parent c17f081 commit 9529a96

35 files changed

+232
-35
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,37 @@ asyncio.run(main())
5757

5858
Functionality between the synchronous and asynchronous clients is otherwise identical.
5959

60+
### With aiohttp
61+
62+
By default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.
63+
64+
You can enable this by installing `aiohttp`:
65+
66+
```sh
67+
# install from PyPI
68+
pip install finch-api[aiohttp]
69+
```
70+
71+
Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
72+
73+
```python
74+
import asyncio
75+
from finch import DefaultAioHttpClient
76+
from finch import AsyncFinch
77+
78+
79+
async def main() -> None:
80+
async with AsyncFinch(
81+
access_token="My Access Token",
82+
http_client=DefaultAioHttpClient(),
83+
) as client:
84+
page = await client.hris.directory.list()
85+
print(page.individuals)
86+
87+
88+
asyncio.run(main())
89+
```
90+
6091
## Using types
6192

6293
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/Finch-API/finch-api-python"
3838
Repository = "https://github.com/Finch-API/finch-api-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 finch-api
17+
# via httpx-aiohttp
18+
aiosignal==1.3.2
19+
# via aiohttp
1320
annotated-types==0.6.0
1421
# via pydantic
1522
anyio==4.4.0
1623
# via finch-api
1724
# via httpx
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
4256
# via finch-api
57+
# via httpx-aiohttp
4358
# via respx
59+
httpx-aiohttp==0.1.6
60+
# via finch-api
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 finch-api
7094
pydantic-core==2.27.1
@@ -98,11 +122,14 @@ tomli==2.0.2
98122
typing-extensions==4.12.2
99123
# via anyio
100124
# via finch-api
125+
# via multidict
101126
# via mypy
102127
# via pydantic
103128
# via pydantic-core
104129
# via pyright
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 finch-api
17+
# via httpx-aiohttp
18+
aiosignal==1.3.2
19+
# via aiohttp
1320
annotated-types==0.6.0
1421
# via pydantic
1522
anyio==4.4.0
1623
# via finch-api
1724
# via httpx
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 finch-api
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
3044
# via finch-api
45+
# via httpx-aiohttp
46+
httpx-aiohttp==0.1.6
47+
# via finch-api
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 finch-api
3660
pydantic-core==2.27.1
@@ -41,5 +65,8 @@ sniffio==1.3.0
4165
typing-extensions==4.12.2
4266
# via anyio
4367
# via finch-api
68+
# via multidict
4469
# via pydantic
4570
# via pydantic-core
71+
yarl==1.20.0
72+
# via aiohttp

src/finch/__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/finch/_base_client.py

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

13061306

1307+
try:
1308+
import httpx_aiohttp
1309+
except ImportError:
1310+
1311+
class _DefaultAioHttpClient(httpx.AsyncClient):
1312+
def __init__(self, **_kwargs: Any) -> None:
1313+
raise RuntimeError("To use the aiohttp client you must have installed the package with the `aiohttp` extra")
1314+
else:
1315+
1316+
class _DefaultAioHttpClient(httpx_aiohttp.HttpxAiohttpClient): # type: ignore
1317+
def __init__(self, **kwargs: Any) -> None:
1318+
kwargs.setdefault("timeout", DEFAULT_TIMEOUT)
1319+
kwargs.setdefault("limits", DEFAULT_CONNECTION_LIMITS)
1320+
kwargs.setdefault("follow_redirects", True)
1321+
1322+
super().__init__(**kwargs)
1323+
1324+
13071325
if TYPE_CHECKING:
13081326
DefaultAsyncHttpxClient = httpx.AsyncClient
13091327
"""An alias to `httpx.AsyncClient` that provides the same defaults that this SDK
@@ -1312,8 +1330,12 @@ def __init__(self, **kwargs: Any) -> None:
13121330
This is useful because overriding the `http_client` with your own instance of
13131331
`httpx.AsyncClient` will result in httpx's defaults being used, not ours.
13141332
"""
1333+
1334+
DefaultAioHttpClient = httpx.AsyncClient
1335+
"""An alias to `httpx.AsyncClient` that changes the default HTTP transport to `aiohttp`."""
13151336
else:
13161337
DefaultAsyncHttpxClient = _DefaultAsyncHttpxClient
1338+
DefaultAioHttpClient = _DefaultAioHttpClient
13171339

13181340

13191341
class AsyncHttpxClientWrapper(DefaultAsyncHttpxClient):

tests/api_resources/connect/test_sessions.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,9 @@ def test_streaming_response_reauthenticate(self, client: Finch) -> None:
126126

127127

128128
class TestAsyncSessions:
129-
parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
129+
parametrize = pytest.mark.parametrize(
130+
"async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
131+
)
130132

131133
@pytest.mark.skip(reason="prism tests are broken")
132134
@parametrize

tests/api_resources/hris/benefits/test_individuals.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,9 @@ def test_path_params_unenroll_many(self, client: Finch) -> None:
220220

221221

222222
class TestAsyncIndividuals:
223-
parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
223+
parametrize = pytest.mark.parametrize(
224+
"async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
225+
)
224226

225227
@parametrize
226228
async def test_method_enroll_many(self, async_client: AsyncFinch) -> None:

tests/api_resources/hris/company/pay_statement_item/test_rules.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,9 @@ def test_path_params_delete(self, client: Finch) -> None:
176176

177177

178178
class TestAsyncRules:
179-
parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
179+
parametrize = pytest.mark.parametrize(
180+
"async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
181+
)
180182

181183
@parametrize
182184
async def test_method_create(self, async_client: AsyncFinch) -> None:

tests/api_resources/hris/company/test_pay_statement_item.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,9 @@ def test_streaming_response_list(self, client: Finch) -> None:
5757

5858

5959
class TestAsyncPayStatementItem:
60-
parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
60+
parametrize = pytest.mark.parametrize(
61+
"async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
62+
)
6163

6264
@parametrize
6365
async def test_method_list(self, async_client: AsyncFinch) -> None:

0 commit comments

Comments
 (0)