From c01b1eb0138fed10270a708ace2baf144a66c712 Mon Sep 17 00:00:00 2001 From: epenet <6771947+epenet@users.noreply.github.com> Date: Wed, 5 Apr 2023 16:58:02 +0200 Subject: [PATCH] Adjust async_track_time_interval name argument (#90838) Adjust async_track_time_interval naming --- homeassistant/components/analytics/__init__.py | 2 +- homeassistant/components/august/subscriber.py | 5 ++++- homeassistant/components/bluetooth/base_scanner.py | 4 ++-- homeassistant/components/bluetooth/manager.py | 2 +- homeassistant/components/bond/entity.py | 2 +- homeassistant/components/camera/__init__.py | 2 +- homeassistant/components/device_tracker/legacy.py | 2 +- homeassistant/components/dhcp/__init__.py | 5 ++++- homeassistant/components/homekit_controller/connection.py | 5 +++-- homeassistant/components/recorder/core.py | 6 +++--- homeassistant/components/ssdp/__init__.py | 2 +- homeassistant/helpers/entity_platform.py | 2 +- homeassistant/helpers/event.py | 1 + homeassistant/helpers/restore_state.py | 2 +- tests/helpers/test_event.py | 2 +- 15 files changed, 26 insertions(+), 18 deletions(-) diff --git a/homeassistant/components/analytics/__init__.py b/homeassistant/components/analytics/__init__.py index 7bf55480eb1..2542ed5177e 100644 --- a/homeassistant/components/analytics/__init__.py +++ b/homeassistant/components/analytics/__init__.py @@ -28,7 +28,7 @@ async def async_setup(hass: HomeAssistant, _: ConfigType) -> bool: # Send every day async_track_time_interval( - hass, analytics.send_analytics, INTERVAL, "analytics daily" + hass, analytics.send_analytics, INTERVAL, name="analytics daily" ) hass.bus.async_listen_once(EVENT_HOMEASSISTANT_STARTED, start_schedule) diff --git a/homeassistant/components/august/subscriber.py b/homeassistant/components/august/subscriber.py index e0982fe9fb2..62aef44a9ee 100644 --- a/homeassistant/components/august/subscriber.py +++ b/homeassistant/components/august/subscriber.py @@ -38,7 +38,10 @@ class AugustSubscriberMixin: def _async_setup_listeners(self): """Create interval and stop listeners.""" self._unsub_interval = async_track_time_interval( - self._hass, self._async_refresh, self._update_interval, "august refresh" + self._hass, + self._async_refresh, + self._update_interval, + name="august refresh", ) @callback diff --git a/homeassistant/components/bluetooth/base_scanner.py b/homeassistant/components/bluetooth/base_scanner.py index 97b2aebba7a..d5e2ca0edbb 100644 --- a/homeassistant/components/bluetooth/base_scanner.py +++ b/homeassistant/components/bluetooth/base_scanner.py @@ -101,7 +101,7 @@ class BaseHaScanner(ABC): self.hass, self._async_scanner_watchdog, SCANNER_WATCHDOG_INTERVAL, - f"{self.name} Bluetooth scanner watchdog", + name=f"{self.name} Bluetooth scanner watchdog", ) @hass_callback @@ -230,7 +230,7 @@ class BaseHaRemoteScanner(BaseHaScanner): self.hass, self._async_expire_devices, timedelta(seconds=30), - f"{self.name} Bluetooth scanner device expire", + name=f"{self.name} Bluetooth scanner device expire", ) cancel_stop = self.hass.bus.async_listen( EVENT_HOMEASSISTANT_STOP, self._async_save_history diff --git a/homeassistant/components/bluetooth/manager.py b/homeassistant/components/bluetooth/manager.py index 7932520b454..75809f42e6c 100644 --- a/homeassistant/components/bluetooth/manager.py +++ b/homeassistant/components/bluetooth/manager.py @@ -276,7 +276,7 @@ class BluetoothManager: self.hass, self._async_check_unavailable, timedelta(seconds=UNAVAILABLE_TRACK_SECONDS), - "Bluetooth manager unavailable tracking", + name="Bluetooth manager unavailable tracking", ) @hass_callback diff --git a/homeassistant/components/bond/entity.py b/homeassistant/components/bond/entity.py index d00646d6ff4..4e3218ba041 100644 --- a/homeassistant/components/bond/entity.py +++ b/homeassistant/components/bond/entity.py @@ -177,7 +177,7 @@ class BondEntity(Entity): self.hass, self._async_update_if_bpup_not_alive, _FALLBACK_SCAN_INTERVAL, - f"Bond {self.entity_id} fallback polling", + name=f"Bond {self.entity_id} fallback polling", ) ) diff --git a/homeassistant/components/camera/__init__.py b/homeassistant/components/camera/__init__.py index 673009268c1..b1e4768a0a7 100644 --- a/homeassistant/components/camera/__init__.py +++ b/homeassistant/components/camera/__init__.py @@ -380,7 +380,7 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: entity.async_write_ha_state() unsub = async_track_time_interval( - hass, update_tokens, TOKEN_CHANGE_INTERVAL, "Camera update tokens" + hass, update_tokens, TOKEN_CHANGE_INTERVAL, name="Camera update tokens" ) @callback diff --git a/homeassistant/components/device_tracker/legacy.py b/homeassistant/components/device_tracker/legacy.py index da02cb1d044..8871a5d0eaf 100644 --- a/homeassistant/components/device_tracker/legacy.py +++ b/homeassistant/components/device_tracker/legacy.py @@ -475,7 +475,7 @@ def async_setup_scanner_platform( hass, async_device_tracker_scan, interval, - f"device_tracker {platform} legacy scan", + name=f"device_tracker {platform} legacy scan", ) hass.async_create_task(async_device_tracker_scan(None)) diff --git a/homeassistant/components/dhcp/__init__.py b/homeassistant/components/dhcp/__init__.py index 81fd69f8ffe..7f41d2c1d3d 100644 --- a/homeassistant/components/dhcp/__init__.py +++ b/homeassistant/components/dhcp/__init__.py @@ -260,7 +260,10 @@ class NetworkWatcher(WatcherBase): """Start scanning for new devices on the network.""" self._discover_hosts = DiscoverHosts() self._unsub = async_track_time_interval( - self.hass, self.async_start_discover, SCAN_INTERVAL, "DHCP network watcher" + self.hass, + self.async_start_discover, + SCAN_INTERVAL, + name="DHCP network watcher", ) self.async_start_discover() diff --git a/homeassistant/components/homekit_controller/connection.py b/homeassistant/components/homekit_controller/connection.py index 9e56c7c24ee..db85dbda3d5 100644 --- a/homeassistant/components/homekit_controller/connection.py +++ b/homeassistant/components/homekit_controller/connection.py @@ -272,7 +272,8 @@ class HKDevice: self.hass, self.async_update_available_state, timedelta(seconds=BLE_AVAILABILITY_CHECK_INTERVAL), - f"HomeKit Controller {self.unique_id} BLE availability check poll", + name=f"HomeKit Controller {self.unique_id} BLE availability " + "check poll", ) ) # BLE devices always get an RSSI sensor as well @@ -290,7 +291,7 @@ class HKDevice: self.hass, self.async_request_update, self.pairing.poll_interval, - f"HomeKit Controller {self.unique_id} availability check poll", + name=f"HomeKit Controller {self.unique_id} availability check poll", ) ) diff --git a/homeassistant/components/recorder/core.py b/homeassistant/components/recorder/core.py index fbc929b17d1..68b634d7235 100644 --- a/homeassistant/components/recorder/core.py +++ b/homeassistant/components/recorder/core.py @@ -299,7 +299,7 @@ class Recorder(threading.Thread): self.hass, self._async_check_queue, timedelta(minutes=10), - "Recorder queue watcher", + name="Recorder queue watcher", ) @callback @@ -602,7 +602,7 @@ class Recorder(threading.Thread): self.hass, self._async_keep_alive, timedelta(seconds=KEEPALIVE_TIME), - "Recorder keep alive", + name="Recorder keep alive", ) # If the commit interval is not 0, we need to commit periodically @@ -611,7 +611,7 @@ class Recorder(threading.Thread): self.hass, self._async_commit, timedelta(seconds=self.commit_interval), - "Recorder commit", + name="Recorder commit", ) # Run nightly tasks at 4:12am diff --git a/homeassistant/components/ssdp/__init__.py b/homeassistant/components/ssdp/__init__.py index 18d466099d0..570e79e4993 100644 --- a/homeassistant/components/ssdp/__init__.py +++ b/homeassistant/components/ssdp/__init__.py @@ -379,7 +379,7 @@ class Scanner: self.hass.bus.async_listen_once(EVENT_HOMEASSISTANT_STOP, self.async_stop) self._cancel_scan = async_track_time_interval( - self.hass, self.async_scan, SCAN_INTERVAL, "SSDP scanner" + self.hass, self.async_scan, SCAN_INTERVAL, name="SSDP scanner" ) # Trigger the initial-scan. diff --git a/homeassistant/helpers/entity_platform.py b/homeassistant/helpers/entity_platform.py index 7b7b809404f..0f93dca6939 100644 --- a/homeassistant/helpers/entity_platform.py +++ b/homeassistant/helpers/entity_platform.py @@ -479,7 +479,7 @@ class EntityPlatform: self.hass, self._update_entity_states, self.scan_interval, - f"EntityPlatform poll {self.domain}.{self.platform_name}", + name=f"EntityPlatform poll {self.domain}.{self.platform_name}", ) def _entity_id_already_exists(self, entity_id: str) -> tuple[bool, bool]: diff --git a/homeassistant/helpers/event.py b/homeassistant/helpers/event.py index a456e12fa13..44a9cb087e3 100644 --- a/homeassistant/helpers/event.py +++ b/homeassistant/helpers/event.py @@ -1397,6 +1397,7 @@ def async_track_time_interval( hass: HomeAssistant, action: Callable[[datetime], Coroutine[Any, Any, None] | None], interval: timedelta, + *, name: str | None = None, ) -> CALLBACK_TYPE: """Add a listener that fires repetitively at every timedelta interval.""" diff --git a/homeassistant/helpers/restore_state.py b/homeassistant/helpers/restore_state.py index e35a66ada8d..d31c12d0fd5 100644 --- a/homeassistant/helpers/restore_state.py +++ b/homeassistant/helpers/restore_state.py @@ -219,7 +219,7 @@ class RestoreStateData: self.hass, _async_dump_states, STATE_DUMP_INTERVAL, - "RestoreStateData dump states", + name="RestoreStateData dump states", ) async def _async_dump_states_at_stop(*_: Any) -> None: diff --git a/tests/helpers/test_event.py b/tests/helpers/test_event.py index a482e1b63b5..2f08f6e95cc 100644 --- a/tests/helpers/test_event.py +++ b/tests/helpers/test_event.py @@ -3452,7 +3452,7 @@ async def test_track_time_interval_name(hass: HomeAssistant) -> None: hass, callback(lambda x: specific_runs.append(x)), timedelta(seconds=10), - unique_string, + name=unique_string, ) scheduled = getattr(hass.loop, "_scheduled") assert any(handle for handle in scheduled if unique_string in str(handle))