Skip to content

Commit b7a7225

Browse files
cofinxronocode
andcommitted
refactor(minijinja): migrate callers to plugins.minijinja and remove contrib path
- Migrate every internal call site (tests, doc examples, the lazy import inside `litestar.plugins.flash`) to `from litestar.plugins.minijinja import ...`. The flash.py change preserves the public/private split: it still imports both `MiniJinjaTemplateEngine` and the module-level `_transform_state` helper. - Delete `litestar/contrib/minijinja.py`. The contrib path is gone on main; the v2 follow-up PR adds a deprecation shim at the contrib location covering both public symbols and `_transform_state`, so 2.x users (whose flash.py still imports from contrib) get a `DeprecationWarning` window with a real migration target on the version they are already running. - Salvage the contrib functional tests into `tests/unit/test_plugins/test_minijinja.py` (99% line coverage on the new module) and delete `tests/unit/test_contrib/test_minijinja.py`. - Add `docs/reference/plugins/minijinja.rst`; update the plugins reference toctree. Co-authored-by: xronocode <myevdokimov@gmail.com>
1 parent 1ba9eec commit b7a7225

17 files changed

Lines changed: 110 additions & 259 deletions

File tree

docs/examples/plugins/flash_messages/minijinja.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
from litestar import Litestar
2-
from litestar.contrib.minijinja import MiniJinjaTemplateEngine
2+
from litestar.plugins.minijinja import MiniJinjaTemplateEngine
33
from litestar.middleware.session.server_side import ServerSideSessionConfig
44
from litestar.plugins.flash import FlashConfig, FlashPlugin
55
from litestar.template.config import TemplateConfig
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
from litestar.contrib.minijinja import MiniJinjaTemplateEngine
1+
from litestar.plugins.minijinja import MiniJinjaTemplateEngine
22
from litestar.template.config import TemplateConfig
33

44
template_config = TemplateConfig(engine=MiniJinjaTemplateEngine, directory="templates")

docs/examples/templating/returning_templates_minijinja.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
from pathlib import Path
44

55
from litestar import Litestar, get
6-
from litestar.contrib.minijinja import MiniJinjaTemplateEngine
6+
from litestar.plugins.minijinja import MiniJinjaTemplateEngine
77
from litestar.response import Template
88
from litestar.template.config import TemplateConfig
99

docs/examples/templating/template_engine_minijinja.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
from pathlib import Path
22

33
from litestar import Litestar
4-
from litestar.contrib.minijinja import MiniJinjaTemplateEngine
4+
from litestar.plugins.minijinja import MiniJinjaTemplateEngine
55
from litestar.template.config import TemplateConfig
66

77
app = Litestar(

docs/examples/templating/template_functions_minijinja.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
from pathlib import Path
22

33
from litestar import Litestar, get
4-
from litestar.contrib.minijinja import MiniJinjaTemplateEngine, StateProtocol
4+
from litestar.plugins.minijinja import MiniJinjaTemplateEngine, StateProtocol
55
from litestar.response import Template
66
from litestar.template.config import TemplateConfig
77

docs/reference/plugins/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ plugins
1212
attrs
1313
flash_messages
1414
htmx
15+
minijinja
1516
opentelemetry
1617
problem_details
1718
prometheus
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
=========
2+
minijinja
3+
=========
4+
5+
.. automodule:: litestar.plugins.minijinja
6+
:members:

litestar/contrib/minijinja.py

Lines changed: 0 additions & 201 deletions
This file was deleted.

litestar/plugins/flash.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ def on_app_init(self, app_config: AppConfig) -> AppConfig:
5959
raise litestar.exceptions.ImproperlyConfiguredException("Flash messages require a session middleware.")
6060
template_callable: Callable[[Any], Any] = get_flashes
6161
with suppress(MissingDependencyException):
62-
from litestar.contrib.minijinja import MiniJinjaTemplateEngine, _transform_state
62+
from litestar.plugins.minijinja import MiniJinjaTemplateEngine, _transform_state
6363

6464
if isinstance(self.config.template_config.engine_instance, MiniJinjaTemplateEngine):
6565
template_callable = _transform_state(get_flashes)

tests/unit/test_contrib/test_minijinja.py

Lines changed: 0 additions & 46 deletions
This file was deleted.

0 commit comments

Comments
 (0)