From 1933454b76249bf6b9ba971e7acc0244f18b5a69 Mon Sep 17 00:00:00 2001 From: Erik Montnemery Date: Thu, 27 Jun 2024 13:45:15 +0200 Subject: [PATCH] Rename async_track_state_reported_event to async_track_state_report_event (#120637) * Rename async_track_state_reported_event to async_track_state_report_event * Update tests --- homeassistant/components/integration/sensor.py | 4 ++-- homeassistant/helpers/event.py | 12 ++++++------ tests/helpers/test_event.py | 8 ++++---- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/homeassistant/components/integration/sensor.py b/homeassistant/components/integration/sensor.py index 8cc5341f081..a053e5cea5c 100644 --- a/homeassistant/components/integration/sensor.py +++ b/homeassistant/components/integration/sensor.py @@ -46,7 +46,7 @@ from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.helpers.event import ( async_call_later, async_track_state_change_event, - async_track_state_reported_event, + async_track_state_report_event, ) from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType @@ -449,7 +449,7 @@ class IntegrationSensor(RestoreSensor): ) ) self.async_on_remove( - async_track_state_reported_event( + async_track_state_report_event( self.hass, self._sensor_source_id, handle_state_report, diff --git a/homeassistant/helpers/event.py b/homeassistant/helpers/event.py index ebd51948e3b..51c1a7ba30f 100644 --- a/homeassistant/helpers/event.py +++ b/homeassistant/helpers/event.py @@ -59,8 +59,8 @@ from .typing import TemplateVarsType _TRACK_STATE_CHANGE_DATA: HassKey[_KeyedEventData[EventStateChangedData]] = HassKey( "track_state_change_data" ) -_TRACK_STATE_REPORTED_DATA: HassKey[_KeyedEventData[EventStateReportedData]] = HassKey( - "track_state_reported_data" +_TRACK_STATE_REPORT_DATA: HassKey[_KeyedEventData[EventStateReportedData]] = HassKey( + "track_state_report_data" ) _TRACK_STATE_ADDED_DOMAIN_DATA: HassKey[_KeyedEventData[EventStateChangedData]] = ( HassKey("track_state_added_domain_data") @@ -377,15 +377,15 @@ def _async_track_state_change_event( ) -_KEYED_TRACK_STATE_REPORTED = _KeyedEventTracker( - key=_TRACK_STATE_REPORTED_DATA, +_KEYED_TRACK_STATE_REPORT = _KeyedEventTracker( + key=_TRACK_STATE_REPORT_DATA, event_type=EVENT_STATE_REPORTED, dispatcher_callable=_async_dispatch_entity_id_event, filter_callable=_async_state_filter, ) -def async_track_state_reported_event( +def async_track_state_report_event( hass: HomeAssistant, entity_ids: str | Iterable[str], action: Callable[[Event[EventStateReportedData]], Any], @@ -393,7 +393,7 @@ def async_track_state_reported_event( ) -> CALLBACK_TYPE: """Track EVENT_STATE_REPORTED by entity_id without lowercasing.""" return _async_track_event( - _KEYED_TRACK_STATE_REPORTED, hass, entity_ids, action, job_type + _KEYED_TRACK_STATE_REPORT, hass, entity_ids, action, job_type ) diff --git a/tests/helpers/test_event.py b/tests/helpers/test_event.py index 4f983120e36..4bb4c1a1967 100644 --- a/tests/helpers/test_event.py +++ b/tests/helpers/test_event.py @@ -40,7 +40,7 @@ from homeassistant.helpers.event import ( async_track_state_change_event, async_track_state_change_filtered, async_track_state_removed_domain, - async_track_state_reported_event, + async_track_state_report_event, async_track_sunrise, async_track_sunset, async_track_template, @@ -4916,8 +4916,8 @@ async def test_track_point_in_time_repr( await hass.async_block_till_done(wait_background_tasks=True) -async def test_async_track_state_reported_event(hass: HomeAssistant) -> None: - """Test async_track_state_reported_event.""" +async def test_async_track_state_report_event(hass: HomeAssistant) -> None: + """Test async_track_state_report_event.""" tracker_called: list[ha.State] = [] @ha.callback @@ -4925,7 +4925,7 @@ async def test_async_track_state_reported_event(hass: HomeAssistant) -> None: new_state = event.data["new_state"] tracker_called.append(new_state) - unsub = async_track_state_reported_event( + unsub = async_track_state_report_event( hass, ["light.bowl", "light.top"], single_run_callback ) hass.states.async_set("light.bowl", "on")