From ec311ecd2b8be85a5a18c97548b5834089a054a8 Mon Sep 17 00:00:00 2001 From: epenet <6771947+epenet@users.noreply.github.com> Date: Mon, 23 Sep 2024 13:09:38 +0200 Subject: [PATCH] Move prusalink base entity to separate module (#126510) * Move prusalink base entity to separate module * Fix tests --- .../components/prusalink/__init__.py | 19 -------------- .../components/prusalink/binary_sensor.py | 2 +- homeassistant/components/prusalink/button.py | 2 +- homeassistant/components/prusalink/camera.py | 2 +- homeassistant/components/prusalink/entity.py | 25 +++++++++++++++++++ homeassistant/components/prusalink/sensor.py | 2 +- tests/components/prusalink/test_button.py | 2 +- 7 files changed, 30 insertions(+), 24 deletions(-) create mode 100644 homeassistant/components/prusalink/entity.py diff --git a/homeassistant/components/prusalink/__init__.py b/homeassistant/components/prusalink/__init__.py index 62eeb91d3e1..1415e3dd0a6 100644 --- a/homeassistant/components/prusalink/__init__.py +++ b/homeassistant/components/prusalink/__init__.py @@ -16,9 +16,7 @@ from homeassistant.const import ( from homeassistant.core import HomeAssistant from homeassistant.exceptions import ConfigEntryError from homeassistant.helpers import issue_registry as ir -from homeassistant.helpers.device_registry import DeviceInfo from homeassistant.helpers.httpx_client import get_async_client -from homeassistant.helpers.update_coordinator import CoordinatorEntity from .config_flow import ConfigFlow from .const import DOMAIN @@ -26,7 +24,6 @@ from .coordinator import ( InfoUpdateCoordinator, JobUpdateCoordinator, LegacyStatusCoordinator, - PrusaLinkUpdateCoordinator, StatusCoordinator, ) @@ -128,19 +125,3 @@ async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool: hass.data[DOMAIN].pop(entry.entry_id) return unload_ok - - -class PrusaLinkEntity(CoordinatorEntity[PrusaLinkUpdateCoordinator]): - """Defines a base PrusaLink entity.""" - - _attr_has_entity_name = True - - @property - def device_info(self) -> DeviceInfo: - """Return device information about this PrusaLink device.""" - return DeviceInfo( - identifiers={(DOMAIN, self.coordinator.config_entry.entry_id)}, - name=self.coordinator.config_entry.title, - manufacturer="Prusa", - configuration_url=self.coordinator.api.client.host, - ) diff --git a/homeassistant/components/prusalink/binary_sensor.py b/homeassistant/components/prusalink/binary_sensor.py index abeb79c2876..d40ac8a4cfa 100644 --- a/homeassistant/components/prusalink/binary_sensor.py +++ b/homeassistant/components/prusalink/binary_sensor.py @@ -17,9 +17,9 @@ from homeassistant.config_entries import ConfigEntry from homeassistant.core import HomeAssistant from homeassistant.helpers.entity_platform import AddEntitiesCallback -from . import PrusaLinkEntity from .const import DOMAIN from .coordinator import PrusaLinkUpdateCoordinator +from .entity import PrusaLinkEntity T = TypeVar("T", PrinterStatus, LegacyPrinterStatus, JobInfo, PrinterInfo) diff --git a/homeassistant/components/prusalink/button.py b/homeassistant/components/prusalink/button.py index 0ad7e531d46..06d356b2ca6 100644 --- a/homeassistant/components/prusalink/button.py +++ b/homeassistant/components/prusalink/button.py @@ -15,9 +15,9 @@ from homeassistant.core import HomeAssistant from homeassistant.exceptions import HomeAssistantError from homeassistant.helpers.entity_platform import AddEntitiesCallback -from . import PrusaLinkEntity from .const import DOMAIN from .coordinator import PrusaLinkUpdateCoordinator +from .entity import PrusaLinkEntity T = TypeVar("T", PrinterStatus, LegacyPrinterStatus, JobInfo) diff --git a/homeassistant/components/prusalink/camera.py b/homeassistant/components/prusalink/camera.py index 2185c5f3cf6..eee655447cc 100644 --- a/homeassistant/components/prusalink/camera.py +++ b/homeassistant/components/prusalink/camera.py @@ -9,9 +9,9 @@ from homeassistant.config_entries import ConfigEntry from homeassistant.core import HomeAssistant from homeassistant.helpers.entity_platform import AddEntitiesCallback -from . import PrusaLinkEntity from .const import DOMAIN from .coordinator import JobUpdateCoordinator +from .entity import PrusaLinkEntity async def async_setup_entry( diff --git a/homeassistant/components/prusalink/entity.py b/homeassistant/components/prusalink/entity.py new file mode 100644 index 00000000000..e0bc62ba3c0 --- /dev/null +++ b/homeassistant/components/prusalink/entity.py @@ -0,0 +1,25 @@ +"""The PrusaLink integration.""" + +from __future__ import annotations + +from homeassistant.helpers.device_registry import DeviceInfo +from homeassistant.helpers.update_coordinator import CoordinatorEntity + +from .const import DOMAIN +from .coordinator import PrusaLinkUpdateCoordinator + + +class PrusaLinkEntity(CoordinatorEntity[PrusaLinkUpdateCoordinator]): + """Defines a base PrusaLink entity.""" + + _attr_has_entity_name = True + + @property + def device_info(self) -> DeviceInfo: + """Return device information about this PrusaLink device.""" + return DeviceInfo( + identifiers={(DOMAIN, self.coordinator.config_entry.entry_id)}, + name=self.coordinator.config_entry.title, + manufacturer="Prusa", + configuration_url=self.coordinator.api.client.host, + ) diff --git a/homeassistant/components/prusalink/sensor.py b/homeassistant/components/prusalink/sensor.py index 96cd4979b11..0c746adbe2e 100644 --- a/homeassistant/components/prusalink/sensor.py +++ b/homeassistant/components/prusalink/sensor.py @@ -29,9 +29,9 @@ from homeassistant.helpers.typing import StateType from homeassistant.util.dt import utcnow from homeassistant.util.variance import ignore_variance -from . import PrusaLinkEntity from .const import DOMAIN from .coordinator import PrusaLinkUpdateCoordinator +from .entity import PrusaLinkEntity T = TypeVar("T", PrinterStatus, LegacyPrinterStatus, JobInfo, PrinterInfo) diff --git a/tests/components/prusalink/test_button.py b/tests/components/prusalink/test_button.py index 54f3854161c..f85e0232c74 100644 --- a/tests/components/prusalink/test_button.py +++ b/tests/components/prusalink/test_button.py @@ -93,7 +93,7 @@ async def test_button_resume_cancel( with ( patch(f"pyprusalink.PrusaLink.{method}") as mock_meth, patch( - "homeassistant.components.prusalink.PrusaLinkUpdateCoordinator._fetch_data" + "homeassistant.components.prusalink.coordinator.PrusaLinkUpdateCoordinator._fetch_data" ), ): await hass.services.async_call(