Move uptimerobot coordinator to its own file (#100558)

* Move uptimerobot coordinator to its own file

* Fix import of coordinator in platforms
This commit is contained in:
Jan-Philipp Benecke 2023-09-19 09:45:56 +02:00 committed by GitHub
parent 2722e5ddaa
commit cf6eddee74
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 85 additions and 73 deletions

View file

@ -1,12 +1,7 @@
"""The UptimeRobot integration."""
from __future__ import annotations
from pyuptimerobot import (
UptimeRobot,
UptimeRobotAuthenticationException,
UptimeRobotException,
UptimeRobotMonitor,
)
from pyuptimerobot import UptimeRobot
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_API_KEY
@ -14,9 +9,9 @@ from homeassistant.core import HomeAssistant
from homeassistant.exceptions import ConfigEntryAuthFailed
from homeassistant.helpers import device_registry as dr
from homeassistant.helpers.aiohttp_client import async_get_clientsession
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
from .const import API_ATTR_OK, COORDINATOR_UPDATE_INTERVAL, DOMAIN, LOGGER, PLATFORMS
from .const import DOMAIN, PLATFORMS
from .coordinator import UptimeRobotDataUpdateCoordinator
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
@ -51,64 +46,3 @@ async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
hass.data[DOMAIN].pop(entry.entry_id)
return unload_ok
class UptimeRobotDataUpdateCoordinator(DataUpdateCoordinator[list[UptimeRobotMonitor]]):
"""Data update coordinator for UptimeRobot."""
config_entry: ConfigEntry
def __init__(
self,
hass: HomeAssistant,
config_entry_id: str,
dev_reg: dr.DeviceRegistry,
api: UptimeRobot,
) -> None:
"""Initialize coordinator."""
super().__init__(
hass,
LOGGER,
name=DOMAIN,
update_interval=COORDINATOR_UPDATE_INTERVAL,
)
self._config_entry_id = config_entry_id
self._device_registry = dev_reg
self.api = api
async def _async_update_data(self) -> list[UptimeRobotMonitor]:
"""Update data."""
try:
response = await self.api.async_get_monitors()
except UptimeRobotAuthenticationException as exception:
raise ConfigEntryAuthFailed(exception) from exception
except UptimeRobotException as exception:
raise UpdateFailed(exception) from exception
if response.status != API_ATTR_OK:
raise UpdateFailed(response.error.message)
monitors: list[UptimeRobotMonitor] = response.data
current_monitors = {
list(device.identifiers)[0][1]
for device in dr.async_entries_for_config_entry(
self._device_registry, self._config_entry_id
)
}
new_monitors = {str(monitor.id) for monitor in monitors}
if stale_monitors := current_monitors - new_monitors:
for monitor_id in stale_monitors:
if device := self._device_registry.async_get_device(
identifiers={(DOMAIN, monitor_id)}
):
self._device_registry.async_remove_device(device.id)
# If there are new monitors, we should reload the config entry so we can
# create new devices and entities.
if self.data and new_monitors - {str(monitor.id) for monitor in self.data}:
self.hass.async_create_task(
self.hass.config_entries.async_reload(self._config_entry_id)
)
return monitors

View file

@ -10,8 +10,8 @@ from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import UptimeRobotDataUpdateCoordinator
from .const import DOMAIN
from .coordinator import UptimeRobotDataUpdateCoordinator
from .entity import UptimeRobotEntity

View file

@ -0,0 +1,78 @@
"""DataUpdateCoordinator for the uptimerobot integration."""
from __future__ import annotations
from pyuptimerobot import (
UptimeRobot,
UptimeRobotAuthenticationException,
UptimeRobotException,
UptimeRobotMonitor,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import ConfigEntryAuthFailed
from homeassistant.helpers import device_registry as dr
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
from .const import API_ATTR_OK, COORDINATOR_UPDATE_INTERVAL, DOMAIN, LOGGER
class UptimeRobotDataUpdateCoordinator(DataUpdateCoordinator[list[UptimeRobotMonitor]]):
"""Data update coordinator for UptimeRobot."""
config_entry: ConfigEntry
def __init__(
self,
hass: HomeAssistant,
config_entry_id: str,
dev_reg: dr.DeviceRegistry,
api: UptimeRobot,
) -> None:
"""Initialize coordinator."""
super().__init__(
hass,
LOGGER,
name=DOMAIN,
update_interval=COORDINATOR_UPDATE_INTERVAL,
)
self._config_entry_id = config_entry_id
self._device_registry = dev_reg
self.api = api
async def _async_update_data(self) -> list[UptimeRobotMonitor]:
"""Update data."""
try:
response = await self.api.async_get_monitors()
except UptimeRobotAuthenticationException as exception:
raise ConfigEntryAuthFailed(exception) from exception
except UptimeRobotException as exception:
raise UpdateFailed(exception) from exception
if response.status != API_ATTR_OK:
raise UpdateFailed(response.error.message)
monitors: list[UptimeRobotMonitor] = response.data
current_monitors = {
list(device.identifiers)[0][1]
for device in dr.async_entries_for_config_entry(
self._device_registry, self._config_entry_id
)
}
new_monitors = {str(monitor.id) for monitor in monitors}
if stale_monitors := current_monitors - new_monitors:
for monitor_id in stale_monitors:
if device := self._device_registry.async_get_device(
identifiers={(DOMAIN, monitor_id)}
):
self._device_registry.async_remove_device(device.id)
# If there are new monitors, we should reload the config entry so we can
# create new devices and entities.
if self.data and new_monitors - {str(monitor.id) for monitor in self.data}:
self.hass.async_create_task(
self.hass.config_entries.async_reload(self._config_entry_id)
)
return monitors

View file

@ -8,8 +8,8 @@ from pyuptimerobot import UptimeRobotException
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from . import UptimeRobotDataUpdateCoordinator
from .const import DOMAIN
from .coordinator import UptimeRobotDataUpdateCoordinator
async def async_get_config_entry_diagnostics(

View file

@ -13,8 +13,8 @@ from homeassistant.const import EntityCategory
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import UptimeRobotDataUpdateCoordinator
from .const import DOMAIN
from .coordinator import UptimeRobotDataUpdateCoordinator
from .entity import UptimeRobotEntity

View file

@ -14,8 +14,8 @@ from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import UptimeRobotDataUpdateCoordinator
from .const import API_ATTR_OK, DOMAIN, LOGGER
from .coordinator import UptimeRobotDataUpdateCoordinator
from .entity import UptimeRobotEntity