Add env argument to Jinja2Templates, remove **env_options. (ref #2134)#2159
Merged
Kludex merged 17 commits intoKludex:masterfrom Jun 5, 2023
Merged
Add env argument to Jinja2Templates, remove **env_options. (ref #2134)#2159Kludex merged 17 commits intoKludex:masterfrom
Kludex merged 17 commits intoKludex:masterfrom
Conversation
|
I like this, it meets the "starlette has a simple opinionated way" need whilst also allowing the user to do something really complicated without the starlette project having to think about a new API at all - since it falls to a shared idea of the Jinja environment which is referenced and used in many different jinja projects. |
Owner
|
Can we deprecate the |
Kludex
reviewed
Jun 1, 2023
| @@ -64,18 +65,27 @@ class Jinja2Templates: | |||
|
|
|||
| def __init__( | |||
Kludex
requested changes
Jun 1, 2023
Owner
Kludex
left a comment
There was a problem hiding this comment.
With the overload and the rebase, we are done here 👍
Comment on lines
+86
to
+92
| self, | ||
| directory: typing.Union[str, PathLike], | ||
| **env_options: typing.Any, |
Owner
There was a problem hiding this comment.
Suggested change
| self, | |
| directory: typing.Union[str, PathLike], | |
| **env_options: typing.Any, | |
| self, directory: typing.Union[str, PathLike], **env_options: typing.Any |
Owner
|
I've rebased it. |
Merged
Contributor
Author
|
I had to make all other arguments as kw-only to make overloading work. |
Kludex
approved these changes
Jun 5, 2023
Owner
Kludex
left a comment
There was a problem hiding this comment.
Thanks 👍
Let's accept the context_processors being a kw-only as a breaking change.
Kludex
reviewed
Jun 5, 2023
| ## Using custom jinja2.Environment instance | ||
|
|
||
| Starlette also accepts a preconfigured `jinja2.Environment` instance. | ||
| Starlette also accepts a preconfigured [`jinja2.Environment`](https://jinja.palletsprojects.com/en/3.0.x/api/#api) instance. |
Owner
There was a problem hiding this comment.
I think this doesn't render very well on mkdocs
Contributor
Author
There was a problem hiding this comment.
it looks good
Owner
|
Thanks 👍 |
ptrstn
added a commit
to ptrstn/starlette-admin
that referenced
this pull request
Aug 31, 2024
Resolves jowilf#574 According to the Starlette 0.28.0 release notes, the **env_options parameter in Jinja2Templates has been deprecated in favor of the new env parameter. The relevant pull request #2159 explains this change. See: - Kludex/starlette#2159 - https://www.starlette.io/release-notes/#0280
jowilf
pushed a commit
to jowilf/starlette-admin
that referenced
this pull request
Aug 31, 2024
* Ignore .venv * Fix DeprecationWarning: The `name` is not the first parameter anymore. Addresses #574 DeprecationWarning: The `name` is not the first parameter anymore. The first parameter should be the `Request` instance. Replace `TemplateResponse(name, {"request": request})` by `TemplateResponse(request, name)`. warnings.warn( Before Starlette 0.29.0, the name was the first parameter. Also, before that, in previous versions, the request object was passed as part of the key-value pairs in the context for Jinja2. See: - https://www.starlette.io/release-notes/#0290 - Kludex/starlette#2191 - https://github.com/encode/starlette/blob/c78c9aac17a4d68e0647252310044502f1b7da71/starlette/templating.py#L166-L178 - https://fastapi.tiangolo.com/reference/templating/#fastapi.templating.Jinja2Templates.TemplateResponse - https://fastapi.tiangolo.com/advanced/templates/#using-jinja2templates * Fix DeprecationWarning: Extra environment options are deprecated. Resolves #574 According to the Starlette 0.28.0 release notes, the **env_options parameter in Jinja2Templates has been deprecated in favor of the new env parameter. The relevant pull request #2159 explains this change. See: - Kludex/starlette#2159 - https://www.starlette.io/release-notes/#0280 * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds
envargument toJinja2Templatesclass and removes**env_options.Motivation
See this discussion - #2134
Jinja2Templatesconfigure only this class and nothing elsejinja2.Environmentand use it in the app without limitsEnvironmentclass may be used by other app components, not just by StarletteThis is a breaking change!
Example