Source code for litestar.routes.asgi

from __future__ import annotations

from typing import TYPE_CHECKING, Any

from litestar.connection import ASGIConnection
from litestar.routes.base import BaseRoute
from litestar.types import Scope

if TYPE_CHECKING:
    from litestar.handlers.asgi_handlers import ASGIRouteHandler
    from litestar.types import Receive, Send


[docs] class ASGIRoute(BaseRoute[Scope]): """An ASGI route, handling a single ``ASGIRouteHandler``""" __slots__ = ("_copy_scope", "route_handler")
[docs] def __init__( self, *, path: str, route_handler: ASGIRouteHandler, ) -> None: """Initialize the route. Args: path: The path for the route. route_handler: An instance of :class:`~.handlers.ASGIRouteHandler`. """ self.route_handler = route_handler self._copy_scope = route_handler.copy_scope super().__init__(path=path)
[docs] async def handle(self, scope: Scope, receive: Receive, send: Send) -> None: """ASGI app that authorizes the connection and then awaits the handler function. Args: scope: The ASGI connection scope. receive: The ASGI receive function. send: The ASGI send function. Returns: None """ connection = ASGIConnection["ASGIRouteHandler", Any, Any, Any]( scope=scope.copy() if self._copy_scope else scope, receive=receive, send=send, ) await self.route_handler.handle(connection=connection)