From cce03d2ee75028984864f214de17007ae8bc01f9 Mon Sep 17 00:00:00 2001 From: Michael <35783820+mib1185@users.noreply.github.com> Date: Sun, 9 Feb 2025 14:26:09 +0100 Subject: [PATCH] Explicitly pass in the config_entry in transmission coordinator (#137891) explicitly pass in the config_entry in coordinator --- homeassistant/components/transmission/__init__.py | 14 ++++++++------ .../components/transmission/coordinator.py | 11 ++++++++--- homeassistant/components/transmission/sensor.py | 3 +-- homeassistant/components/transmission/switch.py | 3 +-- 4 files changed, 18 insertions(+), 13 deletions(-) diff --git a/homeassistant/components/transmission/__init__.py b/homeassistant/components/transmission/__init__.py index 578488dad1a..6d23017ab75 100644 --- a/homeassistant/components/transmission/__init__.py +++ b/homeassistant/components/transmission/__init__.py @@ -15,7 +15,7 @@ from transmission_rpc.error import ( ) import voluptuous as vol -from homeassistant.config_entries import ConfigEntry, ConfigEntryState +from homeassistant.config_entries import ConfigEntryState from homeassistant.const import ( CONF_HOST, CONF_ID, @@ -54,7 +54,7 @@ from .const import ( SERVICE_START_TORRENT, SERVICE_STOP_TORRENT, ) -from .coordinator import TransmissionDataUpdateCoordinator +from .coordinator import TransmissionConfigEntry, TransmissionDataUpdateCoordinator from .errors import AuthenticationError, CannotConnect, UnknownError _LOGGER = logging.getLogger(__name__) @@ -117,8 +117,6 @@ SERVICE_STOP_TORRENT_SCHEMA = vol.All( CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN) -type TransmissionConfigEntry = ConfigEntry[TransmissionDataUpdateCoordinator] - async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: """Set up the Transmission component.""" @@ -167,12 +165,16 @@ async def async_setup_entry( return True -async def async_unload_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool: +async def async_unload_entry( + hass: HomeAssistant, config_entry: TransmissionConfigEntry +) -> bool: """Unload Transmission Entry from config_entry.""" return await hass.config_entries.async_unload_platforms(config_entry, PLATFORMS) -async def async_migrate_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool: +async def async_migrate_entry( + hass: HomeAssistant, config_entry: TransmissionConfigEntry +) -> bool: """Migrate an old config entry.""" _LOGGER.debug( "Migrating from version %s.%s", diff --git a/homeassistant/components/transmission/coordinator.py b/homeassistant/components/transmission/coordinator.py index b998ab6fbdd..afe2660e711 100644 --- a/homeassistant/components/transmission/coordinator.py +++ b/homeassistant/components/transmission/coordinator.py @@ -27,17 +27,21 @@ from .const import ( _LOGGER = logging.getLogger(__name__) +type TransmissionConfigEntry = ConfigEntry[TransmissionDataUpdateCoordinator] + class TransmissionDataUpdateCoordinator(DataUpdateCoordinator[SessionStats]): """Transmission dataupdate coordinator class.""" - config_entry: ConfigEntry + config_entry: TransmissionConfigEntry def __init__( - self, hass: HomeAssistant, entry: ConfigEntry, api: transmission_rpc.Client + self, + hass: HomeAssistant, + entry: TransmissionConfigEntry, + api: transmission_rpc.Client, ) -> None: """Initialize the Transmission RPC API.""" - self.config_entry = entry self.api = api self.host = entry.data[CONF_HOST] self._session: transmission_rpc.Session | None = None @@ -47,6 +51,7 @@ class TransmissionDataUpdateCoordinator(DataUpdateCoordinator[SessionStats]): self.torrents: list[transmission_rpc.Torrent] = [] super().__init__( hass, + config_entry=entry, name=f"{DOMAIN} - {self.host}", logger=_LOGGER, update_interval=timedelta(seconds=DEFAULT_SCAN_INTERVAL), diff --git a/homeassistant/components/transmission/sensor.py b/homeassistant/components/transmission/sensor.py index 652f5d51fbb..bae9e7f3cc7 100644 --- a/homeassistant/components/transmission/sensor.py +++ b/homeassistant/components/transmission/sensor.py @@ -21,7 +21,6 @@ from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.helpers.typing import StateType from homeassistant.helpers.update_coordinator import CoordinatorEntity -from . import TransmissionConfigEntry from .const import ( DOMAIN, STATE_ATTR_TORRENT_INFO, @@ -30,7 +29,7 @@ from .const import ( STATE_UP_DOWN, SUPPORTED_ORDER_MODES, ) -from .coordinator import TransmissionDataUpdateCoordinator +from .coordinator import TransmissionConfigEntry, TransmissionDataUpdateCoordinator MODES: dict[str, list[str] | None] = { "started_torrents": ["downloading"], diff --git a/homeassistant/components/transmission/switch.py b/homeassistant/components/transmission/switch.py index d88f794cb10..d06932ff862 100644 --- a/homeassistant/components/transmission/switch.py +++ b/homeassistant/components/transmission/switch.py @@ -10,9 +10,8 @@ from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.helpers.update_coordinator import CoordinatorEntity -from . import TransmissionConfigEntry from .const import DOMAIN -from .coordinator import TransmissionDataUpdateCoordinator +from .coordinator import TransmissionConfigEntry, TransmissionDataUpdateCoordinator @dataclass(frozen=True, kw_only=True)