Debian Codegraph @

docs/examples/middleware/call_order.py

raw
1 from typing import TYPE_CHECKING, List, Type
2
3 from litestar import Controller, Litestar, Router, get
4 from litestar.datastructures import State
5 from litestar.middleware import MiddlewareProtocol
6
7 if TYPE_CHECKING:
8 from litestar.types import ASGIApp, Receive, Scope, Send
9
10
11 def create_test_middleware(middleware_id: int) -> Type[MiddlewareProtocol]:
12 class TestMiddleware(MiddlewareProtocol):
13 def __init__(self, app: "ASGIApp") -> None:
14 self.app = app
15
16 async def __call__(self, scope: "Scope", receive: "Receive", send: "Send") -> None:
17 litestar_app = scope["app"]
18 litestar_app.state.setdefault("middleware_calls", [])
19 litestar_app.state["middleware_calls"].append(middleware_id)
20 await self.app(scope, receive, send)
21
22 return TestMiddleware
23
24
25 class MyController(Controller):
26 path = "/controller"
27 middleware = [create_test_middleware(4), create_test_middleware(5)]
28
29 @get(
30 "/handler",
31 middleware=[create_test_middleware(6), create_test_middleware(7)],
32 )
33 async def my_handler(self, state: State) -> List[int]:
34 return state["middleware_calls"]
35
36
37 router = Router(
38 path="/router",
39 route_handlers=[MyController],
40 middleware=[create_test_middleware(2), create_test_middleware(3)],
41 )
42
43 app = Litestar(
44 route_handlers=[router],
45 middleware=[create_test_middleware(0), create_test_middleware(1)],
46 )
47
48
49 # run: /router/controller/handler