updates
This commit is contained in:
Iliyan Angelov
@@ -1,10 +1,14 @@
|
||||
import typing
|
||||
from __future__ import annotations
|
||||
|
||||
import warnings
|
||||
from collections.abc import Callable, Mapping, Sequence
|
||||
from os import PathLike
|
||||
from typing import Any, cast, overload
|
||||
|
||||
from starlette.background import BackgroundTask
|
||||
from starlette.datastructures import URL
|
||||
from starlette.requests import Request
|
||||
from starlette.responses import Response
|
||||
from starlette.responses import HTMLResponse
|
||||
from starlette.types import Receive, Scope, Send
|
||||
|
||||
try:
|
||||
@@ -16,23 +20,21 @@ try:
|
||||
# adding a type ignore for mypy to let us access an attribute that may not exist
|
||||
if hasattr(jinja2, "pass_context"):
|
||||
pass_context = jinja2.pass_context
|
||||
else: # pragma: nocover
|
||||
else: # pragma: no cover
|
||||
pass_context = jinja2.contextfunction # type: ignore[attr-defined]
|
||||
except ModuleNotFoundError: # pragma: nocover
|
||||
except ModuleNotFoundError: # pragma: no cover
|
||||
jinja2 = None # type: ignore[assignment]
|
||||
|
||||
|
||||
class _TemplateResponse(Response):
|
||||
media_type = "text/html"
|
||||
|
||||
class _TemplateResponse(HTMLResponse):
|
||||
def __init__(
|
||||
self,
|
||||
template: typing.Any,
|
||||
context: dict,
|
||||
template: Any,
|
||||
context: dict[str, Any],
|
||||
status_code: int = 200,
|
||||
headers: typing.Optional[typing.Mapping[str, str]] = None,
|
||||
media_type: typing.Optional[str] = None,
|
||||
background: typing.Optional[BackgroundTask] = None,
|
||||
headers: Mapping[str, str] | None = None,
|
||||
media_type: str | None = None,
|
||||
background: BackgroundTask | None = None,
|
||||
):
|
||||
self.template = template
|
||||
self.context = context
|
||||
@@ -42,7 +44,7 @@ class _TemplateResponse(Response):
|
||||
async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
|
||||
request = self.context.get("request", {})
|
||||
extensions = request.get("extensions", {})
|
||||
if "http.response.debug" in extensions:
|
||||
if "http.response.debug" in extensions: # pragma: no branch
|
||||
await send(
|
||||
{
|
||||
"type": "http.response.debug",
|
||||
@@ -62,50 +64,145 @@ class Jinja2Templates:
|
||||
return templates.TemplateResponse("index.html", {"request": request})
|
||||
"""
|
||||
|
||||
@overload
|
||||
def __init__(
|
||||
self,
|
||||
directory: typing.Union[str, PathLike],
|
||||
context_processors: typing.Optional[
|
||||
typing.List[typing.Callable[[Request], typing.Dict[str, typing.Any]]]
|
||||
] = None,
|
||||
**env_options: typing.Any,
|
||||
directory: str | PathLike[str] | Sequence[str | PathLike[str]],
|
||||
*,
|
||||
context_processors: list[Callable[[Request], dict[str, Any]]] | None = None,
|
||||
**env_options: Any,
|
||||
) -> None: ...
|
||||
|
||||
@overload
|
||||
def __init__(
|
||||
self,
|
||||
*,
|
||||
env: jinja2.Environment,
|
||||
context_processors: list[Callable[[Request], dict[str, Any]]] | None = None,
|
||||
) -> None: ...
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
directory: str | PathLike[str] | Sequence[str | PathLike[str]] | None = None,
|
||||
*,
|
||||
context_processors: list[Callable[[Request], dict[str, Any]]] | None = None,
|
||||
env: jinja2.Environment | None = None,
|
||||
**env_options: Any,
|
||||
) -> None:
|
||||
if env_options:
|
||||
warnings.warn(
|
||||
"Extra environment options are deprecated. Use a preconfigured jinja2.Environment instead.",
|
||||
DeprecationWarning,
|
||||
)
|
||||
assert jinja2 is not None, "jinja2 must be installed to use Jinja2Templates"
|
||||
self.env = self._create_env(directory, **env_options)
|
||||
assert bool(directory) ^ bool(env), "either 'directory' or 'env' arguments must be passed"
|
||||
self.context_processors = context_processors or []
|
||||
if directory is not None:
|
||||
self.env = self._create_env(directory, **env_options)
|
||||
elif env is not None: # pragma: no branch
|
||||
self.env = env
|
||||
|
||||
self._setup_env_defaults(self.env)
|
||||
|
||||
def _create_env(
|
||||
self, directory: typing.Union[str, PathLike], **env_options: typing.Any
|
||||
) -> "jinja2.Environment":
|
||||
@pass_context
|
||||
def url_for(context: dict, name: str, **path_params: typing.Any) -> URL:
|
||||
request = context["request"]
|
||||
return request.url_for(name, **path_params)
|
||||
|
||||
self,
|
||||
directory: str | PathLike[str] | Sequence[str | PathLike[str]],
|
||||
**env_options: Any,
|
||||
) -> jinja2.Environment:
|
||||
loader = jinja2.FileSystemLoader(directory)
|
||||
env_options.setdefault("loader", loader)
|
||||
env_options.setdefault("autoescape", True)
|
||||
|
||||
env = jinja2.Environment(**env_options)
|
||||
env.globals["url_for"] = url_for
|
||||
return env
|
||||
return jinja2.Environment(**env_options)
|
||||
|
||||
def get_template(self, name: str) -> "jinja2.Template":
|
||||
def _setup_env_defaults(self, env: jinja2.Environment) -> None:
|
||||
@pass_context
|
||||
def url_for(
|
||||
context: dict[str, Any],
|
||||
name: str,
|
||||
/,
|
||||
**path_params: Any,
|
||||
) -> URL:
|
||||
request: Request = context["request"]
|
||||
return request.url_for(name, **path_params)
|
||||
|
||||
env.globals.setdefault("url_for", url_for)
|
||||
|
||||
def get_template(self, name: str) -> jinja2.Template:
|
||||
return self.env.get_template(name)
|
||||
|
||||
@overload
|
||||
def TemplateResponse(
|
||||
self,
|
||||
request: Request,
|
||||
name: str,
|
||||
context: dict[str, Any] | None = None,
|
||||
status_code: int = 200,
|
||||
headers: Mapping[str, str] | None = None,
|
||||
media_type: str | None = None,
|
||||
background: BackgroundTask | None = None,
|
||||
) -> _TemplateResponse: ...
|
||||
|
||||
@overload
|
||||
def TemplateResponse(
|
||||
self,
|
||||
name: str,
|
||||
context: dict,
|
||||
context: dict[str, Any] | None = None,
|
||||
status_code: int = 200,
|
||||
headers: typing.Optional[typing.Mapping[str, str]] = None,
|
||||
media_type: typing.Optional[str] = None,
|
||||
background: typing.Optional[BackgroundTask] = None,
|
||||
headers: Mapping[str, str] | None = None,
|
||||
media_type: str | None = None,
|
||||
background: BackgroundTask | None = None,
|
||||
) -> _TemplateResponse:
|
||||
if "request" not in context:
|
||||
raise ValueError('context must include a "request" key')
|
||||
# Deprecated usage
|
||||
...
|
||||
|
||||
request = typing.cast(Request, context["request"])
|
||||
def TemplateResponse(self, *args: Any, **kwargs: Any) -> _TemplateResponse:
|
||||
if args:
|
||||
if isinstance(args[0], str): # the first argument is template name (old style)
|
||||
warnings.warn(
|
||||
"The `name` is not the first parameter anymore. "
|
||||
"The first parameter should be the `Request` instance.\n"
|
||||
'Replace `TemplateResponse(name, {"request": request})` by `TemplateResponse(request, name)`.',
|
||||
DeprecationWarning,
|
||||
)
|
||||
|
||||
name = args[0]
|
||||
context = args[1] if len(args) > 1 else kwargs.get("context", {})
|
||||
status_code = args[2] if len(args) > 2 else kwargs.get("status_code", 200)
|
||||
headers = args[3] if len(args) > 3 else kwargs.get("headers")
|
||||
media_type = args[4] if len(args) > 4 else kwargs.get("media_type")
|
||||
background = args[5] if len(args) > 5 else kwargs.get("background")
|
||||
|
||||
if "request" not in context:
|
||||
raise ValueError('context must include a "request" key')
|
||||
request = context["request"]
|
||||
else: # the first argument is a request instance (new style)
|
||||
request = args[0]
|
||||
name = args[1] if len(args) > 1 else kwargs["name"]
|
||||
context = args[2] if len(args) > 2 else kwargs.get("context", {})
|
||||
status_code = args[3] if len(args) > 3 else kwargs.get("status_code", 200)
|
||||
headers = args[4] if len(args) > 4 else kwargs.get("headers")
|
||||
media_type = args[5] if len(args) > 5 else kwargs.get("media_type")
|
||||
background = args[6] if len(args) > 6 else kwargs.get("background")
|
||||
else: # all arguments are kwargs
|
||||
if "request" not in kwargs:
|
||||
warnings.warn(
|
||||
"The `TemplateResponse` now requires the `request` argument.\n"
|
||||
'Replace `TemplateResponse(name, {"context": context})` by `TemplateResponse(request, name)`.',
|
||||
DeprecationWarning,
|
||||
)
|
||||
if "request" not in kwargs.get("context", {}):
|
||||
raise ValueError('context must include a "request" key')
|
||||
|
||||
context = kwargs.get("context", {})
|
||||
request = kwargs.get("request", context.get("request"))
|
||||
name = cast(str, kwargs["name"])
|
||||
status_code = kwargs.get("status_code", 200)
|
||||
headers = kwargs.get("headers")
|
||||
media_type = kwargs.get("media_type")
|
||||
background = kwargs.get("background")
|
||||
|
||||
context.setdefault("request", request)
|
||||
for context_processor in self.context_processors:
|
||||
context.update(context_processor(request))
|
||||
|
||||
|
||||
Reference in New Issue
Block a user