Types

websockets.typing.Data

Types supported in a WebSocket message: str for a Text frame, bytes for a Binary.

alias of str | bytes

websockets.typing.LoggerLike

Types accepted where a Logger is expected.

alias of Logger | LoggerAdapter

websockets.typing.StatusLike

Types accepted where an HTTPStatus is expected.

alias of HTTPStatus | int

websockets.typing.Origin = websockets.typing.Origin

Value of a Origin header.

websockets.typing.Subprotocol = websockets.typing.Subprotocol

Subprotocol in a Sec-WebSocket-Protocol header.

websockets.typing.ExtensionName = websockets.typing.ExtensionName

Name of a WebSocket extension.

websockets.typing.ExtensionParameter

Parameter of a WebSocket extension.

alias of tuple[str, str | None]

websockets.protocol.Event

Events that events_received() may return.

alias of Request | Response | Frame

websockets.datastructures.HeadersLike

Types accepted where Headers is expected.

In addition to Headers itself, this includes dict-like types where both keys and values are str.

alias of Headers | Mapping[str, str] | Iterable[tuple[str, str]] | SupportsKeysAndGetItem

websockets.datastructures.SupportsKeysAndGetItem = <class 'websockets.datastructures.SupportsKeysAndGetItem'>[source]

Dict-like types with keys() -> str and __getitem__(key: str) -> str methods.