WebSocket scope and messages¶

Use these mappings for a WebSocket scope and the events exchanged during its connection, data transfer, close, or HTTP response phase.

WebSocketScope¶

Bases: TypedDict

A WebSocket scope in Scope.

type`instance-attribute`¶

type: Literal['websocket']

asgi`instance-attribute`¶

asgi: HTTPASGIVersions

http_version`instance-attribute`¶

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

scheme`instance-attribute`¶

scheme: str

path`instance-attribute`¶

path: str

raw_path`instance-attribute`¶

raw_path: bytes

query_string`instance-attribute`¶

query_string: bytes

root_path`instance-attribute`¶

root_path: NotRequired[str]

headers`instance-attribute`¶

headers: ScopeHeaders

client`instance-attribute`¶

client: NotRequired[tuple[str, int]]

server`instance-attribute`¶

server: tuple[str, int | None]

subprotocols`instance-attribute`¶

subprotocols: list[str]

state`instance-attribute`¶

state: NotRequired[State]

extensions`instance-attribute`¶

extensions: WebSocketExtensions

WebSocketConnect¶

Bases: TypedDict

A WebSocket connect event in ReceiveMessage.

type`instance-attribute`¶

type: Literal['websocket.connect']

WebSocketReceiveBytes¶

Bases: TypedDict

A binary WebSocket event in ReceiveMessage.

type`instance-attribute`¶

type: Literal['websocket.receive']

bytes`instance-attribute`¶

bytes: bytes

text`instance-attribute`¶

text: NotRequired[None]

WebSocketReceiveText¶

Bases: TypedDict

A text WebSocket event in ReceiveMessage.

type`instance-attribute`¶

type: Literal['websocket.receive']

text`instance-attribute`¶

text: str

bytes`instance-attribute`¶

bytes: NotRequired[None]

WebSocketDisconnect¶

Bases: TypedDict

A WebSocket disconnect event in ReceiveMessage.

type`instance-attribute`¶

type: Literal['websocket.disconnect']

code`instance-attribute`¶

code: int

reason`instance-attribute`¶

reason: NotRequired[str]

WebSocketAccept¶

Bases: TypedDict

A WebSocket accept event in SendMessage.

type`instance-attribute`¶

type: Literal['websocket.accept']

subprotocol`instance-attribute`¶

subprotocol: NotRequired[str | None]

headers`instance-attribute`¶

headers: NotRequired[Headers]

WebSocketSendBytes¶

Bases: TypedDict

A binary WebSocket event in SendMessage.

type`instance-attribute`¶

type: Literal['websocket.send']

bytes`instance-attribute`¶

bytes: bytes

text`instance-attribute`¶

text: NotRequired[None]

WebSocketSendText¶

Bases: TypedDict

A text WebSocket event in SendMessage.

type`instance-attribute`¶

type: Literal['websocket.send']

text`instance-attribute`¶

text: str

bytes`instance-attribute`¶

bytes: NotRequired[None]

WebSocketClose¶

Bases: TypedDict

A WebSocket close event in SendMessage.

type`instance-attribute`¶

type: Literal['websocket.close']

code`instance-attribute`¶

code: NotRequired[int]

reason`instance-attribute`¶

reason: NotRequired[str | None]

WebSocketHTTPResponseStart¶

Bases: TypedDict

A WebSocket HTTP response-start event in SendMessage.

type`instance-attribute`¶

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

status`instance-attribute`¶

status: int

headers`instance-attribute`¶

headers: NotRequired[Headers]

WebSocketHTTPResponseBody¶

Bases: TypedDict

A WebSocket HTTP response-body event in SendMessage.

type`instance-attribute`¶

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

body`instance-attribute`¶

body: NotRequired[bytes]

more_body`instance-attribute`¶

more_body: NotRequired[bool]

WebSocket scope and messages¶

WebSocketScope¶

typeinstance-attribute¶

asgiinstance-attribute¶

http_versioninstance-attribute¶

schemeinstance-attribute¶

pathinstance-attribute¶

raw_pathinstance-attribute¶

query_stringinstance-attribute¶

root_pathinstance-attribute¶

headersinstance-attribute¶

clientinstance-attribute¶

serverinstance-attribute¶

subprotocolsinstance-attribute¶

stateinstance-attribute¶

extensionsinstance-attribute¶

WebSocketConnect¶

typeinstance-attribute¶

WebSocketReceiveBytes¶

typeinstance-attribute¶

bytesinstance-attribute¶

textinstance-attribute¶

WebSocketReceiveText¶

typeinstance-attribute¶

textinstance-attribute¶

bytesinstance-attribute¶

WebSocketDisconnect¶

typeinstance-attribute¶

codeinstance-attribute¶

reasoninstance-attribute¶

WebSocketAccept¶

typeinstance-attribute¶

subprotocolinstance-attribute¶

headersinstance-attribute¶

WebSocketSendBytes¶

typeinstance-attribute¶

bytesinstance-attribute¶

textinstance-attribute¶

WebSocketSendText¶

typeinstance-attribute¶

textinstance-attribute¶

bytesinstance-attribute¶

WebSocketClose¶

typeinstance-attribute¶

codeinstance-attribute¶

reasoninstance-attribute¶

WebSocketHTTPResponseStart¶

typeinstance-attribute¶

statusinstance-attribute¶

headersinstance-attribute¶

WebSocketHTTPResponseBody¶

typeinstance-attribute¶

bodyinstance-attribute¶

more_bodyinstance-attribute¶

type`instance-attribute`¶

asgi`instance-attribute`¶

http_version`instance-attribute`¶

scheme`instance-attribute`¶

path`instance-attribute`¶

raw_path`instance-attribute`¶

query_string`instance-attribute`¶

root_path`instance-attribute`¶

headers`instance-attribute`¶

client`instance-attribute`¶

server`instance-attribute`¶

subprotocols`instance-attribute`¶

state`instance-attribute`¶

extensions`instance-attribute`¶

type`instance-attribute`¶

type`instance-attribute`¶

bytes`instance-attribute`¶

text`instance-attribute`¶

type`instance-attribute`¶

text`instance-attribute`¶

bytes`instance-attribute`¶

type`instance-attribute`¶

code`instance-attribute`¶

reason`instance-attribute`¶

type`instance-attribute`¶

subprotocol`instance-attribute`¶

headers`instance-attribute`¶

type`instance-attribute`¶

bytes`instance-attribute`¶

text`instance-attribute`¶

type`instance-attribute`¶

text`instance-attribute`¶

bytes`instance-attribute`¶

type`instance-attribute`¶

code`instance-attribute`¶

reason`instance-attribute`¶

type`instance-attribute`¶

status`instance-attribute`¶

headers`instance-attribute`¶

type`instance-attribute`¶

body`instance-attribute`¶

more_body`instance-attribute`¶