From 9b9edecaac9bbbdb64c6568eccab94c145dfb579 Mon Sep 17 00:00:00 2001
From: epenet <6771947+epenet@users.noreply.github.com>
Date: Mon, 23 Sep 2024 11:55:03 +0200
Subject: [PATCH] Move nuki base entity to separate module (#126500)

---
 homeassistant/components/nuki/__init__.py     | 34 +--------------
 .../components/nuki/binary_sensor.py          |  3 +-
 homeassistant/components/nuki/entity.py       | 42 +++++++++++++++++++
 homeassistant/components/nuki/lock.py         |  3 +-
 homeassistant/components/nuki/sensor.py       |  3 +-
 5 files changed, 49 insertions(+), 36 deletions(-)
 create mode 100644 homeassistant/components/nuki/entity.py

diff --git a/homeassistant/components/nuki/__init__.py b/homeassistant/components/nuki/__init__.py
index 2b9035e730f..4f3f56f7f03 100644
--- a/homeassistant/components/nuki/__init__.py
+++ b/homeassistant/components/nuki/__init__.py
@@ -10,7 +10,6 @@ import logging
 from aiohttp import web
 from pynuki import NukiBridge, NukiLock, NukiOpener
 from pynuki.bridge import InvalidCredentialsException
-from pynuki.device import NukiDevice
 from requests.exceptions import RequestException
 
 from homeassistant import exceptions
@@ -25,9 +24,8 @@ from homeassistant.const import (
 )
 from homeassistant.core import Event, HomeAssistant
 from homeassistant.helpers import device_registry as dr, issue_registry as ir
-from homeassistant.helpers.device_registry import DeviceInfo
 from homeassistant.helpers.network import NoURLAvailableError, get_url
-from homeassistant.helpers.update_coordinator import CoordinatorEntity, UpdateFailed
+from homeassistant.helpers.update_coordinator import UpdateFailed
 
 from .const import CONF_ENCRYPT_TOKEN, DEFAULT_TIMEOUT, DOMAIN
 from .coordinator import NukiCoordinator
@@ -266,33 +264,3 @@ async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
         hass.data[DOMAIN].pop(entry.entry_id)
 
     return unload_ok
-
-
-class NukiEntity[_NukiDeviceT: NukiDevice](CoordinatorEntity[NukiCoordinator]):
-    """An entity using CoordinatorEntity.
-
-    The CoordinatorEntity class provides:
-      should_poll
-      async_update
-      async_added_to_hass
-      available
-
-    """
-
-    def __init__(self, coordinator: NukiCoordinator, nuki_device: _NukiDeviceT) -> None:
-        """Pass coordinator to CoordinatorEntity."""
-        super().__init__(coordinator)
-        self._nuki_device = nuki_device
-
-    @property
-    def device_info(self) -> DeviceInfo:
-        """Device info for Nuki entities."""
-        return DeviceInfo(
-            identifiers={(DOMAIN, parse_id(self._nuki_device.nuki_id))},
-            name=self._nuki_device.name,
-            manufacturer="Nuki Home Solutions GmbH",
-            model=self._nuki_device.device_model_str.capitalize(),
-            sw_version=self._nuki_device.firmware_version,
-            via_device=(DOMAIN, self.coordinator.bridge_id),
-            serial_number=parse_id(self._nuki_device.nuki_id),
-        )
diff --git a/homeassistant/components/nuki/binary_sensor.py b/homeassistant/components/nuki/binary_sensor.py
index 731b94e6551..8269c43813e 100644
--- a/homeassistant/components/nuki/binary_sensor.py
+++ b/homeassistant/components/nuki/binary_sensor.py
@@ -14,8 +14,9 @@ from homeassistant.const import EntityCategory
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
-from . import NukiEntity, NukiEntryData
+from . import NukiEntryData
 from .const import DOMAIN as NUKI_DOMAIN
+from .entity import NukiEntity
 
 
 async def async_setup_entry(
diff --git a/homeassistant/components/nuki/entity.py b/homeassistant/components/nuki/entity.py
new file mode 100644
index 00000000000..2de1827c416
--- /dev/null
+++ b/homeassistant/components/nuki/entity.py
@@ -0,0 +1,42 @@
+"""The nuki component."""
+
+from __future__ import annotations
+
+from pynuki.device import NukiDevice
+
+from homeassistant.helpers.device_registry import DeviceInfo
+from homeassistant.helpers.update_coordinator import CoordinatorEntity
+
+from .const import DOMAIN
+from .coordinator import NukiCoordinator
+from .helpers import parse_id
+
+
+class NukiEntity[_NukiDeviceT: NukiDevice](CoordinatorEntity[NukiCoordinator]):
+    """An entity using CoordinatorEntity.
+
+    The CoordinatorEntity class provides:
+      should_poll
+      async_update
+      async_added_to_hass
+      available
+
+    """
+
+    def __init__(self, coordinator: NukiCoordinator, nuki_device: _NukiDeviceT) -> None:
+        """Pass coordinator to CoordinatorEntity."""
+        super().__init__(coordinator)
+        self._nuki_device = nuki_device
+
+    @property
+    def device_info(self) -> DeviceInfo:
+        """Device info for Nuki entities."""
+        return DeviceInfo(
+            identifiers={(DOMAIN, parse_id(self._nuki_device.nuki_id))},
+            name=self._nuki_device.name,
+            manufacturer="Nuki Home Solutions GmbH",
+            model=self._nuki_device.device_model_str.capitalize(),
+            sw_version=self._nuki_device.firmware_version,
+            via_device=(DOMAIN, self.coordinator.bridge_id),
+            serial_number=parse_id(self._nuki_device.nuki_id),
+        )
diff --git a/homeassistant/components/nuki/lock.py b/homeassistant/components/nuki/lock.py
index 6e1c98bc69c..a2bf7559fc4 100644
--- a/homeassistant/components/nuki/lock.py
+++ b/homeassistant/components/nuki/lock.py
@@ -17,8 +17,9 @@ from homeassistant.core import HomeAssistant
 from homeassistant.helpers import config_validation as cv, entity_platform
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
-from . import NukiEntity, NukiEntryData
+from . import NukiEntryData
 from .const import ATTR_ENABLE, ATTR_UNLATCH, DOMAIN as NUKI_DOMAIN, ERROR_STATES
+from .entity import NukiEntity
 from .helpers import CannotConnect
 
 
diff --git a/homeassistant/components/nuki/sensor.py b/homeassistant/components/nuki/sensor.py
index 628783062d3..d89202ac7d7 100644
--- a/homeassistant/components/nuki/sensor.py
+++ b/homeassistant/components/nuki/sensor.py
@@ -10,8 +10,9 @@ from homeassistant.const import PERCENTAGE, EntityCategory
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
-from . import NukiEntity, NukiEntryData
+from . import NukiEntryData
 from .const import DOMAIN as NUKI_DOMAIN
+from .entity import NukiEntity
 
 
 async def async_setup_entry(