Merge pull request #12 from mattcoulter7/feat/httpxtimeout

feat: support httpx timeout

Author: mattcoulter7

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pydantic-openapi-generator"
-version = "2.6.0"
+version = "2.7.0"
 description = "Openapi Python Generator"
 authors = [
     { name = "Marco Müllner", email = "muellnermarco@gmail.com" },

src/pydantic_openapi_generator/language_converters/python/templates/async_client_httpx_pydantic_2.jinja2

@@ -7,18 +7,19 @@ from typing import Any, Dict, Optional, Union
 import json
 
 import httpx
-from pydantic import BaseModel, SecretStr, TypeAdapter
+from pydantic import BaseModel, Field, SecretStr, TypeAdapter
 
 from ..models import *
 
 {% set _base_url = servers[0].url if servers|length > 0 else "/" %}
 
 
 class AsyncClient(BaseModel):
-    model_config = {"validate_assignment": True}
+    model_config = {"validate_assignment": True, "arbitrary_types_allowed": True}
 
     base_url: str = "{{ _base_url }}"
     verify: Union[bool, str] = True
+    timeout: Union[float, httpx.Timeout, None] = Field(default_factory=lambda: httpx.Timeout(5.0))
 {% if env_token_name is none %}
     access_token: Optional[str] = None
 {% endif %}
@@ -100,7 +101,7 @@ AsyncGenerator[str | {% if op.sse_data_handler and op.sse_data_handler.type %}{%
         query_params = {k: v for (k, v) in query_params.items() if v is not None}
 
 {% if op.is_sse %}
-        async with httpx.AsyncClient(base_url=base_url, verify=self.verify) as client:
+        async with httpx.AsyncClient(base_url=base_url, verify=self.verify, timeout=self.timeout) as client:
             async with client.stream(
                 "{{ op.method }}",
                 httpx.URL(path),
@@ -148,7 +149,7 @@ AsyncGenerator[str | {% if op.sse_data_handler and op.sse_data_handler.type %}{%
                         # Non-data lines: yield as raw text for debugging/visibility
                         yield line
 {% else %}
-        async with httpx.AsyncClient(base_url=base_url, verify=self.verify) as client:
+        async with httpx.AsyncClient(base_url=base_url, verify=self.verify, timeout=self.timeout) as client:
             response = await client.request(
                 "{{ op.method }}",
                 httpx.URL(path),

src/pydantic_openapi_generator/language_converters/python/templates/sync_client_httpx_pydantic_2.jinja2

@@ -7,18 +7,19 @@ from typing import Any, Dict, Optional, Union
 import json
 
 import httpx
-from pydantic import BaseModel, SecretStr, TypeAdapter
+from pydantic import BaseModel, Field, SecretStr, TypeAdapter
 
 from ..models import *
 
 {% set _base_url = servers[0].url if servers|length > 0 else "/" %}
 
 
 class SyncClient(BaseModel):
-    model_config = {"validate_assignment": True}
+    model_config = {"validate_assignment": True, "arbitrary_types_allowed": True}
 
     base_url: str = "{{ _base_url }}"
     verify: Union[bool, str] = True
+    timeout: Union[float, httpx.Timeout, None] = Field(default_factory=lambda: httpx.Timeout(5.0))
 {% if env_token_name is none %}
     access_token: Optional[str] = None
 {% endif %}
@@ -100,7 +101,7 @@ Generator[str | {% if op.sse_data_handler and op.sse_data_handler.type %}{% if o
         query_params = {k: v for (k, v) in query_params.items() if v is not None}
 
 {% if op.is_sse %}
-        with httpx.Client(base_url=base_url, verify=self.verify) as client:
+        with httpx.Client(base_url=base_url, verify=self.verify, timeout=self.timeout) as client:
             with client.stream(
                 "{{ op.method }}",
                 httpx.URL(path),
@@ -147,7 +148,7 @@ Generator[str | {% if op.sse_data_handler and op.sse_data_handler.type %}{% if o
                     else:
                         yield line
 {% else %}
-        with httpx.Client(base_url=base_url, verify=self.verify) as client:
+        with httpx.Client(base_url=base_url, verify=self.verify, timeout=self.timeout) as client:
             response = client.request(
                 "{{ op.method }}",
                 httpx.URL(path),

tests/test_client_generator_contracts.py

@@ -264,13 +264,13 @@ def download_handler(request: httpx.Request) -> httpx.Response:
         client_module = importlib.import_module(
             f"{generated_contract_package}.clients.async_client"
         )
-        client = client_module.AsyncClient()
+        client = client_module.AsyncClient(timeout=1.23)
         thing, upload, download, empty = asyncio.run(_run_async_contract(client))
     else:
         client_module = importlib.import_module(
             f"{generated_contract_package}.clients.sync_client"
         )
-        client = client_module.SyncClient()
+        client = client_module.SyncClient(timeout=1.23)
         thing = client.getThing(X_Test_Header="required")
         upload = client.uploadDocument(
             data={"file": ("doc.txt", b"hello", "text/plain")}
@@ -287,6 +287,12 @@ def download_handler(request: httpx.Request) -> httpx.Response:
     assert thing_request.headers["X-Test-Header"] == "required"
     assert thing_request.headers["X-Optional-Header"] == "AU"
     assert thing_request.url.params["brand"] == "NRMA"
+    assert thing_request.extensions["timeout"] == {
+        "connect": 1.23,
+        "read": 1.23,
+        "write": 1.23,
+        "pool": 1.23,
+    }
 
     upload_request = requests[1]
     assert upload_request.headers["content-type"].startswith("multipart/form-data")
@@ -431,8 +437,11 @@ def test_generated_sse_data_payloads_use_declared_schema(
     respx_mock,
     async_client,
 ):
-    respx_mock.get("http://testserver/events").mock(
-        return_value=httpx.Response(
+    requests: list[httpx.Request] = []
+
+    def events_handler(request: httpx.Request) -> httpx.Response:
+        requests.append(request)
+        return httpx.Response(
             200,
             content=(
                 b"event: update\n"
@@ -441,27 +450,36 @@ def test_generated_sse_data_payloads_use_declared_schema(
             ),
             headers={"content-type": "text/event-stream"},
         )
+
+    respx_mock.get("http://testserver/events").mock(
+        side_effect=events_handler
     )
     models = importlib.import_module(f"{generated_contract_package}.models")
 
     if async_client:
         client_module = importlib.import_module(
             f"{generated_contract_package}.clients.async_client"
         )
-        client = client_module.AsyncClient()
+        client = client_module.AsyncClient(timeout=2.34)
         first_data_item = asyncio.run(_first_async_sse_data_item(client))
     else:
         client_module = importlib.import_module(
             f"{generated_contract_package}.clients.sync_client"
         )
-        client = client_module.SyncClient()
+        client = client_module.SyncClient(timeout=2.34)
         first_data_item = next(
             item for item in client.getEvents() if not isinstance(item, str)
         )
 
     assert isinstance(first_data_item, models.EventPayload)
     assert first_data_item.message == "ok"
     assert first_data_item.value == 42.5
+    assert requests[0].extensions["timeout"] == {
+        "connect": 2.34,
+        "read": 2.34,
+        "write": 2.34,
+        "pool": 2.34,
+    }
 
 
 async def _run_async_configured_contract(client):