Improve warnings on undefined template errors #48713
Merged
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
|
ℹ️ EDIT: Looking more closely, it is the comparison that breaks it. This is existing behavior and correct. It works pretty well in most cases. I' 10000 ve pasted a piece of a larger, random template into this and got an additional exception. Template used: {% if brightness is defined %}
{{ brightness }}
{% elif percent > 0 %}
{{ max_brightness }}
{% else %}
{{
(
(
(max_brightness - min_brightness) * ((100 + percent) / 100)
) + min_brightness
) | round
}}
{% endif %} |
frenck
approved these changes
Apr 6, 2021
balloob
reviewed
Apr 6, 2021
Comment on lines
+1326
to
+1327
| template_cv.set(template_str) | ||
| return template.render(**kwargs) |
There was a problem hiding this comment.
Should we set it to None after the render?
There was a problem hiding this comment.
I was thinking about that. Is there any scenario in which we could print a stale ContextVar?
There was a problem hiding this comment.
It's mainly for garbage collection purposes.
balloob
reviewed
Apr 6, 2021
| @@ -1314,12 +1319,59 @@ def urlencode(value): | |||
| return urllib_urlencode(value).encode("utf-8") | |||
|
|
|||
|
|
|||
| def _render_with_context( | |||
| template_str: str, template: jinja2.Template, **kwargs: Any | |||
There was a problem hiding this comment.
It took me a bit to realize, this is wrapping Jinja2 objects. Why don't we store our own template objects in it so we can access the template string too?
In the future we can then add "names" to templates, ie sensor.kitchen_temp - attribute name
balloob
approved these changes
Apr 6, 2021
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.
Proposed change
Improve warnings for undefined variables in templates introduced in #48140
Example: rendering template
"{{ no_such_variable }}"will result in this error message:Also fix some incorrect type annotations.
Type of change
Example entry for
configuration.yaml:# Example configuration.yamlAdditional information
Checklist
black --fast homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all..coveragerc.The integration reached or maintains the following Integration Quality Scale:
To help with the load of incoming pull requests: