CodeVetter · Repo Unpack · Feature catalog
encode/starlette
The public surface centers on developer APIs for composing web services. Routing supports function endpoints, endpoint classes, mounted applications, typed parameters, method restrictions, and reverse URLs. Requests, responses, WebSockets, rendering, authentication, and middleware provide the main service capabilities. Lifecycle handlers, background callbacks, configuration, and an in-process client complete the inspected toolkit.
- Route supports typed path matching, names, method sets, automatic HEAD inclusion for GET, per-route middleware, and body limits; HTTPEndpoint dispatches method handlers including QUERY and falls back from HEAD to get.
- Request exposes URLs, headers, repeated query parameters, cookies, client addresses, streamed or buffered bodies, JSON, and forms; Config resolves prefixed environment values before file values and defaults, with optional casts.
- Response variants supply HTML, text, compact JSON, redirects, streaming, and files; cookie APIs support expiry, Secure, HttpOnly, SameSite, and partitioning, with Response.set_cookie partitioning restricted to Python >=3.14.
- WebSocket supports acceptance with subprotocols and headers, text/bytes/JSON send and receive, asynchronous iterators, close reasons, and HTTP denial responses when the server advertises websocket.http.response.
- StaticFiles serves configured directories or package assets with HTML index/404 handling and conditional responses; Jinja2Templates adds rendering and context processors, while SchemaGenerator builds OpenAPI paths from YAML docstrings and gates QUERY on OpenAPI >=3.2.
- AuthenticationMiddleware delegates identity to an AuthenticationBackend and exposes auth/user through scope; requires enforces scopes with HTTP errors or named-route redirects, while SessionMiddleware provides signed cookie sessions.
- Middleware includes CORS preflight/private-network policy, GZip negotiation and media exclusions, trusted-host validation, HTTPS/WSS redirection, total request-body limits, and experimental OpenTelemetry HTTP spans.
- Lifespan context managers manage startup/shutdown resources; BackgroundTask and BackgroundTasks attach post-response callbacks, and TestClient offers synchronous HTTP calls, WebSocket sessions, asyncio/trio backends, and lifecycle management.