httpx API Patterns

import httpx

response = httpx.get(
    "https://api.example.com/v1/devices",
    headers={"Authorization": f"Bearer {token}"},
    timeout=10.0,
)
response.raise_for_status()
devices = response.json()

response = httpx.post(
    "https://api.example.com/v1/devices",
    headers={"Authorization": f"Bearer {token}"},
    json={"name": "sw-core-01", "vlan": 10},
    timeout=10.0,
)
print(response.status_code, response.json())

# Full replacement
httpx.put(url, json=full_payload)

# Partial update
httpx.patch(url, json={"status": "active"})

# Delete
httpx.delete(url)

with httpx.Client(
    base_url="https://api.example.com",
    headers={"Authorization": f"Bearer {token}"},
    timeout=10.0,
) as client:
    devices = client.get("/v1/devices").json()
    for device in devices:
        detail = client.get(f"/v1/devices/{device['id']}").json()
        print(detail["name"], detail["status"])

import httpx

async def fetch_devices() -> list[dict]:
    async with httpx.AsyncClient(
        base_url="https://api.example.com",
        headers={"Authorization": f"Bearer {token}"},
        timeout=10.0,
    ) as client:
        response = await client.get("/v1/devices")
        response.raise_for_status()
        return response.json()

import asyncio
import httpx

async def fetch_all_details(device_ids: list[str]) -> list[dict]:
    async with httpx.AsyncClient(
        base_url="https://api.example.com",
        headers={"Authorization": f"Bearer {token}"},
    ) as client:
        tasks = [client.get(f"/v1/devices/{did}") for did in device_ids]
        responses = await asyncio.gather(*tasks)
        return [r.json() for r in responses if r.status_code == 200]

response = httpx.get(
    "https://ise-01.inside.domusdigitalis.dev:9060/ers/config/endpoint",
    auth=("admin", ise_password),
    headers={"Accept": "application/json"},
    verify=False,  # self-signed cert in lab
    timeout=15.0,
)

import httpx

class TokenAuth(httpx.Auth):
    def __init__(self, token: str):
        self.token = token

    def auth_flow(self, request):
        request.headers["Authorization"] = f"Bearer {self.token}"
        yield request

client = httpx.Client(auth=TokenAuth(token), base_url="https://api.example.com")

client = httpx.Client(
    cert=("/path/to/client.pem", "/path/to/client.key"),
    verify="/path/to/ca-chain.pem",
)

try:
    response = client.get("/v1/devices/42")
    response.raise_for_status()
except httpx.HTTPStatusError as e:
    match e.response.status_code:
        case 401:
            print("Token expired or invalid")
        case 404:
            print("Device not found")
        case 429:
            retry = int(e.response.headers.get("Retry-After", 60))
            print(f"Rate limited -- wait {retry}s")
        case _:
            print(f"HTTP {e.response.status_code}: {e.response.text}")
except httpx.ConnectError:
    print("Cannot connect to API")
except httpx.TimeoutException:
    print("Request timed out")

response = client.get("/v1/devices")
print(f"Status: {response.status_code}")
print(f"Content-Type: {response.headers['content-type']}")
print(f"Elapsed: {response.elapsed.total_seconds():.3f}s")
print(f"URL: {response.url}")
print(f"Redirected: {response.is_redirect}")

timeout = httpx.Timeout(
    connect=5.0,    # TCP handshake
    read=30.0,      # waiting for response body
    write=10.0,     # sending request body
    pool=5.0,       # waiting for connection from pool
)

client = httpx.Client(timeout=timeout)

with open("backup.tar.gz", "rb") as f:
    response = client.post(
        "/v1/upload",
        files={"file": ("backup.tar.gz", f, "application/gzip")},
        data={"description": "Config backup"},
    )

Feature              httpx                    requests
Async support        Yes (AsyncClient)        No (needs aiohttp)
HTTP/2               Yes (h2 extra)           No
Connection pool      Built-in                 Session-based
Timeout              Granular (4 types)       Single value
Type hints           Full                     Partial
API compatibility    Nearly identical          --