Debian Codegraph @

docs/examples/request_data/custom_request.py

raw
1 from litestar import Litestar, Request, get
2 from litestar.connection.base import empty_receive, empty_send
3 from litestar.enums import HttpMethod
4 from litestar.types import Receive, Scope, Send
5
6 KITTEN_NAMES_MAP = {
7 HttpMethod.GET: "Whiskers",
8 }
9
10
11 class CustomRequest(Request):
12 """Enrich request with the kitten name."""
13
14 __slots__ = ("kitten_name",)
15
16 def __init__(self, scope: Scope, receive: Receive = empty_receive, send: Send = empty_send) -> None:
17 """Initialize CustomRequest class."""
18 super().__init__(scope=scope, receive=receive, send=send)
19 self.kitten_name = KITTEN_NAMES_MAP.get(scope["method"], "Mittens")
20
21
22 @get(path="/kitten-name")
23 async def get_kitten_name(request: CustomRequest) -> str:
24 """Get kitten name based on the HTTP method."""
25 return request.kitten_name
26
27
28 app = Litestar(
29 route_handlers=[get_kitten_name],
30 request_class=CustomRequest,
31 debug=True,
32 )