Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Deprecation Warnings for TemplateResponse and Jinja2Templates #575

Merged
merged 4 commits into from
Aug 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ env*
.mypy_cache
.vscode
.idea
.venv
poetry.lock
dist
htmlcov
Expand Down
4 changes: 3 additions & 1 deletion docs/user-guide/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,9 @@ from starlette_admin import CustomView
class HomeView(CustomView):
async def render(self, request: Request, templates: Jinja2Templates) -> Response:
return templates.TemplateResponse(
"home.html", {"request": request, "latest_posts": ..., "top_users": ...}
request,
name="home.html",
context={"latest_posts": ..., "top_users": ...},
)


Expand Down
15 changes: 9 additions & 6 deletions starlette_admin/auth.py
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,9 @@ async def render_login(self, request: Request, admin: "BaseAdmin") -> Response:
"""Render the default login page for username & password authentication."""
if request.method == "GET":
return admin.templates.TemplateResponse(
"login.html",
{"request": request, "_is_login_path": True},
request=request,
name="login.html",
context={"_is_login_path": True},
)
form = await request.form()
try:
Expand All @@ -251,14 +252,16 @@ async def render_login(self, request: Request, admin: "BaseAdmin") -> Response:
)
except FormValidationError as errors:
return admin.templates.TemplateResponse(
"login.html",
{"request": request, "form_errors": errors, "_is_login_path": True},
request=request,
name="login.html",
context={"form_errors": errors, "_is_login_path": True},
status_code=HTTP_422_UNPROCESSABLE_ENTITY,
)
except LoginFailed as error:
return admin.templates.TemplateResponse(
"login.html",
{"request": request, "error": error.msg, "_is_login_path": True},
request=request,
name="login.html",
context={"error": error.msg, "_is_login_path": True},
status_code=HTTP_400_BAD_REQUEST,
)

Expand Down
60 changes: 37 additions & 23 deletions starlette_admin/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
from json import JSONDecodeError
from typing import Any, Awaitable, Callable, Dict, List, Optional, Sequence, Type, Union

from jinja2 import ChoiceLoader, FileSystemLoader, PackageLoader
from jinja2 import ChoiceLoader, Environment, FileSystemLoader, PackageLoader
from starlette.applications import Starlette
from starlette.datastructures import FormData
from starlette.exceptions import HTTPException
Expand Down Expand Up @@ -190,13 +190,17 @@ def init_routes(self) -> None:
self._views.append(self.index_view)

def _setup_templates(self) -> None:
templates = Jinja2Templates(self.templates_dir, extensions=["jinja2.ext.i18n"])
templates.env.loader = ChoiceLoader(
[
FileSystemLoader(self.templates_dir),
PackageLoader("starlette_admin", "templates"),
]
env = Environment(
loader=ChoiceLoader(
[
FileSystemLoader(self.templates_dir),
PackageLoader("starlette_admin", "templates"),
]
),
extensions=["jinja2.ext.i18n"],
)
templates = Jinja2Templates(env=env)

# globals
templates.env.globals["views"] = self._views
templates.env.globals["app_title"] = self.title
Expand Down Expand Up @@ -374,9 +378,9 @@ async def _render_list(self, request: Request) -> Response:
if not model.is_accessible(request):
raise HTTPException(HTTP_403_FORBIDDEN)
return self.templates.TemplateResponse(
model.list_template,
{
"request": request,
request=request,
name=model.list_template,
context={
"model": model,
"title": model.title(request),
"_actions": await model.get_all_actions(request),
Expand All @@ -395,9 +399,9 @@ async def _render_detail(self, request: Request) -> Response:
if obj is None:
raise HTTPException(HTTP_404_NOT_FOUND)
return self.templates.TemplateResponse(
model.detail_template,
{
"request": request,
request=request,
name=model.detail_template,
context={
"title": model.title(request),
"model": model,
"raw_obj": obj,
Expand All @@ -410,11 +414,15 @@ async def _render_create(self, request: Request) -> Response:
request.state.action = RequestAction.CREATE
identity = request.path_params.get("identity")
model = self._find_model_from_identity(identity)
config = {"request": request, "title": model.title(request), "model": model}
config = {"title": model.title(request), "model": model}
if not model.is_accessible(request) or not model.can_create(request):
raise HTTPException(HTTP_403_FORBIDDEN)
if request.method == "GET":
return self.templates.TemplateResponse(model.create_template, config)
return self.templates.TemplateResponse(
request=request,
name=model.create_template,
context=config,
)
form = await request.form()
dict_obj = await self.form_to_dict(request, form, model, RequestAction.CREATE)
try:
Expand All @@ -427,8 +435,9 @@ async def _render_create(self, request: Request) -> Response:
}
)
return self.templates.TemplateResponse(
model.create_template,
config,
request=request,
name=model.create_template,
context=config,
status_code=HTTP_422_UNPROCESSABLE_ENTITY,
)
pk = await model.get_pk_value(request, obj)
Expand All @@ -452,14 +461,17 @@ async def _render_edit(self, request: Request) -> Response:
if obj is None:
raise HTTPException(HTTP_404_NOT_FOUND)
config = {
"request": request,
"title": model.title(request),
"model": model,
"raw_obj": obj,
"obj": await model.serialize(obj, request, RequestAction.EDIT),
}
if request.method == "GET":
return self.templates.TemplateResponse(model.edit_template, config)
return self.templates.TemplateResponse(
request=request,
name=model.edit_template,
context=config,
)
form = await request.form()
dict_obj = await self.form_to_dict(request, form, model, RequestAction.EDIT)
try:
Expand All @@ -472,8 +484,9 @@ async def _render_edit(self, request: Request) -> Response:
}
)
return self.templates.TemplateResponse(
model.edit_template,
config,
request=request,
name=model.edit_template,
context=config,
status_code=HTTP_422_UNPROCESSABLE_ENTITY,
)
pk = await model.get_pk_value(request, obj)
Expand All @@ -493,8 +506,9 @@ async def _render_error(
) -> Response:
assert isinstance(exc, HTTPException)
return self.templates.TemplateResponse(
"error.html",
{"request": request, "exc": exc},
request=request,
name="error.html",
context={"exc": exc},
status_code=exc.status_code,
)

Expand Down
4 changes: 3 additions & 1 deletion starlette_admin/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,9 @@ def __init__(
async def render(self, request: Request, templates: Jinja2Templates) -> Response:
"""Default methods to render view. Override this methods to add your custom logic."""
return templates.TemplateResponse(
self.template_path, {"request": request, "title": self.title(request)}
request=request,
name=self.template_path,
context={"title": self.title(request)},
)

def is_active(self, request: Request) -> bool:
Expand Down