HTTP scope and messages¶

Bases: TypedDict

An HTTP request scope in Scope.

type: Literal['http']

asgi: HTTPASGIVersions

http_version: Literal['1.1', '2']

method: str

scheme: str

path: str

raw_path: bytes

query_string: bytes

root_path: NotRequired[str]

headers: ScopeHeaders

client: NotRequired[tuple[str, int]]

server: tuple[str, int | None]

state: NotRequired[State]

extensions: HTTPExtensions

Bases: TypedDict

An HTTP request event in ReceiveMessage.

type: Literal['http.request']

body: NotRequired[bytes]

more_body: NotRequired[bool]

Bases: TypedDict

An HTTP disconnect event in ReceiveMessage.

type: Literal['http.disconnect']

Bases: TypedDict

An HTTP response-start event in SendMessage.

type: Literal['http.response.start']

status: int

headers: NotRequired[Headers]

trailers: NotRequired[bool]

Bases: TypedDict

An HTTP response-body event in SendMessage.

type: Literal['http.response.body']

body: NotRequired[bytes]

more_body: NotRequired[bool]

Bases: TypedDict

An HTTP response-trailers event in SendMessage.

type: Literal['http.response.trailers']

headers: Headers

more_trailers: NotRequired[bool]

Bases: TypedDict

An HTTP path-send event in SendMessage.

type: Literal['http.response.pathsend']

path: str

Bases: TypedDict

A response body segment in SendMessage, read straight from an open file.

Sent after http.response.start, as many times as wanted, and freely interleaved with http.response.body. offset defaults to the descriptor's current position and count to the rest of the file.

The descriptor stays yours: this server duplicates it and closes only the duplicate, so closing it as soon as send() returns is safe -- and, per the ASGI specification, your responsibility.

type: Literal['http.response.zerocopysend']

file: SupportsFileno

offset: NotRequired[int]

count: NotRequired[int]

more_body: NotRequired[bool]

Bases: TypedDict

An RFC 8297 103 Early Hints interim response in SendMessage.

Sent after http.response.start and before the final body, as many times as wanted. Each value becomes one link field; ordering and duplicates are preserved. Offered only on HTTP/2 -- check scope["extensions"].

type: Literal['http.response.early_hint']

links: Iterable[bytes]