From 3b4eb7c7493c60f22d9c0f63a2fadc81cb4ea956 Mon Sep 17 00:00:00 2001 From: epenet <6771947+epenet@users.noreply.github.com> Date: Mon, 23 Jun 2025 13:15:08 +0200 Subject: [PATCH] Migrate lametric to use runtime_data (#147328) * Migrate lametric to use runtime_data * One more * Drop unused hass_config --- homeassistant/components/lametric/__init__.py | 14 ++++++-------- homeassistant/components/lametric/button.py | 8 +++----- homeassistant/components/lametric/coordinator.py | 6 ++++-- homeassistant/components/lametric/diagnostics.py | 8 +++----- homeassistant/components/lametric/helpers.py | 16 +++++----------- homeassistant/components/lametric/notify.py | 14 ++++++++------ homeassistant/components/lametric/number.py | 8 +++----- .../components/lametric/quality_scale.yaml | 3 ++- homeassistant/components/lametric/select.py | 8 +++----- homeassistant/components/lametric/sensor.py | 8 +++----- homeassistant/components/lametric/switch.py | 8 +++----- 11 files changed, 43 insertions(+), 58 deletions(-) diff --git a/homeassistant/components/lametric/__init__.py b/homeassistant/components/lametric/__init__.py index 89659fbd2c0..efc784354e1 100644 --- a/homeassistant/components/lametric/__init__.py +++ b/homeassistant/components/lametric/__init__.py @@ -1,14 +1,13 @@ """Support for LaMetric time.""" from homeassistant.components import notify as hass_notify -from homeassistant.config_entries import ConfigEntry from homeassistant.const import CONF_NAME, Platform from homeassistant.core import HomeAssistant from homeassistant.helpers import config_validation as cv, discovery from homeassistant.helpers.typing import ConfigType from .const import DOMAIN, PLATFORMS -from .coordinator import LaMetricDataUpdateCoordinator +from .coordinator import LaMetricConfigEntry, LaMetricDataUpdateCoordinator from .services import async_setup_services CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN) @@ -17,16 +16,16 @@ CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN) async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: """Set up the LaMetric integration.""" async_setup_services(hass) - hass.data[DOMAIN] = {"hass_config": config} + return True -async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool: +async def async_setup_entry(hass: HomeAssistant, entry: LaMetricConfigEntry) -> bool: """Set up LaMetric from a config entry.""" coordinator = LaMetricDataUpdateCoordinator(hass, entry) await coordinator.async_config_entry_first_refresh() - hass.data[DOMAIN][entry.entry_id] = coordinator + entry.runtime_data = coordinator await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS) # Set up notify platform, no entry support for notify component yet, @@ -37,15 +36,14 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool: Platform.NOTIFY, DOMAIN, {CONF_NAME: coordinator.data.name, "entry_id": entry.entry_id}, - hass.data[DOMAIN]["hass_config"], + {}, ) ) return True -async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool: +async def async_unload_entry(hass: HomeAssistant, entry: LaMetricConfigEntry) -> bool: """Unload LaMetric config entry.""" if unload_ok := await hass.config_entries.async_unload_platforms(entry, PLATFORMS): - del hass.data[DOMAIN][entry.entry_id] await hass_notify.async_reload(hass, DOMAIN) return unload_ok diff --git a/homeassistant/components/lametric/button.py b/homeassistant/components/lametric/button.py index 3c7d754fa0b..7b141665a4f 100644 --- a/homeassistant/components/lametric/button.py +++ b/homeassistant/components/lametric/button.py @@ -9,13 +9,11 @@ from typing import Any from demetriek import LaMetricDevice from homeassistant.components.button import ButtonEntity, ButtonEntityDescription -from homeassistant.config_entries import ConfigEntry from homeassistant.const import EntityCategory from homeassistant.core import HomeAssistant from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback -from .const import DOMAIN -from .coordinator import LaMetricDataUpdateCoordinator +from .coordinator import LaMetricConfigEntry, LaMetricDataUpdateCoordinator from .entity import LaMetricEntity from .helpers import lametric_exception_handler @@ -57,11 +55,11 @@ BUTTONS = [ async def async_setup_entry( hass: HomeAssistant, - entry: ConfigEntry, + entry: LaMetricConfigEntry, async_add_entities: AddConfigEntryEntitiesCallback, ) -> None: """Set up LaMetric button based on a config entry.""" - coordinator: LaMetricDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id] + coordinator = entry.runtime_data async_add_entities( LaMetricButtonEntity( coordinator=coordinator, diff --git a/homeassistant/components/lametric/coordinator.py b/homeassistant/components/lametric/coordinator.py index c292b2971b6..54301506366 100644 --- a/homeassistant/components/lametric/coordinator.py +++ b/homeassistant/components/lametric/coordinator.py @@ -13,13 +13,15 @@ from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, Upda from .const import DOMAIN, LOGGER, SCAN_INTERVAL +type LaMetricConfigEntry = ConfigEntry[LaMetricDataUpdateCoordinator] + class LaMetricDataUpdateCoordinator(DataUpdateCoordinator[Device]): """The LaMetric Data Update Coordinator.""" - config_entry: ConfigEntry + config_entry: LaMetricConfigEntry - def __init__(self, hass: HomeAssistant, entry: ConfigEntry) -> None: + def __init__(self, hass: HomeAssistant, entry: LaMetricConfigEntry) -> None: """Initialize the LaMatric coordinator.""" self.lametric = LaMetricDevice( host=entry.data[CONF_HOST], diff --git a/homeassistant/components/lametric/diagnostics.py b/homeassistant/components/lametric/diagnostics.py index c14ed998ace..9df72ee40fa 100644 --- a/homeassistant/components/lametric/diagnostics.py +++ b/homeassistant/components/lametric/diagnostics.py @@ -6,11 +6,9 @@ import json from typing import Any from homeassistant.components.diagnostics import async_redact_data -from homeassistant.config_entries import ConfigEntry from homeassistant.core import HomeAssistant -from .const import DOMAIN -from .coordinator import LaMetricDataUpdateCoordinator +from .coordinator import LaMetricConfigEntry TO_REDACT = { "device_id", @@ -21,10 +19,10 @@ TO_REDACT = { async def async_get_config_entry_diagnostics( - hass: HomeAssistant, entry: ConfigEntry + hass: HomeAssistant, entry: LaMetricConfigEntry ) -> dict[str, Any]: """Return diagnostics for a config entry.""" - coordinator: LaMetricDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id] + coordinator = entry.runtime_data # Round-trip via JSON to trigger serialization data = json.loads(coordinator.data.to_json()) return async_redact_data(data, TO_REDACT) diff --git a/homeassistant/components/lametric/helpers.py b/homeassistant/components/lametric/helpers.py index 8620b0c7cd9..55b5ef1bb8b 100644 --- a/homeassistant/components/lametric/helpers.py +++ b/homeassistant/components/lametric/helpers.py @@ -12,7 +12,7 @@ from homeassistant.exceptions import HomeAssistantError from homeassistant.helpers import device_registry as dr from .const import DOMAIN -from .coordinator import LaMetricDataUpdateCoordinator +from .coordinator import LaMetricConfigEntry, LaMetricDataUpdateCoordinator from .entity import LaMetricEntity @@ -57,15 +57,9 @@ def async_get_coordinator_by_device_id( if (device_entry := device_registry.async_get(device_id)) is None: raise ValueError(f"Unknown LaMetric device ID: {device_id}") - for entry_id in device_entry.config_entries: - if ( - (entry := hass.config_entries.async_get_entry(entry_id)) - and entry.domain == DOMAIN - and entry.entry_id in hass.data[DOMAIN] - ): - coordinator: LaMetricDataUpdateCoordinator = hass.data[DOMAIN][ - entry.entry_id - ] - return coordinator + entry: LaMetricConfigEntry + for entry in hass.config_entries.async_loaded_entries(DOMAIN): + if entry.entry_id in device_entry.config_entries: + return entry.runtime_data raise ValueError(f"No coordinator for device ID: {device_id}") diff --git a/homeassistant/components/lametric/notify.py b/homeassistant/components/lametric/notify.py index 195924e2da5..db453d2fc20 100644 --- a/homeassistant/components/lametric/notify.py +++ b/homeassistant/components/lametric/notify.py @@ -2,7 +2,7 @@ from __future__ import annotations -from typing import Any +from typing import TYPE_CHECKING, Any from demetriek import ( AlarmSound, @@ -24,8 +24,8 @@ from homeassistant.exceptions import HomeAssistantError, ServiceValidationError from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType from homeassistant.util.enum import try_parse_enum -from .const import CONF_CYCLES, CONF_ICON_TYPE, CONF_PRIORITY, CONF_SOUND, DOMAIN -from .coordinator import LaMetricDataUpdateCoordinator +from .const import CONF_CYCLES, CONF_ICON_TYPE, CONF_PRIORITY, CONF_SOUND +from .coordinator import LaMetricConfigEntry async def async_get_service( @@ -36,10 +36,12 @@ async def async_get_service( """Get the LaMetric notification service.""" if discovery_info is None: return None - coordinator: LaMetricDataUpdateCoordinator = hass.data[DOMAIN][ + entry: LaMetricConfigEntry | None = hass.config_entries.async_get_entry( discovery_info["entry_id"] - ] - return LaMetricNotificationService(coordinator.lametric) + ) + if TYPE_CHECKING: + assert entry is not None + return LaMetricNotificationService(entry.runtime_data.lametric) class LaMetricNotificationService(BaseNotificationService): diff --git a/homeassistant/components/lametric/number.py b/homeassistant/components/lametric/number.py index 7f356741d76..acd196d4b34 100644 --- a/homeassistant/components/lametric/number.py +++ b/homeassistant/components/lametric/number.py @@ -9,13 +9,11 @@ from typing import Any from demetriek import Device, LaMetricDevice, Range from homeassistant.components.number import NumberEntity, NumberEntityDescription -from homeassistant.config_entries import ConfigEntry from homeassistant.const import PERCENTAGE, EntityCategory from homeassistant.core import HomeAssistant from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback -from .const import DOMAIN -from .coordinator import LaMetricDataUpdateCoordinator +from .coordinator import LaMetricConfigEntry, LaMetricDataUpdateCoordinator from .entity import LaMetricEntity from .helpers import lametric_exception_handler @@ -57,11 +55,11 @@ NUMBERS = [ async def async_setup_entry( hass: HomeAssistant, - entry: ConfigEntry, + entry: LaMetricConfigEntry, async_add_entities: AddConfigEntryEntitiesCallback, ) -> None: """Set up LaMetric number based on a config entry.""" - coordinator: LaMetricDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id] + coordinator = entry.runtime_data async_add_entities( LaMetricNumberEntity( coordinator=coordinator, diff --git a/homeassistant/components/lametric/quality_scale.yaml b/homeassistant/components/lametric/quality_scale.yaml index a8982bb938b..a01115bab3e 100644 --- a/homeassistant/components/lametric/quality_scale.yaml +++ b/homeassistant/components/lametric/quality_scale.yaml @@ -17,7 +17,7 @@ rules: Entities of this integration does not explicitly subscribe to events. entity-unique-id: done has-entity-name: done - runtime-data: todo + runtime-data: done test-before-configure: done test-before-setup: done unique-config-entry: done @@ -33,6 +33,7 @@ rules: parallel-updates: todo reauthentication-flow: done test-coverage: done + # Gold devices: done diagnostics: done diff --git a/homeassistant/components/lametric/select.py b/homeassistant/components/lametric/select.py index eab7cd5997c..993ec7c909a 100644 --- a/homeassistant/components/lametric/select.py +++ b/homeassistant/components/lametric/select.py @@ -9,13 +9,11 @@ from typing import Any from demetriek import BrightnessMode, Device, LaMetricDevice from homeassistant.components.select import SelectEntity, SelectEntityDescription -from homeassistant.config_entries import ConfigEntry from homeassistant.const import EntityCategory from homeassistant.core import HomeAssistant from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback -from .const import DOMAIN -from .coordinator import LaMetricDataUpdateCoordinator +from .coordinator import LaMetricConfigEntry, LaMetricDataUpdateCoordinator from .entity import LaMetricEntity from .helpers import lametric_exception_handler @@ -42,11 +40,11 @@ SELECTS = [ async def async_setup_entry( hass: HomeAssistant, - entry: ConfigEntry, + entry: LaMetricConfigEntry, async_add_entities: AddConfigEntryEntitiesCallback, ) -> None: """Set up LaMetric select based on a config entry.""" - coordinator: LaMetricDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id] + coordinator = entry.runtime_data async_add_entities( LaMetricSelectEntity( coordinator=coordinator, diff --git a/homeassistant/components/lametric/sensor.py b/homeassistant/components/lametric/sensor.py index a5d5da3c046..309c8093204 100644 --- a/homeassistant/components/lametric/sensor.py +++ b/homeassistant/components/lametric/sensor.py @@ -12,13 +12,11 @@ from homeassistant.components.sensor import ( SensorEntityDescription, SensorStateClass, ) -from homeassistant.config_entries import ConfigEntry from homeassistant.const import PERCENTAGE, EntityCategory from homeassistant.core import HomeAssistant from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback -from .const import DOMAIN -from .coordinator import LaMetricDataUpdateCoordinator +from .coordinator import LaMetricConfigEntry, LaMetricDataUpdateCoordinator from .entity import LaMetricEntity @@ -44,11 +42,11 @@ SENSORS = [ async def async_setup_entry( hass: HomeAssistant, - entry: ConfigEntry, + entry: LaMetricConfigEntry, async_add_entities: AddConfigEntryEntitiesCallback, ) -> None: """Set up LaMetric sensor based on a config entry.""" - coordinator: LaMetricDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id] + coordinator = entry.runtime_data async_add_entities( LaMetricSensorEntity( coordinator=coordinator, diff --git a/homeassistant/components/lametric/switch.py b/homeassistant/components/lametric/switch.py index 85e61164639..8e4fb611d3e 100644 --- a/homeassistant/components/lametric/switch.py +++ b/homeassistant/components/lametric/switch.py @@ -9,13 +9,11 @@ from typing import Any from demetriek import Device, LaMetricDevice from homeassistant.components.switch import SwitchEntity, SwitchEntityDescription -from homeassistant.config_entries import ConfigEntry from homeassistant.const import EntityCategory from homeassistant.core import HomeAssistant from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback -from .const import DOMAIN -from .coordinator import LaMetricDataUpdateCoordinator +from .coordinator import LaMetricConfigEntry, LaMetricDataUpdateCoordinator from .entity import LaMetricEntity from .helpers import lametric_exception_handler @@ -47,11 +45,11 @@ SWITCHES = [ async def async_setup_entry( hass: HomeAssistant, - entry: ConfigEntry, + entry: LaMetricConfigEntry, async_add_entities: AddConfigEntryEntitiesCallback, ) -> None: """Set up LaMetric switch based on a config entry.""" - coordinator: LaMetricDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id] + coordinator = entry.runtime_data async_add_entities( LaMetricSwitchEntity( coordinator=coordinator,