"""Includes code adapted from https://github.com/django/asgiref/blob/main/asgiref/typing.py.
Copyright (c) Django Software Foundation and individual contributors.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of Django nor the names of its contributors may be used
to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""
from __future__ import annotations
from collections.abc import Awaitable, Iterable
from typing import (
TYPE_CHECKING,
Any,
Callable,
Literal,
TypedDict,
Union,
)
from litestar.enums import HttpMethod
__all__ = (
"ASGIApp",
"ASGIVersion",
"BaseScope",
"HTTPDisconnectEvent",
"HTTPReceiveMessage",
"HTTPRequestEvent",
"HTTPResponseBodyEvent",
"HTTPResponseStartEvent",
"HTTPScope",
"HTTPSendMessage",
"HTTPServerPushEvent",
"HeaderScope",
"LifeSpanReceive",
"LifeSpanReceiveMessage",
"LifeSpanScope",
"LifeSpanSend",
"LifeSpanSendMessage",
"LifeSpanShutdownCompleteEvent",
"LifeSpanShutdownEvent",
"LifeSpanShutdownFailedEvent",
"LifeSpanStartupCompleteEvent",
"LifeSpanStartupEvent",
"LifeSpanStartupFailedEvent",
"Message",
"Method",
"RawHeaders",
"RawHeadersList",
"Receive",
"ReceiveMessage",
"Scope",
"ScopeSession",
"Send",
"WebSocketAcceptEvent",
"WebSocketCloseEvent",
"WebSocketConnectEvent",
"WebSocketDisconnectEvent",
"WebSocketMode",
"WebSocketReceiveEvent",
"WebSocketReceiveMessage",
"WebSocketResponseBodyEvent",
"WebSocketResponseStartEvent",
"WebSocketScope",
"WebSocketSendEvent",
"WebSocketSendMessage",
)
if TYPE_CHECKING:
from typing_extensions import TypeAlias
from litestar.app import Litestar
from litestar.enums import ScopeType
from litestar.types.empty import EmptyType
from .internal_types import RouteHandlerType
from .serialization import DataContainerType
HttpMethodName: TypeAlias = Literal["GET", "POST", "DELETE", "PATCH", "PUT", "HEAD", "TRACE", "OPTIONS"]
Method: TypeAlias = Union[HttpMethodName, HttpMethod]
ScopeSession: TypeAlias = "EmptyType | dict[str, Any] | DataContainerType | None"
[docs]
class ASGIVersion(TypedDict):
"""ASGI spec version."""
spec_version: str
version: Literal["3.0"]
class HeaderScope(TypedDict):
"""Base class for ASGI-scopes that supports headers."""
headers: RawHeaders
[docs]
class BaseScope(HeaderScope):
"""Base ASGI-scope."""
app: Litestar # deprecated
litestar_app: Litestar
asgi: ASGIVersion
auth: Any
client: tuple[str, int] | None
extensions: dict[str, dict[object, object]] | None
http_version: str
path: str
path_params: dict[str, str]
path_template: str
query_string: bytes
raw_path: bytes
root_path: str
route_handler: RouteHandlerType
scheme: str
server: tuple[str, int | None] | None
session: ScopeSession
state: dict[str, Any]
user: Any
[docs]
class HTTPScope(BaseScope):
"""HTTP-ASGI-scope."""
method: HttpMethodName
type: Literal[ScopeType.HTTP]
[docs]
class WebSocketScope(BaseScope):
"""WebSocket-ASGI-scope."""
subprotocols: list[str]
type: Literal[ScopeType.WEBSOCKET]
[docs]
class LifeSpanScope(TypedDict):
"""Lifespan-ASGI-scope."""
app: Litestar
asgi: ASGIVersion
type: Literal["lifespan"]
[docs]
class HTTPRequestEvent(TypedDict):
"""ASGI `http.request` event."""
type: Literal["http.request"]
body: bytes
more_body: bool
[docs]
class HTTPResponseStartEvent(HeaderScope):
"""ASGI `http.response.start` event."""
type: Literal["http.response.start"]
status: int
[docs]
class HTTPResponseBodyEvent(TypedDict):
"""ASGI `http.response.body` event."""
type: Literal["http.response.body"]
body: bytes
more_body: bool
[docs]
class HTTPServerPushEvent(HeaderScope):
"""ASGI `http.response.push` event."""
type: Literal["http.response.push"]
path: str
[docs]
class HTTPDisconnectEvent(TypedDict):
"""ASGI `http.disconnect` event."""
type: Literal["http.disconnect"]
[docs]
class WebSocketConnectEvent(TypedDict):
"""ASGI `websocket.connect` event."""
type: Literal["websocket.connect"]
[docs]
class WebSocketAcceptEvent(HeaderScope):
"""ASGI `websocket.accept` event."""
type: Literal["websocket.accept"]
subprotocol: str | None
[docs]
class WebSocketReceiveEvent(TypedDict):
"""ASGI `websocket.receive` event."""
type: Literal["websocket.receive"]
bytes: bytes | None
text: str | None
[docs]
class WebSocketSendEvent(TypedDict):
"""ASGI `websocket.send` event."""
type: Literal["websocket.send"]
bytes: bytes | None
text: str | None
[docs]
class WebSocketResponseStartEvent(HeaderScope):
"""ASGI `websocket.http.response.start` event."""
type: Literal["websocket.http.response.start"]
status: int
[docs]
class WebSocketResponseBodyEvent(TypedDict):
"""ASGI `websocket.http.response.body` event."""
type: Literal["websocket.http.response.body"]
body: bytes
more_body: bool
[docs]
class WebSocketDisconnectEvent(TypedDict):
"""ASGI `websocket.disconnect` event."""
type: Literal["websocket.disconnect"]
code: int
reason: str | None
[docs]
class WebSocketCloseEvent(TypedDict):
"""ASGI `websocket.close` event."""
type: Literal["websocket.close"]
code: int
reason: str | None
[docs]
class LifeSpanStartupEvent(TypedDict):
"""ASGI `lifespan.startup` event."""
type: Literal["lifespan.startup"]
[docs]
class LifeSpanShutdownEvent(TypedDict):
"""ASGI `lifespan.shutdown` event."""
type: Literal["lifespan.shutdown"]
[docs]
class LifeSpanStartupCompleteEvent(TypedDict):
"""ASGI `lifespan.startup.complete` event."""
type: Literal["lifespan.startup.complete"]
[docs]
class LifeSpanStartupFailedEvent(TypedDict):
"""ASGI `lifespan.startup.failed` event."""
type: Literal["lifespan.startup.failed"]
message: str
[docs]
class LifeSpanShutdownCompleteEvent(TypedDict):
"""ASGI `lifespan.shutdown.complete` event."""
type: Literal["lifespan.shutdown.complete"]
[docs]
class LifeSpanShutdownFailedEvent(TypedDict):
"""ASGI `lifespan.shutdown.failed` event."""
type: Literal["lifespan.shutdown.failed"]
message: str
HTTPReceiveMessage: TypeAlias = Union[
HTTPRequestEvent,
HTTPDisconnectEvent,
]
WebSocketReceiveMessage: TypeAlias = Union[
WebSocketConnectEvent,
WebSocketReceiveEvent,
WebSocketDisconnectEvent,
]
LifeSpanReceiveMessage: TypeAlias = Union[
LifeSpanStartupEvent,
LifeSpanShutdownEvent,
]
HTTPSendMessage: TypeAlias = Union[
HTTPResponseStartEvent,
HTTPResponseBodyEvent,
HTTPServerPushEvent,
HTTPDisconnectEvent,
]
WebSocketSendMessage: TypeAlias = Union[
WebSocketAcceptEvent,
WebSocketSendEvent,
WebSocketResponseStartEvent,
WebSocketResponseBodyEvent,
WebSocketCloseEvent,
]
LifeSpanSendMessage: TypeAlias = Union[
LifeSpanStartupCompleteEvent,
LifeSpanStartupFailedEvent,
LifeSpanShutdownCompleteEvent,
LifeSpanShutdownFailedEvent,
]
LifeSpanReceive: TypeAlias = Callable[..., Awaitable[LifeSpanReceiveMessage]]
LifeSpanSend: TypeAlias = Callable[[LifeSpanSendMessage], Awaitable[None]]
Message: TypeAlias = Union[HTTPSendMessage, WebSocketSendMessage]
ReceiveMessage: TypeAlias = Union[HTTPReceiveMessage, WebSocketReceiveMessage]
Scope: TypeAlias = Union[HTTPScope, WebSocketScope]
Receive: TypeAlias = Callable[..., Awaitable[Union[HTTPReceiveMessage, WebSocketReceiveMessage]]]
Send: TypeAlias = Callable[[Message], Awaitable[None]]
ASGIApp: TypeAlias = Callable[[Scope, Receive, Send], Awaitable[None]]
RawHeaders: TypeAlias = Iterable[tuple[bytes, bytes]]
RawHeadersList: TypeAlias = list[tuple[bytes, bytes]]
WebSocketMode: TypeAlias = Literal["text", "binary"]
Litestar