feat(client): add support for aiohttp

Author: stainless-app[bot]

README.md

@@ -145,6 +145,45 @@ asyncio.run(main())
 
 Functionality between the synchronous and asynchronous clients is otherwise identical.
 
+### With aiohttp
+
+By default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.
+
+You can enable this by installing `aiohttp`:
+
+```sh
+# install from PyPI
+pip install openai[aiohttp]
+```
+
+Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
+
+```python
+import os
+import asyncio
+from openai import DefaultAioHttpClient
+from openai import AsyncOpenAI
+
+
+async def main() -> None:
+    async with AsyncOpenAI(
+        api_key=os.environ.get("OPENAI_API_KEY"),  # This is the default and can be omitted
+        http_client=DefaultAioHttpClient(),
+    ) as client:
+        chat_completion = await client.chat.completions.create(
+            messages=[
+                {
+                    "role": "user",
+                    "content": "Say this is a test",
+                }
+            ],
+            model="gpt-4o",
+        )
+
+
+asyncio.run(main())
+```
+
 ## Streaming responses
 
 We provide support for streaming responses using Server Side Events (SSE).

pyproject.toml

@@ -43,6 +43,7 @@ Repository = "https://github.com/openai/openai-python"
 openai = "openai.cli:main"
 
 [project.optional-dependencies]
+aiohttp = ["aiohttp", "httpx_aiohttp>=0.1.6"]
 realtime = ["websockets >= 13, < 16"]
 datalib = ["numpy >= 1", "pandas >= 1.2.3", "pandas-stubs >= 1.1.0.11"]
 voice_helpers = ["sounddevice>=0.5.1", "numpy>=2.0.2"]

requirements-dev.lock

@@ -10,6 +10,13 @@
 #   universal: false
 
 -e file:.
+aiohappyeyeballs==2.6.1
+    # via aiohttp
+aiohttp==3.12.13
+    # via httpx-aiohttp
+    # via openai
+aiosignal==1.3.2
+    # via aiohttp
 annotated-types==0.6.0
     # via pydantic
 anyio==4.1.0
@@ -19,7 +26,10 @@ argcomplete==3.1.2
     # via nox
 asttokens==2.4.1
     # via inline-snapshot
+async-timeout==5.0.1
+    # via aiohttp
 attrs==24.2.0
+    # via aiohttp
     # via outcome
     # via trio
 azure-core==1.31.0
@@ -60,18 +70,25 @@ executing==2.1.0
     # via inline-snapshot
 filelock==3.12.4
     # via virtualenv
+frozenlist==1.7.0
+    # via aiohttp
+    # via aiosignal
 h11==0.14.0
     # via httpcore
 httpcore==1.0.2
     # via httpx
 httpx==0.28.1
+    # via httpx-aiohttp
     # via openai
     # via respx
+httpx-aiohttp==0.1.6
+    # via openai
 idna==3.4
     # via anyio
     # via httpx
     # via requests
     # via trio
+    # via yarl
 importlib-metadata==7.0.0
 iniconfig==2.0.0
     # via pytest
@@ -87,6 +104,9 @@ msal==1.31.0
     # via msal-extensions
 msal-extensions==1.2.0
     # via azure-identity
+multidict==6.5.0
+    # via aiohttp
+    # via yarl
 mypy==1.14.1
 mypy-extensions==1.0.0
     # via black
@@ -118,6 +138,9 @@ pluggy==1.5.0
     # via pytest
 portalocker==2.10.1
     # via msal-extensions
+propcache==0.3.2
+    # via aiohttp
+    # via yarl
 pycparser==2.22
     # via cffi
 pydantic==2.10.3
@@ -181,6 +204,7 @@ typing-extensions==4.12.2
     # via azure-core
     # via azure-identity
     # via black
+    # via multidict
     # via mypy
     # via openai
     # via pydantic
@@ -194,5 +218,7 @@ virtualenv==20.24.5
     # via nox
 websockets==15.0.1
     # via openai
+yarl==1.20.1
+    # via aiohttp
 zipp==3.17.0
     # via importlib-metadata

requirements.lock

@@ -10,11 +10,22 @@
 #   universal: false
 
 -e file:.
+aiohappyeyeballs==2.6.1
+    # via aiohttp
+aiohttp==3.12.13
+    # via httpx-aiohttp
+    # via openai
+aiosignal==1.3.2
+    # via aiohttp
 annotated-types==0.6.0
     # via pydantic
 anyio==4.1.0
     # via httpx
     # via openai
+async-timeout==5.0.1
+    # via aiohttp
+attrs==25.3.0
+    # via aiohttp
 certifi==2023.7.22
     # via httpcore
     # via httpx
@@ -24,17 +35,27 @@ distro==1.8.0
     # via openai
 exceptiongroup==1.2.2
     # via anyio
+frozenlist==1.7.0
+    # via aiohttp
+    # via aiosignal
 h11==0.14.0
     # via httpcore
 httpcore==1.0.2
     # via httpx
 httpx==0.28.1
+    # via httpx-aiohttp
+    # via openai
+httpx-aiohttp==0.1.6
     # via openai
 idna==3.4
     # via anyio
     # via httpx
+    # via yarl
 jiter==0.6.1
     # via openai
+multidict==6.5.0
+    # via aiohttp
+    # via yarl
 numpy==2.0.2
     # via openai
     # via pandas
@@ -43,6 +64,9 @@ pandas==2.2.3
     # via openai
 pandas-stubs==2.2.2.240807
     # via openai
+propcache==0.3.2
+    # via aiohttp
+    # via yarl
 pycparser==2.22
     # via cffi
 pydantic==2.10.3
@@ -65,10 +89,13 @@ tqdm==4.66.5
 types-pytz==2024.2.0.20241003
     # via pandas-stubs
 typing-extensions==4.12.2
+    # via multidict
     # via openai
     # via pydantic
     # via pydantic-core
 tzdata==2024.1
     # via pandas
 websockets==15.0.1
     # via openai
+yarl==1.20.1
+    # via aiohttp

src/openai/__init__.py

@@ -32,7 +32,7 @@
     APIResponseValidationError,
     ContentFilterFinishReasonError,
 )
-from ._base_client import DefaultHttpxClient, DefaultAsyncHttpxClient
+from ._base_client import DefaultHttpxClient, DefaultAioHttpClient, DefaultAsyncHttpxClient
 from ._utils._logs import setup_logging as _setup_logging
 from ._legacy_response import HttpxBinaryResponseContent as HttpxBinaryResponseContent
 
@@ -77,6 +77,7 @@
     "DEFAULT_CONNECTION_LIMITS",
     "DefaultHttpxClient",
     "DefaultAsyncHttpxClient",
+    "DefaultAioHttpClient",
 ]
 
 if not _t.TYPE_CHECKING:

src/openai/_base_client.py

@@ -1306,6 +1306,24 @@ def __init__(self, **kwargs: Any) -> None:
         super().__init__(**kwargs)
 
 
+try:
+    import httpx_aiohttp
+except ImportError:
+
+    class _DefaultAioHttpClient(httpx.AsyncClient):
+        def __init__(self, **_kwargs: Any) -> None:
+            raise RuntimeError("To use the aiohttp client you must have installed the package with the `aiohttp` extra")
+else:
+
+    class _DefaultAioHttpClient(httpx_aiohttp.HttpxAiohttpClient):  # type: ignore
+        def __init__(self, **kwargs: Any) -> None:
+            kwargs.setdefault("timeout", DEFAULT_TIMEOUT)
+            kwargs.setdefault("limits", DEFAULT_CONNECTION_LIMITS)
+            kwargs.setdefault("follow_redirects", True)
+
+            super().__init__(**kwargs)
+
+
 if TYPE_CHECKING:
     DefaultAsyncHttpxClient = httpx.AsyncClient
     """An alias to `httpx.AsyncClient` that provides the same defaults that this SDK
@@ -1314,8 +1332,12 @@ def __init__(self, **kwargs: Any) -> None:
     This is useful because overriding the `http_client` with your own instance of
     `httpx.AsyncClient` will result in httpx's defaults being used, not ours.
     """
+
+    DefaultAioHttpClient = httpx.AsyncClient
+    """An alias to `httpx.AsyncClient` that changes the default HTTP transport to `aiohttp`."""
 else:
     DefaultAsyncHttpxClient = _DefaultAsyncHttpxClient
+    DefaultAioHttpClient = _DefaultAioHttpClient
 
 
 class AsyncHttpxClientWrapper(DefaultAsyncHttpxClient):

tests/api_resources/audio/test_speech.py

@@ -83,7 +83,9 @@ def test_streaming_response_create(self, client: OpenAI, respx_mock: MockRouter)
 
 
 class TestAsyncSpeech:
-    parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
+    parametrize = pytest.mark.parametrize(
+        "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
+    )
 
     @parametrize
     @pytest.mark.respx(base_url=base_url)

tests/api_resources/audio/test_transcriptions.py

@@ -121,7 +121,9 @@ def test_streaming_response_create_overload_2(self, client: OpenAI) -> None:
 
 
 class TestAsyncTranscriptions:
-    parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
+    parametrize = pytest.mark.parametrize(
+        "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
+    )
 
     @parametrize
     async def test_method_create_overload_1(self, async_client: AsyncOpenAI) -> None:

tests/api_resources/audio/test_translations.py

@@ -64,7 +64,9 @@ def test_streaming_response_create(self, client: OpenAI) -> None:
 
 
 class TestAsyncTranslations:
-    parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
+    parametrize = pytest.mark.parametrize(
+        "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
+    )
 
     @parametrize
     async def test_method_create(self, async_client: AsyncOpenAI) -> None:

tests/api_resources/beta/realtime/test_sessions.py

@@ -90,7 +90,9 @@ def test_streaming_response_create(self, client: OpenAI) -> None:
 
 
 class TestAsyncSessions:
-    parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
+    parametrize = pytest.mark.parametrize(
+        "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
+    )
 
     @parametrize
     async def test_method_create(self, async_client: AsyncOpenAI) -> None: