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

Clarify event tracking in docstrings for track_state_change/report (#129338)

Browse Source 
* Clarify event tracking in docstrings for track_state_change/report

* Fixes

* Update homeassistant/helpers/event.py

* Update homeassistant/helpers/event.py

Co-authored-by: J. Nick Koston <nick@koston.org>

---------

Co-authored-by: Erik Montnemery <erik@montnemery.com>
Co-authored-by: J. Nick Koston <nick@koston.org>
This commit is contained in:
G Johansson 2024-10-28 23:05:06 +01:00 committed by GitHub
parent 9546bf1dee
commit d727f8ff50
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
homeassistant/helpers/event.py
View File

@ -322,6 +322,10 @@ def async_track_state_change_event(
for each one, we keep a dict of entity ids that for each one, we keep a dict of entity ids that
care about the state change events so we can care about the state change events so we can
do a fast dict lookup to route events. do a fast dict lookup to route events.
The passed in entity_ids will be automatically lower cased.
EVENT_STATE_CHANGED is fired on each occasion the state is updated
and changed, opposite of EVENT_STATE_REPORTED.
""" """
if not (entity_ids := _async_string_to_lower_list(entity_ids)): if not (entity_ids := _async_string_to_lower_list(entity_ids)):
return _remove_empty_listener return _remove_empty_listener
@ -383,7 +387,10 @@ def _async_track_state_change_event(
action: Callable[[Event[EventStateChangedData]], Any], action: Callable[[Event[EventStateChangedData]], Any],
job_type: HassJobType | None, job_type: HassJobType | None,
) -> CALLBACK_TYPE: ) -> CALLBACK_TYPE:
"""async_track_state_change_event without lowercasing.""" """Faster version of async_track_state_change_event.
The passed in entity_ids will not be automatically lower cased.
"""
return _async_track_event( return _async_track_event(
_KEYED_TRACK_STATE_CHANGE, hass, entity_ids, action, job_type _KEYED_TRACK_STATE_CHANGE, hass, entity_ids, action, job_type
) )
@ -403,7 +410,11 @@ def async_track_state_report_event(
action: Callable[[Event[EventStateReportedData]], Any], action: Callable[[Event[EventStateReportedData]], Any],
job_type: HassJobType | None = None, job_type: HassJobType | None = None,
) -> CALLBACK_TYPE: ) -> CALLBACK_TYPE:
"""Track EVENT_STATE_REPORTED by entity_id without lowercasing.""" """Track EVENT_STATE_REPORTED by entity_ids.
EVENT_STATE_REPORTED is fired on each occasion the state is updated
but not changed, opposite of EVENT_STATE_CHANGED.
"""
return _async_track_event( return _async_track_event(
_KEYED_TRACK_STATE_REPORT, hass, entity_ids, action, job_type _KEYED_TRACK_STATE_REPORT, hass, entity_ids, action, job_type
) )