1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
from __future__ import annotations
from typing import Any, Generic, TypeVar
from urllib.parse import quote
from litestar import Response
from litestar.contrib.htmx._utils import HTMX_STOP_POLLING, get_headers
from litestar.contrib.htmx.types import (
EventAfterType,
HtmxHeaderType,
LocationType,
PushUrlType,
ReSwapMethod,
TriggerEventType,
)
from litestar.response import Template
from litestar.status_codes import HTTP_200_OK
__all__ = (
"ClientRedirect",
"ClientRefresh",
"HTMXTemplate",
"HXLocation",
"HXStopPolling",
"PushUrl",
"ReplaceUrl",
"Reswap",
"Retarget",
"TriggerEvent",
)
# HTMX defined HTTP status code.
# Response carrying this status code will ask client to stop Polling.
T = TypeVar("T")
class HXStopPolling(Response):
"""Stop HTMX client from Polling."""
def __init__(self) -> None:
"""Initialize"""
super().__init__(content=None)
self.status_code = HTMX_STOP_POLLING
class ClientRedirect(Response):
"""HTMX Response class to support client side redirect."""
def __init__(self, redirect_to: str) -> None:
"""Set status code to 200 (required by HTMX), and pass redirect url."""
super().__init__(content=None, headers=get_headers(hx_headers=HtmxHeaderType(redirect=redirect_to)))
del self.headers["Location"]
class ClientRefresh(Response):
"""Response to support HTMX client page refresh"""
def __init__(self) -> None:
"""Set Status code to 200 and set headers."""
super().__init__(content=None, headers=get_headers(hx_headers=HtmxHeaderType(refresh=True)))
class PushUrl(Generic[T], Response[T]):
"""Response to push new url into the history stack."""
def __init__(self, content: T, push_url: PushUrlType, **kwargs: Any) -> None:
"""Initialize PushUrl."""
super().__init__(
content=content,
status_code=HTTP_200_OK,
headers=get_headers(hx_headers=HtmxHeaderType(push_url=push_url)),
**kwargs,
)
class ReplaceUrl(Generic[T], Response[T]):
"""Response to replace url in the Browser Location bar."""
def __init__(self, content: T, replace_url: PushUrlType, **kwargs: Any) -> None:
"""Initialize ReplaceUrl."""
super().__init__(
content=content,
status_code=HTTP_200_OK,
headers=get_headers(hx_headers=HtmxHeaderType(replace_url=replace_url)),
**kwargs,
)
class Reswap(Generic[T], Response[T]):
"""Response to specify how the response will be swapped."""
def __init__(
self,
content: T,
method: ReSwapMethod,
**kwargs: Any,
) -> None:
"""Initialize Reswap."""
super().__init__(content=content, headers=get_headers(hx_headers=HtmxHeaderType(re_swap=method)), **kwargs)
class Retarget(Generic[T], Response[T]):
"""Response to target different element on the page."""
def __init__(self, content: T, target: str, **kwargs: Any) -> None:
"""Initialize Retarget."""
super().__init__(content=content, headers=get_headers(hx_headers=HtmxHeaderType(re_target=target)), **kwargs)
class TriggerEvent(Generic[T], Response[T]):
"""Trigger Client side event."""
def __init__(
self,
content: T,
name: str,
after: EventAfterType,
params: dict[str, Any] | None = None,
**kwargs: Any,
) -> None:
"""Initialize TriggerEvent."""
event = TriggerEventType(name=name, params=params, after=after)
headers = get_headers(hx_headers=HtmxHeaderType(trigger_event=event))
super().__init__(content=content, headers=headers, **kwargs)
class HXLocation(Response):
"""Client side redirect without full page reload."""
def __init__(
self,
redirect_to: str,
source: str | None = None,
event: str | None = None,
target: str | None = None,
swap: ReSwapMethod | None = None,
hx_headers: dict[str, Any] | None = None,
values: dict[str, str] | None = None,
**kwargs: Any,
) -> None:
"""Initialize HXLocation, Set status code to 200 (required by HTMX),
and pass redirect url.
"""
super().__init__(
content=None,
headers={"Location": quote(redirect_to, safe="/#%[]=:;$&()+,!?*@'~")},
**kwargs,
)
spec: dict[str, Any] = get_headers(
hx_headers=HtmxHeaderType(
location=LocationType(
path=str(self.headers.get("Location")),
source=source,
event=event,
target=target,
swap=swap,
values=values,
hx_headers=hx_headers,
)
)
)
del self.headers["Location"]
self.headers.update(spec)
class HTMXTemplate(Template):
"""HTMX template wrapper"""
def __init__(
self,
push_url: PushUrlType | None = None,
re_swap: ReSwapMethod | None = None,
re_target: str | None = None,
trigger_event: str | None = None,
params: dict[str, Any] | None = None,
after: EventAfterType | None = None,
**kwargs: Any,
) -> None:
"""Create HTMXTemplate response.
Args:
push_url: Either a string value specifying a URL to push to browser history or ``False`` to prevent HTMX client from
pushing a url to browser history.
re_swap: Method value to instruct HTMX which swapping method to use.
re_target: Value for 'id of target element' to apply changes to.
trigger_event: Event name to trigger.
params: Dictionary of parameters if any required with trigger event parameter.
after: Changes to apply after ``receive``, ``settle`` or ``swap`` event.
**kwargs: Additional arguments to pass to ``Template``.
"""
super().__init__(**kwargs)
event: TriggerEventType | None = None
if trigger_event:
event = TriggerEventType(name=str(trigger_event), params=params, after=after)
self.headers.update(
get_headers(HtmxHeaderType(push_url=push_url, re_swap=re_swap, re_target=re_target, trigger_event=event))
)
|
