Move radarr base entity to separate module (#126514)

pull/126520/head
epenet 2024-09-23 12:42:00 +02:00 committed by GitHub
parent 52aec885ea
commit a75a513531
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 53 additions and 49 deletions

View File

@ -3,26 +3,15 @@
from __future__ import annotations from __future__ import annotations
from dataclasses import dataclass, fields from dataclasses import dataclass, fields
from typing import cast
from aiopyarr.models.host_configuration import PyArrHostConfiguration from aiopyarr.models.host_configuration import PyArrHostConfiguration
from aiopyarr.radarr_client import RadarrClient from aiopyarr.radarr_client import RadarrClient
from homeassistant.config_entries import ConfigEntry from homeassistant.config_entries import ConfigEntry
from homeassistant.const import ( from homeassistant.const import CONF_API_KEY, CONF_URL, CONF_VERIFY_SSL, Platform
ATTR_SW_VERSION,
CONF_API_KEY,
CONF_URL,
CONF_VERIFY_SSL,
Platform,
)
from homeassistant.core import HomeAssistant from homeassistant.core import HomeAssistant
from homeassistant.helpers.aiohttp_client import async_get_clientsession from homeassistant.helpers.aiohttp_client import async_get_clientsession
from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
from homeassistant.helpers.entity import EntityDescription
from homeassistant.helpers.update_coordinator import CoordinatorEntity
from .const import DEFAULT_NAME, DOMAIN
from .coordinator import ( from .coordinator import (
CalendarUpdateCoordinator, CalendarUpdateCoordinator,
DiskSpaceDataUpdateCoordinator, DiskSpaceDataUpdateCoordinator,
@ -31,7 +20,6 @@ from .coordinator import (
QueueDataUpdateCoordinator, QueueDataUpdateCoordinator,
RadarrDataUpdateCoordinator, RadarrDataUpdateCoordinator,
StatusDataUpdateCoordinator, StatusDataUpdateCoordinator,
T,
) )
PLATFORMS = [Platform.BINARY_SENSOR, Platform.CALENDAR, Platform.SENSOR] PLATFORMS = [Platform.BINARY_SENSOR, Platform.CALENDAR, Platform.SENSOR]
@ -89,36 +77,3 @@ async def async_setup_entry(hass: HomeAssistant, entry: RadarrConfigEntry) -> bo
async def async_unload_entry(hass: HomeAssistant, entry: RadarrConfigEntry) -> bool: async def async_unload_entry(hass: HomeAssistant, entry: RadarrConfigEntry) -> bool:
"""Unload a config entry.""" """Unload a config entry."""
return await hass.config_entries.async_unload_platforms(entry, PLATFORMS) return await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
class RadarrEntity(CoordinatorEntity[RadarrDataUpdateCoordinator[T]]):
"""Defines a base Radarr entity."""
_attr_has_entity_name = True
coordinator: RadarrDataUpdateCoordinator[T]
def __init__(
self,
coordinator: RadarrDataUpdateCoordinator[T],
description: EntityDescription,
) -> None:
"""Create Radarr entity."""
super().__init__(coordinator)
self.entity_description = description
self._attr_unique_id = f"{coordinator.config_entry.entry_id}_{description.key}"
@property
def device_info(self) -> DeviceInfo:
"""Return device information about the Radarr instance."""
device_info = DeviceInfo(
configuration_url=self.coordinator.host_configuration.url,
entry_type=DeviceEntryType.SERVICE,
identifiers={(DOMAIN, self.coordinator.config_entry.entry_id)},
manufacturer=DEFAULT_NAME,
name=self.coordinator.config_entry.title,
)
if isinstance(self.coordinator, StatusDataUpdateCoordinator):
device_info[ATTR_SW_VERSION] = cast(
StatusDataUpdateCoordinator, self.coordinator
).data.version
return device_info

View File

@ -13,8 +13,9 @@ from homeassistant.const import EntityCategory
from homeassistant.core import HomeAssistant from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import RadarrConfigEntry, RadarrEntity from . import RadarrConfigEntry
from .const import HEALTH_ISSUES from .const import HEALTH_ISSUES
from .entity import RadarrEntity
BINARY_SENSOR_TYPE = BinarySensorEntityDescription( BINARY_SENSOR_TYPE = BinarySensorEntityDescription(
key="health", key="health",

View File

@ -9,8 +9,9 @@ from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.entity import EntityDescription from homeassistant.helpers.entity import EntityDescription
from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import RadarrConfigEntry, RadarrEntity from . import RadarrConfigEntry
from .coordinator import CalendarUpdateCoordinator, RadarrEvent from .coordinator import CalendarUpdateCoordinator, RadarrEvent
from .entity import RadarrEntity
CALENDAR_TYPE = EntityDescription( CALENDAR_TYPE = EntityDescription(
key="calendar", key="calendar",

View File

@ -0,0 +1,46 @@
"""The Radarr component."""
from __future__ import annotations
from typing import cast
from homeassistant.const import ATTR_SW_VERSION
from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
from homeassistant.helpers.entity import EntityDescription
from homeassistant.helpers.update_coordinator import CoordinatorEntity
from .const import DEFAULT_NAME, DOMAIN
from .coordinator import RadarrDataUpdateCoordinator, StatusDataUpdateCoordinator, T
class RadarrEntity(CoordinatorEntity[RadarrDataUpdateCoordinator[T]]):
"""Defines a base Radarr entity."""
_attr_has_entity_name = True
coordinator: RadarrDataUpdateCoordinator[T]
def __init__(
self,
coordinator: RadarrDataUpdateCoordinator[T],
description: EntityDescription,
) -> None:
"""Create Radarr entity."""
super().__init__(coordinator)
self.entity_description = description
self._attr_unique_id = f"{coordinator.config_entry.entry_id}_{description.key}"
@property
def device_info(self) -> DeviceInfo:
"""Return device information about the Radarr instance."""
device_info = DeviceInfo(
configuration_url=self.coordinator.host_configuration.url,
entry_type=DeviceEntryType.SERVICE,
identifiers={(DOMAIN, self.coordinator.config_entry.entry_id)},
manufacturer=DEFAULT_NAME,
name=self.coordinator.config_entry.title,
)
if isinstance(self.coordinator, StatusDataUpdateCoordinator):
device_info[ATTR_SW_VERSION] = cast(
StatusDataUpdateCoordinator, self.coordinator
).data.version
return device_info

View File

@ -19,8 +19,9 @@ from homeassistant.const import EntityCategory, UnitOfInformation
from homeassistant.core import HomeAssistant from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.helpers.entity_platform import AddEntitiesCallback
from . import RadarrConfigEntry, RadarrEntity from . import RadarrConfigEntry
from .coordinator import RadarrDataUpdateCoordinator, T from .coordinator import RadarrDataUpdateCoordinator, T
from .entity import RadarrEntity
def get_space(data: list[Diskspace], name: str) -> str: def get_space(data: list[Diskspace], name: str) -> str: