Allow specifying a custom log function for template render #99572
Conversation
This file contains 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
|
Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
balloob
reviewed
Sep 4, 2023
20 tasks
emontnemery
force-pushed
the
template_custom_log_callback
branch
from
70effbf
to
a74ce5e
Compare
9 tasks
balloob
reviewed
Sep 6, 2023
homeassistant/helpers/template.py
Outdated
| log_warning = _LOGGER.warning | ||
| else: | ||
| # Mypy does not agree log_fn is not None here | ||
| log_error = log_warning = lambda msg, *args: log_fn(msg % args) # type: ignore[misc] |
There was a problem hiding this comment.
Should we pass warning or error as an level arg ?
There was a problem hiding this comment.
That's a good idea, implemented 👍
balloob
reviewed
Sep 6, 2023
| @@ -2178,45 +2198,62 @@ def _render_with_context( | |||
| return template.render(**kwargs) | |||
|
|
|||
|
|
|||
| class LoggingUndefined(jinja2.Undefined): | |||
| def make_logging_undefined( | |||
There was a problem hiding this comment.
Why not add an __init__ to the class ?
There was a problem hiding this comment.
Because we're not returning an instance of the class, we're returning the class itself.
balloob
approved these changes
Sep 6, 2023
bramkragten
pushed a commit
that referenced
this pull request
Sep 6, 2023
* Allow specifying a custom log function for template render * Bypass template cache when reporting errors + fix tests * Send errors as events * Fix logic for creating new TemplateEnvironment * Add strict mode back * Only send error events if report_errors is True * Force test of websocket_api only * Debug test * Run pytest with higher verbosity * Timeout after 1 minute, enable syslog output * Adjust timeout * Add debug logs * Fix unsafe call to WebSocketHandler._send_message * Remove debug code * Improve test coverage * Revert accidental change * Include severity in error events * Remove redundant information from error events
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
Allow specifying a custom log function for template render and use it for the
render_templateWS commandDrop the
strictparameter to therender_templateBackground:
The
strictparameter to therender_templatewas added to avoid logging errors from the template developer tool. However, thestrictmode also unintentionally changed the result when rendering templates.This PR captures the log messages and send them over the websocket without affecting the result of rendering templates.
Needs (and currently includes) #99571
Type of change
Additional 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.To help with the load of incoming pull requests: