jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-28 07:37:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve docstrings of event helpers related to state changes (#148722)

Browse Source
This commit is contained in:
Erik Montnemery 2025-07-14 11:57:27 +02:00 committed by GitHub
parent 50047f0a4e
commit dcbdce4b2b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
homeassistant/helpers/event.py
View File

@ -316,6 +316,10 @@ def async_track_state_change_event(
Unlike async_track_state_change, async_track_state_change_event Unlike async_track_state_change, async_track_state_change_event
passes the full event to the callback. passes the full event to the callback.
The action will not be called immediately, but will be scheduled to run
in the next event loop iteration, even if the action is decorated with
@callback.
In order to avoid having to iterate a long list In order to avoid having to iterate a long list
of EVENT_STATE_CHANGED and fire and create a job of EVENT_STATE_CHANGED and fire and create a job
for each one, we keep a dict of entity ids that for each one, we keep a dict of entity ids that
@ -866,6 +870,10 @@ def async_track_state_change_filtered(
) -> _TrackStateChangeFiltered: ) -> _TrackStateChangeFiltered:
"""Track state changes with a TrackStates filter that can be updated. """Track state changes with a TrackStates filter that can be updated.
The action will not be called immediately, but will be scheduled to run
in the next event loop iteration, even if the action is decorated with
@callback.
Args: Args:
hass: hass:
Home assistant object. Home assistant object.
@ -1348,9 +1356,13 @@ def async_track_template_result(
then whenever the output from the template changes. The template will then whenever the output from the template changes. The template will
be reevaluated if any states referenced in the last run of the be reevaluated if any states referenced in the last run of the
template change, or if manually triggered. If the result of the template change, or if manually triggered. If the result of the
evaluation is different from the previous run, the listener is passed evaluation is different from the previous run, the action is passed
the result. the result.
The action will not be called immediately, but will be scheduled to run
in the next event loop iteration, even if the action is decorated with
@callback.
If the template results in an TemplateError, this will be returned to If the template results in an TemplateError, this will be returned to
the listener the first time this happens but not for subsequent errors. the listener the first time this happens but not for subsequent errors.
Once the template returns to a non-error condition the result is sent Once the template returns to a non-error condition the result is sent