Reorganize Transmission entry setup (#99195)

* simplify integration setup

* Update transmission entry setup to avoid None attributes

* keep api property in TransmissionData

* Apply suggestion

* Add __init__.py tp .coveragerc
This commit is contained in:
Rami Mosleh 2023-08-28 14:13:35 +03:00 committed by GitHub
parent efcf3ddb57
commit 1d403a961f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 30 deletions

View File

@ -1357,6 +1357,7 @@ omit =
homeassistant/components/trafikverket_weatherstation/__init__.py homeassistant/components/trafikverket_weatherstation/__init__.py
homeassistant/components/trafikverket_weatherstation/coordinator.py homeassistant/components/trafikverket_weatherstation/coordinator.py
homeassistant/components/trafikverket_weatherstation/sensor.py homeassistant/components/trafikverket_weatherstation/sensor.py
homeassistant/components/transmission/__init__.py
homeassistant/components/transmission/sensor.py homeassistant/components/transmission/sensor.py
homeassistant/components/transmission/switch.py homeassistant/components/transmission/switch.py
homeassistant/components/travisci/sensor.py homeassistant/components/travisci/sensor.py

View File

@ -29,11 +29,7 @@ from homeassistant.const import (
Platform, Platform,
) )
from homeassistant.core import HomeAssistant, ServiceCall, callback from homeassistant.core import HomeAssistant, ServiceCall, callback
from homeassistant.exceptions import ( from homeassistant.exceptions import ConfigEntryAuthFailed, ConfigEntryNotReady
ConfigEntryAuthFailed,
ConfigEntryNotReady,
HomeAssistantError,
)
from homeassistant.helpers import ( from homeassistant.helpers import (
config_validation as cv, config_validation as cv,
entity_registry as er, entity_registry as er,
@ -138,17 +134,25 @@ async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> b
await er.async_migrate_entries(hass, config_entry.entry_id, update_unique_id) await er.async_migrate_entries(hass, config_entry.entry_id, update_unique_id)
client = TransmissionClient(hass, config_entry) try:
api = await get_api(hass, dict(config_entry.data))
except CannotConnect as error:
raise ConfigEntryNotReady from error
except (AuthenticationError, UnknownError) as error:
raise ConfigEntryAuthFailed from error
client = TransmissionClient(hass, config_entry, api)
await client.async_setup()
hass.data.setdefault(DOMAIN, {})[config_entry.entry_id] = client hass.data.setdefault(DOMAIN, {})[config_entry.entry_id] = client
await client.async_setup() await hass.config_entries.async_forward_entry_setups(config_entry, PLATFORMS)
client.register_services()
return True return True
async def async_unload_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool: async def async_unload_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool:
"""Unload Transmission Entry from config_entry.""" """Unload Transmission Entry from config_entry."""
client = hass.data[DOMAIN].pop(config_entry.entry_id) client: TransmissionClient = hass.data[DOMAIN].pop(config_entry.entry_id)
if client.unsub_timer: if client.unsub_timer:
client.unsub_timer() client.unsub_timer()
@ -213,41 +217,33 @@ def _get_client(hass: HomeAssistant, data: dict[str, Any]) -> TransmissionClient
class TransmissionClient: class TransmissionClient:
"""Transmission Client Object.""" """Transmission Client Object."""
def __init__(self, hass: HomeAssistant, config_entry: ConfigEntry) -> None: def __init__(
self,
hass: HomeAssistant,
config_entry: ConfigEntry,
api: transmission_rpc.Client,
) -> None:
"""Initialize the Transmission RPC API.""" """Initialize the Transmission RPC API."""
self.hass = hass self.hass = hass
self.config_entry = config_entry self.config_entry = config_entry
self.tm_api: transmission_rpc.Client = None self.tm_api = api
self._tm_data: TransmissionData | None = None self._tm_data = TransmissionData(hass, config_entry, api)
self.unsub_timer: Callable[[], None] | None = None self.unsub_timer: Callable[[], None] | None = None
@property @property
def api(self) -> TransmissionData: def api(self) -> TransmissionData:
"""Return the TransmissionData object.""" """Return the TransmissionData object."""
if self._tm_data is None:
raise HomeAssistantError("data not initialized")
return self._tm_data return self._tm_data
async def async_setup(self) -> None: async def async_setup(self) -> None:
"""Set up the Transmission client.""" """Set up the Transmission client."""
await self.hass.async_add_executor_job(self.api.init_torrent_list)
try: await self.hass.async_add_executor_job(self.api.update)
self.tm_api = await get_api(self.hass, dict(self.config_entry.data))
except CannotConnect as error:
raise ConfigEntryNotReady from error
except (AuthenticationError, UnknownError) as error:
raise ConfigEntryAuthFailed from error
self._tm_data = TransmissionData(self.hass, self.config_entry, self.tm_api)
await self.hass.async_add_executor_job(self._tm_data.init_torrent_list)
await self.hass.async_add_executor_job(self._tm_data.update)
self.add_options() self.add_options()
self.set_scan_interval(self.config_entry.options[CONF_SCAN_INTERVAL]) self.set_scan_interval(self.config_entry.options[CONF_SCAN_INTERVAL])
await self.hass.config_entries.async_forward_entry_setups( def register_services(self) -> None:
self.config_entry, PLATFORMS """Register integration services."""
)
def add_torrent(service: ServiceCall) -> None: def add_torrent(service: ServiceCall) -> None:
"""Add new torrent to download.""" """Add new torrent to download."""
@ -354,7 +350,7 @@ class TransmissionClient:
@staticmethod @staticmethod
async def async_options_updated(hass: HomeAssistant, entry: ConfigEntry) -> None: async def async_options_updated(hass: HomeAssistant, entry: ConfigEntry) -> None:
"""Triggered by config entry options updates.""" """Triggered by config entry options updates."""
tm_client = hass.data[DOMAIN][entry.entry_id] tm_client: TransmissionClient = hass.data[DOMAIN][entry.entry_id]
tm_client.set_scan_interval(entry.options[CONF_SCAN_INTERVAL]) tm_client.set_scan_interval(entry.options[CONF_SCAN_INTERVAL])
await hass.async_add_executor_job(tm_client.api.update) await hass.async_add_executor_job(tm_client.api.update)