๐ Streaming
Clientele supports HTTP streaming responses through the streaming_response=True parameter.
Basic stream Example
from typing import AsyncIterator
from clientele import api
from pydantic import BaseModel
client = api.APIClient(base_url="https://httpbin.org")
class Event(BaseModel):
id: int
url: str
@client.get("/stream/{n}", streaming_response=True)
async def stream_events(result: AsyncIterator[Event], n: int) -> AsyncIterator[Event]:
return result
async for event in await stream_events(n=4):
print(event)
Type-Based Hydration
The type inside AsyncIterator[T] determines how responses are parsed:
String (no parsing):
@client.get("/events", streaming_response=True)
async def stream_text(*, result: AsyncIterator[str]) -> AsyncIterator[str]:
return result
async for line in await stream_text():
print(line) # Raw string
Dictionary (JSON parsing):
@client.get("/events", streaming_response=True)
async def stream_json(*, result: AsyncIterator[dict]) -> AsyncIterator[dict]:
return result
async for data in await stream_json():
print(data["field"]) # Parsed JSON as dict
Pydantic Model (JSON + validation):