Explicitly pass in the config_entry in nam coordinator (#138076)

explicitly pass in the config_entry in coordinator
pull/137224/head
Michael 2025-02-09 16:30:41 +01:00 committed by GitHub
parent 3792888e9d
commit 41532ed509
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 23 additions and 16 deletions

View File

@ -3,7 +3,6 @@
from __future__ import annotations from __future__ import annotations
import logging import logging
from typing import TYPE_CHECKING
from aiohttp.client_exceptions import ClientConnectorError, ClientError from aiohttp.client_exceptions import ClientConnectorError, ClientError
from nettigo_air_monitor import ( 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.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.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME, Platform
from homeassistant.core import HomeAssistant from homeassistant.core import HomeAssistant
from homeassistant.exceptions import ConfigEntryAuthFailed, ConfigEntryNotReady 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 homeassistant.helpers.aiohttp_client import async_get_clientsession
from .const import ATTR_SDS011, ATTR_SPS30, DOMAIN from .const import ATTR_SDS011, ATTR_SPS30, DOMAIN
from .coordinator import NAMDataUpdateCoordinator from .coordinator import NAMConfigEntry, NAMDataUpdateCoordinator
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
PLATFORMS = [Platform.BUTTON, Platform.SENSOR] PLATFORMS = [Platform.BUTTON, Platform.SENSOR]
type NAMConfigEntry = ConfigEntry[NAMDataUpdateCoordinator]
async def async_setup_entry(hass: HomeAssistant, entry: NAMConfigEntry) -> bool: async def async_setup_entry(hass: HomeAssistant, entry: NAMConfigEntry) -> bool:
"""Set up Nettigo as config entry.""" """Set up Nettigo as config entry."""
@ -52,10 +48,7 @@ async def async_setup_entry(hass: HomeAssistant, entry: NAMConfigEntry) -> bool:
except AuthFailedError as err: except AuthFailedError as err:
raise ConfigEntryAuthFailed from err raise ConfigEntryAuthFailed from err
if TYPE_CHECKING: coordinator = NAMDataUpdateCoordinator(hass, entry, nam)
assert entry.unique_id
coordinator = NAMDataUpdateCoordinator(hass, nam, entry.unique_id)
await coordinator.async_config_entry_first_refresh() await coordinator.async_config_entry_first_refresh()
entry.runtime_data = coordinator entry.runtime_data = coordinator

View File

@ -14,7 +14,7 @@ from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import CoordinatorEntity from homeassistant.helpers.update_coordinator import CoordinatorEntity
from . import NAMConfigEntry, NAMDataUpdateCoordinator from .coordinator import NAMConfigEntry, NAMDataUpdateCoordinator
PARALLEL_UPDATES = 1 PARALLEL_UPDATES = 1

View File

@ -1,6 +1,7 @@
"""The Nettigo Air Monitor coordinator.""" """The Nettigo Air Monitor coordinator."""
import logging import logging
from typing import TYPE_CHECKING
from nettigo_air_monitor import ( from nettigo_air_monitor import (
ApiError, ApiError,
@ -10,6 +11,7 @@ from nettigo_air_monitor import (
) )
from tenacity import RetryError from tenacity import RetryError
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant from homeassistant.core import HomeAssistant
from homeassistant.helpers.device_registry import CONNECTION_NETWORK_MAC, DeviceInfo from homeassistant.helpers.device_registry import CONNECTION_NETWORK_MAC, DeviceInfo
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
@ -18,20 +20,28 @@ from .const import DEFAULT_UPDATE_INTERVAL, DOMAIN, MANUFACTURER
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
type NAMConfigEntry = ConfigEntry[NAMDataUpdateCoordinator]
class NAMDataUpdateCoordinator(DataUpdateCoordinator[NAMSensors]): class NAMDataUpdateCoordinator(DataUpdateCoordinator[NAMSensors]):
"""Class to manage fetching Nettigo Air Monitor data.""" """Class to manage fetching Nettigo Air Monitor data."""
config_entry: NAMConfigEntry
def __init__( def __init__(
self, self,
hass: HomeAssistant, hass: HomeAssistant,
config_entry: NAMConfigEntry,
nam: NettigoAirMonitor, nam: NettigoAirMonitor,
unique_id: str,
) -> None: ) -> None:
"""Initialize.""" """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( self.device_info = DeviceInfo(
connections={(CONNECTION_NETWORK_MAC, unique_id)}, connections={(CONNECTION_NETWORK_MAC, self.unique_id)},
name="Nettigo Air Monitor", name="Nettigo Air Monitor",
sw_version=nam.software_version, sw_version=nam.software_version,
manufacturer=MANUFACTURER, manufacturer=MANUFACTURER,
@ -40,7 +50,11 @@ class NAMDataUpdateCoordinator(DataUpdateCoordinator[NAMSensors]):
self.nam = nam self.nam = nam
super().__init__( 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: async def _async_update_data(self) -> NAMSensors:

View File

@ -9,7 +9,7 @@ from homeassistant.components.diagnostics import async_redact_data
from homeassistant.const import CONF_PASSWORD, CONF_USERNAME from homeassistant.const import CONF_PASSWORD, CONF_USERNAME
from homeassistant.core import HomeAssistant from homeassistant.core import HomeAssistant
from . import NAMConfigEntry from .coordinator import NAMConfigEntry
TO_REDACT = {CONF_PASSWORD, CONF_USERNAME} TO_REDACT = {CONF_PASSWORD, CONF_USERNAME}

View File

@ -32,7 +32,6 @@ from homeassistant.helpers.typing import StateType
from homeassistant.helpers.update_coordinator import CoordinatorEntity from homeassistant.helpers.update_coordinator import CoordinatorEntity
from homeassistant.util.dt import utcnow from homeassistant.util.dt import utcnow
from . import NAMConfigEntry, NAMDataUpdateCoordinator
from .const import ( from .const import (
ATTR_BME280_HUMIDITY, ATTR_BME280_HUMIDITY,
ATTR_BME280_PRESSURE, ATTR_BME280_PRESSURE,
@ -69,6 +68,7 @@ from .const import (
DOMAIN, DOMAIN,
MIGRATION_SENSORS, MIGRATION_SENSORS,
) )
from .coordinator import NAMConfigEntry, NAMDataUpdateCoordinator
PARALLEL_UPDATES = 1 PARALLEL_UPDATES = 1