From 41532ed509508134d36e49ba3be82d87a592a6b5 Mon Sep 17 00:00:00 2001 From: Michael <35783820+mib1185@users.noreply.github.com> Date: Sun, 9 Feb 2025 16:30:41 +0100 Subject: [PATCH] Explicitly pass in the config_entry in nam coordinator (#138076) explicitly pass in the config_entry in coordinator --- homeassistant/components/nam/__init__.py | 11 ++--------- homeassistant/components/nam/button.py | 2 +- homeassistant/components/nam/coordinator.py | 22 +++++++++++++++++---- homeassistant/components/nam/diagnostics.py | 2 +- homeassistant/components/nam/sensor.py | 2 +- 5 files changed, 23 insertions(+), 16 deletions(-) diff --git a/homeassistant/components/nam/__init__.py b/homeassistant/components/nam/__init__.py index 624415adb12..6b4ca6ff324 100644 --- a/homeassistant/components/nam/__init__.py +++ b/homeassistant/components/nam/__init__.py @@ -3,7 +3,6 @@ from __future__ import annotations import logging -from typing import TYPE_CHECKING from aiohttp.client_exceptions import ClientConnectorError, ClientError from nettigo_air_monitor import ( @@ -14,7 +13,6 @@ from nettigo_air_monitor import ( ) from homeassistant.components.air_quality import DOMAIN as AIR_QUALITY_PLATFORM -from homeassistant.config_entries import ConfigEntry from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME, Platform from homeassistant.core import HomeAssistant from homeassistant.exceptions import ConfigEntryAuthFailed, ConfigEntryNotReady @@ -22,14 +20,12 @@ from homeassistant.helpers import entity_registry as er from homeassistant.helpers.aiohttp_client import async_get_clientsession from .const import ATTR_SDS011, ATTR_SPS30, DOMAIN -from .coordinator import NAMDataUpdateCoordinator +from .coordinator import NAMConfigEntry, NAMDataUpdateCoordinator _LOGGER = logging.getLogger(__name__) PLATFORMS = [Platform.BUTTON, Platform.SENSOR] -type NAMConfigEntry = ConfigEntry[NAMDataUpdateCoordinator] - async def async_setup_entry(hass: HomeAssistant, entry: NAMConfigEntry) -> bool: """Set up Nettigo as config entry.""" @@ -52,10 +48,7 @@ async def async_setup_entry(hass: HomeAssistant, entry: NAMConfigEntry) -> bool: except AuthFailedError as err: raise ConfigEntryAuthFailed from err - if TYPE_CHECKING: - assert entry.unique_id - - coordinator = NAMDataUpdateCoordinator(hass, nam, entry.unique_id) + coordinator = NAMDataUpdateCoordinator(hass, entry, nam) await coordinator.async_config_entry_first_refresh() entry.runtime_data = coordinator diff --git a/homeassistant/components/nam/button.py b/homeassistant/components/nam/button.py index 8ac56f3d70e..980201be28c 100644 --- a/homeassistant/components/nam/button.py +++ b/homeassistant/components/nam/button.py @@ -14,7 +14,7 @@ from homeassistant.core import HomeAssistant from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.helpers.update_coordinator import CoordinatorEntity -from . import NAMConfigEntry, NAMDataUpdateCoordinator +from .coordinator import NAMConfigEntry, NAMDataUpdateCoordinator PARALLEL_UPDATES = 1 diff --git a/homeassistant/components/nam/coordinator.py b/homeassistant/components/nam/coordinator.py index 5019f0e3a1d..3e2c9c24474 100644 --- a/homeassistant/components/nam/coordinator.py +++ b/homeassistant/components/nam/coordinator.py @@ -1,6 +1,7 @@ """The Nettigo Air Monitor coordinator.""" import logging +from typing import TYPE_CHECKING from nettigo_air_monitor import ( ApiError, @@ -10,6 +11,7 @@ from nettigo_air_monitor import ( ) from tenacity import RetryError +from homeassistant.config_entries import ConfigEntry from homeassistant.core import HomeAssistant from homeassistant.helpers.device_registry import CONNECTION_NETWORK_MAC, DeviceInfo from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed @@ -18,20 +20,28 @@ from .const import DEFAULT_UPDATE_INTERVAL, DOMAIN, MANUFACTURER _LOGGER = logging.getLogger(__name__) +type NAMConfigEntry = ConfigEntry[NAMDataUpdateCoordinator] + class NAMDataUpdateCoordinator(DataUpdateCoordinator[NAMSensors]): """Class to manage fetching Nettigo Air Monitor data.""" + config_entry: NAMConfigEntry + def __init__( self, hass: HomeAssistant, + config_entry: NAMConfigEntry, nam: NettigoAirMonitor, - unique_id: str, ) -> None: """Initialize.""" - self.unique_id = unique_id + if TYPE_CHECKING: + assert config_entry.unique_id + + self.unique_id = config_entry.unique_id + self.device_info = DeviceInfo( - connections={(CONNECTION_NETWORK_MAC, unique_id)}, + connections={(CONNECTION_NETWORK_MAC, self.unique_id)}, name="Nettigo Air Monitor", sw_version=nam.software_version, manufacturer=MANUFACTURER, @@ -40,7 +50,11 @@ class NAMDataUpdateCoordinator(DataUpdateCoordinator[NAMSensors]): self.nam = nam super().__init__( - hass, _LOGGER, name=DOMAIN, update_interval=DEFAULT_UPDATE_INTERVAL + hass, + _LOGGER, + config_entry=config_entry, + name=DOMAIN, + update_interval=DEFAULT_UPDATE_INTERVAL, ) async def _async_update_data(self) -> NAMSensors: diff --git a/homeassistant/components/nam/diagnostics.py b/homeassistant/components/nam/diagnostics.py index d29eb40ced7..905c1669496 100644 --- a/homeassistant/components/nam/diagnostics.py +++ b/homeassistant/components/nam/diagnostics.py @@ -9,7 +9,7 @@ from homeassistant.components.diagnostics import async_redact_data from homeassistant.const import CONF_PASSWORD, CONF_USERNAME from homeassistant.core import HomeAssistant -from . import NAMConfigEntry +from .coordinator import NAMConfigEntry TO_REDACT = {CONF_PASSWORD, CONF_USERNAME} diff --git a/homeassistant/components/nam/sensor.py b/homeassistant/components/nam/sensor.py index 27fae62be8a..24080d1c3c1 100644 --- a/homeassistant/components/nam/sensor.py +++ b/homeassistant/components/nam/sensor.py @@ -32,7 +32,6 @@ from homeassistant.helpers.typing import StateType from homeassistant.helpers.update_coordinator import CoordinatorEntity from homeassistant.util.dt import utcnow -from . import NAMConfigEntry, NAMDataUpdateCoordinator from .const import ( ATTR_BME280_HUMIDITY, ATTR_BME280_PRESSURE, @@ -69,6 +68,7 @@ from .const import ( DOMAIN, MIGRATION_SENSORS, ) +from .coordinator import NAMConfigEntry, NAMDataUpdateCoordinator PARALLEL_UPDATES = 1