Add base entity to sabnzbd (#130995)

homeassistant/components/sabnzbd/coordinator.py

@@ -16,6 +16,8 @@ _LOGGER = logging.getLogger(__name__)
 class SabnzbdUpdateCoordinator(DataUpdateCoordinator[dict[str, Any]]):
     """The SABnzbd update coordinator."""
 
+    config_entry: ConfigEntry
+
     def __init__(
         self,
         hass: HomeAssistant,

homeassistant/components/sabnzbd/entity.py

@@ -0,0 +1,30 @@
+"""Base entity for Sabnzbd."""
+
+from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
+from homeassistant.helpers.entity import EntityDescription
+from homeassistant.helpers.update_coordinator import CoordinatorEntity
+
+from .const import DOMAIN
+from .coordinator import SabnzbdUpdateCoordinator
+
+
+class SabnzbdEntity(CoordinatorEntity[SabnzbdUpdateCoordinator]):
+    """Defines a base Sabnzbd entity."""
+
+    _attr_has_entity_name = True
+
+    def __init__(
+        self,
+        coordinator: SabnzbdUpdateCoordinator,
+        description: EntityDescription,
+    ) -> None:
+        """Initialize the base entity."""
+        super().__init__(coordinator)
+
+        entry_id = coordinator.config_entry.entry_id
+        self._attr_unique_id = f"{entry_id}_{description.key}"
+        self.entity_description = description
+        self._attr_device_info = DeviceInfo(
+            entry_type=DeviceEntryType.SERVICE,
+            identifiers={(DOMAIN, entry_id)},
+        )

homeassistant/components/sabnzbd/sensor.py

@@ -13,13 +13,12 @@ from homeassistant.components.sensor import (
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import UnitOfDataRate, UnitOfInformation
 from homeassistant.core import HomeAssistant
-from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from homeassistant.helpers.typing import StateType
-from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
-from . import DOMAIN, SabnzbdUpdateCoordinator
+from .const import DOMAIN
-from .const import DEFAULT_NAME
+from .coordinator import SabnzbdUpdateCoordinator
+from .entity import SabnzbdEntity
 
 
 @dataclass(frozen=True, kw_only=True)
@@ -139,34 +138,13 @@ async def async_setup_entry(
     entry_id = config_entry.entry_id
     coordinator: SabnzbdUpdateCoordinator = hass.data[DOMAIN][entry_id]
 
-    async_add_entities(
+    async_add_entities([SabnzbdSensor(coordinator, sensor) for sensor in SENSOR_TYPES])
-        [SabnzbdSensor(coordinator, sensor, entry_id) for sensor in SENSOR_TYPES]
-    )
 
 
-class SabnzbdSensor(CoordinatorEntity[SabnzbdUpdateCoordinator], SensorEntity):
+class SabnzbdSensor(SabnzbdEntity, SensorEntity):
     """Representation of an SABnzbd sensor."""
 
     entity_description: SabnzbdSensorEntityDescription
-    _attr_should_poll = False
-    _attr_has_entity_name = True
-
-    def __init__(
-        self,
-        coordinator: SabnzbdUpdateCoordinator,
-        description: SabnzbdSensorEntityDescription,
-        entry_id,
-    ) -> None:
-        """Initialize the sensor."""
-        super().__init__(coordinator)
-
-        self._attr_unique_id = f"{entry_id}_{description.key}"
-        self.entity_description = description
-        self._attr_device_info = DeviceInfo(
-            entry_type=DeviceEntryType.SERVICE,
-            identifiers={(DOMAIN, entry_id)},
-            name=DEFAULT_NAME,
-        )
 
     @property
     def native_value(self) -> StateType:

tests/components/sabnzbd/snapshots/test_sensor.ambr

@@ -41,7 +41,7 @@
   StateSnapshot({
     'attributes': ReadOnlyDict({
       'device_class': 'data_size',
-      'friendly_name': 'SABnzbd Daily total',
+      'friendly_name': 'Sabnzbd Daily total',
       'state_class': <SensorStateClass.TOTAL_INCREASING: 'total_increasing'>,
       'unit_of_measurement': <UnitOfInformation.GIGABYTES: 'GB'>,
     }),
@@ -92,7 +92,7 @@
   StateSnapshot({
     'attributes': ReadOnlyDict({
       'device_class': 'data_size',
-      'friendly_name': 'SABnzbd Free disk space',
+      'friendly_name': 'Sabnzbd Free disk space',
       'state_class': <SensorStateClass.MEASUREMENT: 'measurement'>,
       'unit_of_measurement': <UnitOfInformation.GIGABYTES: 'GB'>,
     }),
@@ -143,7 +143,7 @@
   StateSnapshot({
     'attributes': ReadOnlyDict({
       'device_class': 'data_size',
-      'friendly_name': 'SABnzbd Left to download',
+      'friendly_name': 'Sabnzbd Left to download',
       'state_class': <SensorStateClass.MEASUREMENT: 'measurement'>,
       'unit_of_measurement': <UnitOfInformation.MEGABYTES: 'MB'>,
     }),
@@ -197,7 +197,7 @@
   StateSnapshot({
     'attributes': ReadOnlyDict({
       'device_class': 'data_size',
-      'friendly_name': 'SABnzbd Monthly total',
+      'friendly_name': 'Sabnzbd Monthly total',
       'state_class': <SensorStateClass.TOTAL_INCREASING: 'total_increasing'>,
       'unit_of_measurement': <UnitOfInformation.GIGABYTES: 'GB'>,
     }),
@@ -251,7 +251,7 @@
   StateSnapshot({
     'attributes': ReadOnlyDict({
       'device_class': 'data_size',
-      'friendly_name': 'SABnzbd Overall total',
+      'friendly_name': 'Sabnzbd Overall total',
       'state_class': <SensorStateClass.TOTAL_INCREASING: 'total_increasing'>,
       'unit_of_measurement': <UnitOfInformation.GIGABYTES: 'GB'>,
     }),
@@ -302,7 +302,7 @@
   StateSnapshot({
     'attributes': ReadOnlyDict({
       'device_class': 'data_size',
-      'friendly_name': 'SABnzbd Queue',
+      'friendly_name': 'Sabnzbd Queue',
       'state_class': <SensorStateClass.MEASUREMENT: 'measurement'>,
       'unit_of_measurement': <UnitOfInformation.MEGABYTES: 'MB'>,
     }),
@@ -355,7 +355,7 @@
 # name: test_sensor[sensor.sabnzbd_queue_count-state]
   StateSnapshot({
     'attributes': ReadOnlyDict({
-      'friendly_name': 'SABnzbd Queue count',
+      'friendly_name': 'Sabnzbd Queue count',
       'state_class': <SensorStateClass.TOTAL: 'total'>,
     }),
     'context': <ANY>,
@@ -411,7 +411,7 @@
   StateSnapshot({
     'attributes': ReadOnlyDict({
       'device_class': 'data_rate',
-      'friendly_name': 'SABnzbd Speed',
+      'friendly_name': 'Sabnzbd Speed',
       'state_class': <SensorStateClass.MEASUREMENT: 'measurement'>,
       'unit_of_measurement': <UnitOfDataRate.MEGABYTES_PER_SECOND: 'MB/s'>,
     }),
@@ -459,7 +459,7 @@
 # name: test_sensor[sensor.sabnzbd_status-state]
   StateSnapshot({
     'attributes': ReadOnlyDict({
-      'friendly_name': 'SABnzbd Status',
+      'friendly_name': 'Sabnzbd Status',
     }),
     'context': <ANY>,
     'entity_id': 'sensor.sabnzbd_status',
@@ -508,7 +508,7 @@
   StateSnapshot({
     'attributes': ReadOnlyDict({
       'device_class': 'data_size',
-      'friendly_name': 'SABnzbd Total disk space',
+      'friendly_name': 'Sabnzbd Total disk space',
       'state_class': <SensorStateClass.MEASUREMENT: 'measurement'>,
       'unit_of_measurement': <UnitOfInformation.GIGABYTES: 'GB'>,
     }),
@@ -562,7 +562,7 @@
   StateSnapshot({
     'attributes': ReadOnlyDict({
       'device_class': 'data_size',
-      'friendly_name': 'SABnzbd Weekly total',
+      'friendly_name': 'Sabnzbd Weekly total',
       'state_class': <SensorStateClass.TOTAL_INCREASING: 'total_increasing'>,
       'unit_of_measurement': <UnitOfInformation.GIGABYTES: 'GB'>,
     }),