Closes #18797: Support path import for certain Jinja environment parameters #19962
Conversation
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
jeremystretch
requested review from
a team and
jnovinger
and removed request for
a team
jnovinger
reviewed
Jul 28, 2025
Member
jnovinger
left a comment
jnovinger
left a comment
There was a problem hiding this comment.
Had a couple of questions. Given new behavior, would love to see some testing. Lastly, is it worth mentioning this in the docs somewhere? Perhaps even in just the ConfigTemplate model docs for the environment params field.
| for name, value in params.items(): | ||
| if name in JINJA_ENV_PARAMS_WITH_PATH_IMPORT and type(value) is str: | ||
| params[name] = import_string(value) | ||
| return params |
Member
There was a problem hiding this comment.
Couple of questions here:
- Should we do any validation of
value? E.g. make sure it's within a set of accepted values? - I assume
import_string()might raise some exceptions, especially around dotted-paths that don't exist. Is the intention to let those bubble up to the user?
Member
Author
There was a problem hiding this comment.
- What would the valid values be? I don't think we have a way of knowing, unless we limited it to a very small, prescribed set of choices.
- Yes; exceptions will be raised to surface the invalid configuration.
Member
Author
Unfortunately there's no existing test case for this functionality which can be expanded to cover the modest addition in functionality. I've opened #19971 for new test cases to be added, but it's beyond the scope of this FR IMO. |
jnovinger
approved these changes
Jul 29, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Closes: #18797
Adds support for dotted path imports for Jinja environment params
undefinedandfinalize, for both config templates and export templates.get_environment_params()method on RenderTemplateMixin