Make the update interval a property of the NextDNS coordinator class (#148410)

This commit is contained in:
Maciej Bieniek 2025-07-08 16:14:02 +02:00 committed by GitHub
parent 546f6afac2
commit ae7bc14059
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 32 additions and 19 deletions

View File

@ -4,7 +4,6 @@ from __future__ import annotations
import asyncio import asyncio
from dataclasses import dataclass from dataclasses import dataclass
from datetime import timedelta
from aiohttp.client_exceptions import ClientConnectorError from aiohttp.client_exceptions import ClientConnectorError
from nextdns import ( from nextdns import (
@ -37,9 +36,6 @@ from .const import (
ATTR_STATUS, ATTR_STATUS,
CONF_PROFILE_ID, CONF_PROFILE_ID,
DOMAIN, DOMAIN,
UPDATE_INTERVAL_ANALYTICS,
UPDATE_INTERVAL_CONNECTION,
UPDATE_INTERVAL_SETTINGS,
) )
from .coordinator import ( from .coordinator import (
NextDnsConnectionUpdateCoordinator, NextDnsConnectionUpdateCoordinator,
@ -69,14 +65,14 @@ class NextDnsData:
PLATFORMS = [Platform.BINARY_SENSOR, Platform.BUTTON, Platform.SENSOR, Platform.SWITCH] PLATFORMS = [Platform.BINARY_SENSOR, Platform.BUTTON, Platform.SENSOR, Platform.SWITCH]
COORDINATORS: list[tuple[str, type[NextDnsUpdateCoordinator], timedelta]] = [ COORDINATORS: list[tuple[str, type[NextDnsUpdateCoordinator]]] = [
(ATTR_CONNECTION, NextDnsConnectionUpdateCoordinator, UPDATE_INTERVAL_CONNECTION), (ATTR_CONNECTION, NextDnsConnectionUpdateCoordinator),
(ATTR_DNSSEC, NextDnsDnssecUpdateCoordinator, UPDATE_INTERVAL_ANALYTICS), (ATTR_DNSSEC, NextDnsDnssecUpdateCoordinator),
(ATTR_ENCRYPTION, NextDnsEncryptionUpdateCoordinator, UPDATE_INTERVAL_ANALYTICS), (ATTR_ENCRYPTION, NextDnsEncryptionUpdateCoordinator),
(ATTR_IP_VERSIONS, NextDnsIpVersionsUpdateCoordinator, UPDATE_INTERVAL_ANALYTICS), (ATTR_IP_VERSIONS, NextDnsIpVersionsUpdateCoordinator),
(ATTR_PROTOCOLS, NextDnsProtocolsUpdateCoordinator, UPDATE_INTERVAL_ANALYTICS), (ATTR_PROTOCOLS, NextDnsProtocolsUpdateCoordinator),
(ATTR_SETTINGS, NextDnsSettingsUpdateCoordinator, UPDATE_INTERVAL_SETTINGS), (ATTR_SETTINGS, NextDnsSettingsUpdateCoordinator),
(ATTR_STATUS, NextDnsStatusUpdateCoordinator, UPDATE_INTERVAL_ANALYTICS), (ATTR_STATUS, NextDnsStatusUpdateCoordinator),
] ]
@ -109,10 +105,8 @@ async def async_setup_entry(hass: HomeAssistant, entry: NextDnsConfigEntry) -> b
# Independent DataUpdateCoordinator is used for each API endpoint to avoid # Independent DataUpdateCoordinator is used for each API endpoint to avoid
# unnecessary requests when entities using this endpoint are disabled. # unnecessary requests when entities using this endpoint are disabled.
for coordinator_name, coordinator_class, update_interval in COORDINATORS: for coordinator_name, coordinator_class in COORDINATORS:
coordinator = coordinator_class( coordinator = coordinator_class(hass, entry, nextdns, profile_id)
hass, entry, nextdns, profile_id, update_interval
)
tasks.append(coordinator.async_config_entry_first_refresh()) tasks.append(coordinator.async_config_entry_first_refresh())
coordinators[coordinator_name] = coordinator coordinators[coordinator_name] = coordinator

View File

@ -29,7 +29,12 @@ from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, Upda
if TYPE_CHECKING: if TYPE_CHECKING:
from . import NextDnsConfigEntry from . import NextDnsConfigEntry
from .const import DOMAIN from .const import (
DOMAIN,
UPDATE_INTERVAL_ANALYTICS,
UPDATE_INTERVAL_CONNECTION,
UPDATE_INTERVAL_SETTINGS,
)
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
@ -40,6 +45,7 @@ class NextDnsUpdateCoordinator[CoordinatorDataT: NextDnsData](
"""Class to manage fetching NextDNS data API.""" """Class to manage fetching NextDNS data API."""
config_entry: NextDnsConfigEntry config_entry: NextDnsConfigEntry
_update_interval: timedelta
def __init__( def __init__(
self, self,
@ -47,7 +53,6 @@ class NextDnsUpdateCoordinator[CoordinatorDataT: NextDnsData](
config_entry: NextDnsConfigEntry, config_entry: NextDnsConfigEntry,
nextdns: NextDns, nextdns: NextDns,
profile_id: str, profile_id: str,
update_interval: timedelta,
) -> None: ) -> None:
"""Initialize.""" """Initialize."""
self.nextdns = nextdns self.nextdns = nextdns
@ -58,7 +63,7 @@ class NextDnsUpdateCoordinator[CoordinatorDataT: NextDnsData](
_LOGGER, _LOGGER,
config_entry=config_entry, config_entry=config_entry,
name=DOMAIN, name=DOMAIN,
update_interval=update_interval, update_interval=self._update_interval,
) )
async def _async_update_data(self) -> CoordinatorDataT: async def _async_update_data(self) -> CoordinatorDataT:
@ -93,6 +98,8 @@ class NextDnsUpdateCoordinator[CoordinatorDataT: NextDnsData](
class NextDnsStatusUpdateCoordinator(NextDnsUpdateCoordinator[AnalyticsStatus]): class NextDnsStatusUpdateCoordinator(NextDnsUpdateCoordinator[AnalyticsStatus]):
"""Class to manage fetching NextDNS analytics status data from API.""" """Class to manage fetching NextDNS analytics status data from API."""
_update_interval = UPDATE_INTERVAL_ANALYTICS
async def _async_update_data_internal(self) -> AnalyticsStatus: async def _async_update_data_internal(self) -> AnalyticsStatus:
"""Update data via library.""" """Update data via library."""
return await self.nextdns.get_analytics_status(self.profile_id) return await self.nextdns.get_analytics_status(self.profile_id)
@ -101,6 +108,8 @@ class NextDnsStatusUpdateCoordinator(NextDnsUpdateCoordinator[AnalyticsStatus]):
class NextDnsDnssecUpdateCoordinator(NextDnsUpdateCoordinator[AnalyticsDnssec]): class NextDnsDnssecUpdateCoordinator(NextDnsUpdateCoordinator[AnalyticsDnssec]):
"""Class to manage fetching NextDNS analytics Dnssec data from API.""" """Class to manage fetching NextDNS analytics Dnssec data from API."""
_update_interval = UPDATE_INTERVAL_ANALYTICS
async def _async_update_data_internal(self) -> AnalyticsDnssec: async def _async_update_data_internal(self) -> AnalyticsDnssec:
"""Update data via library.""" """Update data via library."""
return await self.nextdns.get_analytics_dnssec(self.profile_id) return await self.nextdns.get_analytics_dnssec(self.profile_id)
@ -109,6 +118,8 @@ class NextDnsDnssecUpdateCoordinator(NextDnsUpdateCoordinator[AnalyticsDnssec]):
class NextDnsEncryptionUpdateCoordinator(NextDnsUpdateCoordinator[AnalyticsEncryption]): class NextDnsEncryptionUpdateCoordinator(NextDnsUpdateCoordinator[AnalyticsEncryption]):
"""Class to manage fetching NextDNS analytics encryption data from API.""" """Class to manage fetching NextDNS analytics encryption data from API."""
_update_interval = UPDATE_INTERVAL_ANALYTICS
async def _async_update_data_internal(self) -> AnalyticsEncryption: async def _async_update_data_internal(self) -> AnalyticsEncryption:
"""Update data via library.""" """Update data via library."""
return await self.nextdns.get_analytics_encryption(self.profile_id) return await self.nextdns.get_analytics_encryption(self.profile_id)
@ -117,6 +128,8 @@ class NextDnsEncryptionUpdateCoordinator(NextDnsUpdateCoordinator[AnalyticsEncry
class NextDnsIpVersionsUpdateCoordinator(NextDnsUpdateCoordinator[AnalyticsIpVersions]): class NextDnsIpVersionsUpdateCoordinator(NextDnsUpdateCoordinator[AnalyticsIpVersions]):
"""Class to manage fetching NextDNS analytics IP versions data from API.""" """Class to manage fetching NextDNS analytics IP versions data from API."""
_update_interval = UPDATE_INTERVAL_ANALYTICS
async def _async_update_data_internal(self) -> AnalyticsIpVersions: async def _async_update_data_internal(self) -> AnalyticsIpVersions:
"""Update data via library.""" """Update data via library."""
return await self.nextdns.get_analytics_ip_versions(self.profile_id) return await self.nextdns.get_analytics_ip_versions(self.profile_id)
@ -125,6 +138,8 @@ class NextDnsIpVersionsUpdateCoordinator(NextDnsUpdateCoordinator[AnalyticsIpVer
class NextDnsProtocolsUpdateCoordinator(NextDnsUpdateCoordinator[AnalyticsProtocols]): class NextDnsProtocolsUpdateCoordinator(NextDnsUpdateCoordinator[AnalyticsProtocols]):
"""Class to manage fetching NextDNS analytics protocols data from API.""" """Class to manage fetching NextDNS analytics protocols data from API."""
_update_interval = UPDATE_INTERVAL_ANALYTICS
async def _async_update_data_internal(self) -> AnalyticsProtocols: async def _async_update_data_internal(self) -> AnalyticsProtocols:
"""Update data via library.""" """Update data via library."""
return await self.nextdns.get_analytics_protocols(self.profile_id) return await self.nextdns.get_analytics_protocols(self.profile_id)
@ -133,6 +148,8 @@ class NextDnsProtocolsUpdateCoordinator(NextDnsUpdateCoordinator[AnalyticsProtoc
class NextDnsSettingsUpdateCoordinator(NextDnsUpdateCoordinator[Settings]): class NextDnsSettingsUpdateCoordinator(NextDnsUpdateCoordinator[Settings]):
"""Class to manage fetching NextDNS connection data from API.""" """Class to manage fetching NextDNS connection data from API."""
_update_interval = UPDATE_INTERVAL_SETTINGS
async def _async_update_data_internal(self) -> Settings: async def _async_update_data_internal(self) -> Settings:
"""Update data via library.""" """Update data via library."""
return await self.nextdns.get_settings(self.profile_id) return await self.nextdns.get_settings(self.profile_id)
@ -141,6 +158,8 @@ class NextDnsSettingsUpdateCoordinator(NextDnsUpdateCoordinator[Settings]):
class NextDnsConnectionUpdateCoordinator(NextDnsUpdateCoordinator[ConnectionStatus]): class NextDnsConnectionUpdateCoordinator(NextDnsUpdateCoordinator[ConnectionStatus]):
"""Class to manage fetching NextDNS connection data from API.""" """Class to manage fetching NextDNS connection data from API."""
_update_interval = UPDATE_INTERVAL_CONNECTION
async def _async_update_data_internal(self) -> ConnectionStatus: async def _async_update_data_internal(self) -> ConnectionStatus:
"""Update data via library.""" """Update data via library."""
return await self.nextdns.connection_status(self.profile_id) return await self.nextdns.connection_status(self.profile_id)