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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
from __future__ import annotations
import functools
from pathlib import Path
from typing import TYPE_CHECKING, Any, Mapping, Protocol, TypeVar, cast
from typing_extensions import ParamSpec
from litestar.exceptions import ImproperlyConfiguredException, MissingDependencyException, TemplateNotFoundException
from litestar.template.base import (
TemplateCallableType,
TemplateEngineProtocol,
TemplateProtocol,
csrf_token,
url_for,
url_for_static_asset,
)
from litestar.utils.deprecation import warn_deprecation
try:
from minijinja import Environment # type:ignore[import-untyped]
from minijinja import TemplateError as MiniJinjaTemplateNotFound
except ImportError as e:
raise MissingDependencyException("minijinja") from e
if TYPE_CHECKING:
from typing import Callable
C = TypeVar("C", bound="Callable")
def pass_state(func: C) -> C: ...
else:
from minijinja import pass_state
__all__ = (
"MiniJinjaTemplateEngine",
"StateProtocol",
)
P = ParamSpec("P")
T = TypeVar("T")
class StateProtocol(Protocol):
auto_escape: str | None
current_block: str | None
env: Environment
name: str
def lookup(self, key: str) -> Any | None: ...
def _transform_state(func: TemplateCallableType[Mapping[str, Any], P, T]) -> TemplateCallableType[StateProtocol, P, T]:
"""Transform a template callable to receive a ``StateProtocol`` instance as first argument.
This is for wrapping callables like ``url_for()`` that receive a mapping as first argument so they can be used
with minijinja which passes a ``StateProtocol`` instance as first argument.
"""
@functools.wraps(func)
@pass_state
def wrapped(state: StateProtocol, /, *args: P.args, **kwargs: P.kwargs) -> T:
template_context = {"request": state.lookup("request"), "csrf_input": state.lookup("csrf_input")}
return func(template_context, *args, **kwargs)
return wrapped
class MiniJinjaTemplate(TemplateProtocol):
"""Initialize a template.
Args:
template: Base ``MiniJinjaTemplate`` used by the underlying minijinja engine
"""
def __init__(self, engine: Environment, template_name: str) -> None:
super().__init__()
self.engine = engine
self.template_name = template_name
def render(self, *args: Any, **kwargs: Any) -> str:
"""Render a template.
Args:
args: Positional arguments passed to the engines ``render`` function
kwargs: Keyword arguments passed to the engines ``render`` function
Returns:
Rendered template as a string
"""
try:
return str(self.engine.render_template(self.template_name, *args, **kwargs))
except MiniJinjaTemplateNotFound as err:
raise TemplateNotFoundException(template_name=self.template_name) from err
class MiniJinjaTemplateEngine(TemplateEngineProtocol["MiniJinjaTemplate", StateProtocol]):
"""The engine instance."""
def __init__(self, directory: Path | list[Path] | None = None, engine_instance: Environment | None = None) -> None:
"""Minijinja based TemplateEngine.
Args:
directory: Direct path or list of directory paths from which to serve templates.
engine_instance: A Minijinja Environment instance.
"""
super().__init__(directory, engine_instance)
if directory and engine_instance:
raise ImproperlyConfiguredException(
"You must provide either a directory or a minijinja Environment instance."
)
if directory:
def _loader(name: str) -> str:
"""Load a template from a directory.
Args:
name: The name of the template
Returns:
The template as a string
Raises:
TemplateNotFoundException: if no template is found.
"""
directories = directory if isinstance(directory, list) else [directory]
for d in directories:
template_path = Path(d) / name # pyright: ignore[reportGeneralTypeIssues]
if template_path.exists():
return template_path.read_text()
raise TemplateNotFoundException(template_name=name)
self.engine = Environment(loader=_loader)
elif engine_instance:
self.engine = engine_instance
else:
raise ImproperlyConfiguredException(
"You must provide either a directory or a minijinja Environment instance."
)
self.register_template_callable("url_for", _transform_state(url_for))
self.register_template_callable("csrf_token", _transform_state(csrf_token))
self.register_template_callable("url_for_static_asset", _transform_state(url_for_static_asset))
def get_template(self, template_name: str) -> MiniJinjaTemplate:
"""Retrieve a template by matching its name (dotted path) with files in the directory or directories provided.
Args:
template_name: A dotted path
Returns:
MiniJinjaTemplate instance
Raises:
TemplateNotFoundException: if no template is found.
"""
return MiniJinjaTemplate(self.engine, template_name)
def register_template_callable(
self, key: str, template_callable: TemplateCallableType[StateProtocol, P, T]
) -> None:
"""Register a callable on the template engine.
Args:
key: The callable key, i.e. the value to use inside the template to call the callable.
template_callable: A callable to register.
Returns:
None
"""
self.engine.add_global(key, pass_state(template_callable))
def render_string(self, template_string: str, context: Mapping[str, Any]) -> str:
"""Render a template from a string with the given context.
Args:
template_string: The template string to render.
context: A dictionary of variables to pass to the template.
Returns:
The rendered template as a string.
"""
return self.engine.render_str(template_string, **context) # type: ignore[no-any-return]
@classmethod
def from_environment(cls, minijinja_environment: Environment) -> MiniJinjaTemplateEngine:
"""Create a MiniJinjaTemplateEngine from an existing minijinja Environment instance.
Args:
minijinja_environment (Environment): A minijinja Environment instance.
Returns:
MiniJinjaTemplateEngine instance
"""
return cls(directory=None, engine_instance=minijinja_environment)
@pass_state
def _minijinja_from_state(func: Callable, state: StateProtocol, *args: Any, **kwargs: Any) -> str: # pragma: no cover
template_context = {"request": state.lookup("request"), "csrf_input": state.lookup("csrf_input")}
return cast(str, func(template_context, *args, **kwargs))
def __getattr__(name: str) -> Any:
if name == "minijinja_from_state":
warn_deprecation(
"2.3.0",
"minijinja_from_state",
"import",
removal_in="3.0.0",
alternative="Use a callable that receives the minijinja State object as first argument.",
)
return _minijinja_from_state
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
|
