Move Transmission services into separate module (#155490)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

homeassistant/components/transmission/__init__.py

@@ -13,12 +13,9 @@ from transmission_rpc.error import (
     TransmissionConnectError,
     TransmissionError,
 )
-import voluptuous as vol
 
-from homeassistant.config_entries import ConfigEntryState
 from homeassistant.const import (
     CONF_HOST,
-    CONF_ID,
     CONF_NAME,
     CONF_PASSWORD,
     CONF_PATH,
@@ -27,35 +24,15 @@ from homeassistant.const import (
     CONF_USERNAME,
     Platform,
 )
-from homeassistant.core import HomeAssistant, ServiceCall, callback
-from homeassistant.exceptions import (
-    ConfigEntryAuthFailed,
-    ConfigEntryNotReady,
-    HomeAssistantError,
-)
-from homeassistant.helpers import (
-    config_validation as cv,
-    entity_registry as er,
-    selector,
-)
+from homeassistant.core import HomeAssistant, callback
+from homeassistant.exceptions import ConfigEntryAuthFailed, ConfigEntryNotReady
+from homeassistant.helpers import config_validation as cv, entity_registry as er
 from homeassistant.helpers.typing import ConfigType
 
-from .const import (
-    ATTR_DELETE_DATA,
-    ATTR_DOWNLOAD_PATH,
-    ATTR_TORRENT,
-    CONF_ENTRY_ID,
-    DEFAULT_DELETE_DATA,
-    DEFAULT_PATH,
-    DEFAULT_SSL,
-    DOMAIN,
-    SERVICE_ADD_TORRENT,
-    SERVICE_REMOVE_TORRENT,
-    SERVICE_START_TORRENT,
-    SERVICE_STOP_TORRENT,
-)
+from .const import DEFAULT_PATH, DEFAULT_SSL, DOMAIN
 from .coordinator import TransmissionConfigEntry, TransmissionDataUpdateCoordinator
 from .errors import AuthenticationError, CannotConnect, UnknownError
+from .services import async_setup_services
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -76,51 +53,13 @@ MIGRATION_NAME_TO_KEY = {
     "Turtle Mode": "turtle_mode",
 }
 
-SERVICE_BASE_SCHEMA = vol.Schema(
-    {
-        vol.Required(CONF_ENTRY_ID): selector.ConfigEntrySelector(
-            {"integration": DOMAIN}
-        ),
-    }
-)
-
-SERVICE_ADD_TORRENT_SCHEMA = vol.All(
-    SERVICE_BASE_SCHEMA.extend(
-        {
-            vol.Required(ATTR_TORRENT): cv.string,
-            vol.Optional(ATTR_DOWNLOAD_PATH): cv.string,
-        }
-    ),
-)
-
-
-SERVICE_REMOVE_TORRENT_SCHEMA = vol.All(
-    SERVICE_BASE_SCHEMA.extend(
-        {
-            vol.Required(CONF_ID): cv.positive_int,
-            vol.Optional(ATTR_DELETE_DATA, default=DEFAULT_DELETE_DATA): cv.boolean,
-        }
-    )
-)
-
-SERVICE_START_TORRENT_SCHEMA = vol.All(
-    SERVICE_BASE_SCHEMA.extend({vol.Required(CONF_ID): cv.positive_int}),
-)
-
-SERVICE_STOP_TORRENT_SCHEMA = vol.All(
-    SERVICE_BASE_SCHEMA.extend(
-        {
-            vol.Required(CONF_ID): cv.positive_int,
-        }
-    )
-)
 
 CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN)
 
 
 async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
     """Set up the Transmission component."""
-    setup_hass_services(hass)
+    async_setup_services(hass)
     return True
 
 
@@ -203,95 +142,6 @@ async def async_migrate_entry(
     return True
 
 
-def _get_coordinator_from_service_data(
-    hass: HomeAssistant, entry_id: str
-) -> TransmissionDataUpdateCoordinator:
-    """Return coordinator for entry id."""
-    entry: TransmissionConfigEntry | None = hass.config_entries.async_get_entry(
-        entry_id
-    )
-    if entry is None or entry.state is not ConfigEntryState.LOADED:
-        raise HomeAssistantError(f"Config entry {entry_id} is not found or not loaded")
-    return entry.runtime_data
-
-
-def setup_hass_services(hass: HomeAssistant) -> None:
-    """Home Assistant services."""
-
-    async def add_torrent(service: ServiceCall) -> None:
-        """Add new torrent to download."""
-        entry_id: str = service.data[CONF_ENTRY_ID]
-        coordinator = _get_coordinator_from_service_data(hass, entry_id)
-        torrent: str = service.data[ATTR_TORRENT]
-        download_path: str | None = service.data.get(ATTR_DOWNLOAD_PATH)
-        if torrent.startswith(
-            ("http", "ftp:", "magnet:")
-        ) or hass.config.is_allowed_path(torrent):
-            if download_path:
-                await hass.async_add_executor_job(
-                    partial(
-                        coordinator.api.add_torrent, torrent, download_dir=download_path
-                    )
-                )
-            else:
-                await hass.async_add_executor_job(coordinator.api.add_torrent, torrent)
-            await coordinator.async_request_refresh()
-        else:
-            _LOGGER.warning("Could not add torrent: unsupported type or no permission")
-
-    async def start_torrent(service: ServiceCall) -> None:
-        """Start torrent."""
-        entry_id: str = service.data[CONF_ENTRY_ID]
-        coordinator = _get_coordinator_from_service_data(hass, entry_id)
-        torrent_id = service.data[CONF_ID]
-        await hass.async_add_executor_job(coordinator.api.start_torrent, torrent_id)
-        await coordinator.async_request_refresh()
-
-    async def stop_torrent(service: ServiceCall) -> None:
-        """Stop torrent."""
-        entry_id: str = service.data[CONF_ENTRY_ID]
-        coordinator = _get_coordinator_from_service_data(hass, entry_id)
-        torrent_id = service.data[CONF_ID]
-        await hass.async_add_executor_job(coordinator.api.stop_torrent, torrent_id)
-        await coordinator.async_request_refresh()
-
-    async def remove_torrent(service: ServiceCall) -> None:
-        """Remove torrent."""
-        entry_id: str = service.data[CONF_ENTRY_ID]
-        coordinator = _get_coordinator_from_service_data(hass, entry_id)
-        torrent_id = service.data[CONF_ID]
-        delete_data = service.data[ATTR_DELETE_DATA]
-        await hass.async_add_executor_job(
-            partial(coordinator.api.remove_torrent, torrent_id, delete_data=delete_data)
-        )
-        await coordinator.async_request_refresh()
-
-    hass.services.async_register(
-        DOMAIN, SERVICE_ADD_TORRENT, add_torrent, schema=SERVICE_ADD_TORRENT_SCHEMA
-    )
-
-    hass.services.async_register(
-        DOMAIN,
-        SERVICE_REMOVE_TORRENT,
-        remove_torrent,
-        schema=SERVICE_REMOVE_TORRENT_SCHEMA,
-    )
-
-    hass.services.async_register(
-        DOMAIN,
-        SERVICE_START_TORRENT,
-        start_torrent,
-        schema=SERVICE_START_TORRENT_SCHEMA,
-    )
-
-    hass.services.async_register(
-        DOMAIN,
-        SERVICE_STOP_TORRENT,
-        stop_torrent,
-        schema=SERVICE_STOP_TORRENT_SCHEMA,
-    )
-
-
 async def get_api(
     hass: HomeAssistant, entry: dict[str, Any]
 ) -> transmission_rpc.Client:

homeassistant/components/transmission/services.py

@@ -0,0 +1,165 @@
+"""Define services for the Transmission integration."""
+
+from functools import partial
+import logging
+
+import voluptuous as vol
+
+from homeassistant.config_entries import ConfigEntryState
+from homeassistant.const import CONF_ID
+from homeassistant.core import HomeAssistant, ServiceCall, callback
+from homeassistant.exceptions import HomeAssistantError
+from homeassistant.helpers import config_validation as cv, selector
+
+from .const import (
+    ATTR_DELETE_DATA,
+    ATTR_DOWNLOAD_PATH,
+    ATTR_TORRENT,
+    CONF_ENTRY_ID,
+    DEFAULT_DELETE_DATA,
+    DOMAIN,
+    SERVICE_ADD_TORRENT,
+    SERVICE_REMOVE_TORRENT,
+    SERVICE_START_TORRENT,
+    SERVICE_STOP_TORRENT,
+)
+from .coordinator import TransmissionConfigEntry, TransmissionDataUpdateCoordinator
+
+_LOGGER = logging.getLogger(__name__)
+
+SERVICE_BASE_SCHEMA = vol.Schema(
+    {
+        vol.Required(CONF_ENTRY_ID): selector.ConfigEntrySelector(
+            {"integration": DOMAIN}
+        ),
+    }
+)
+
+SERVICE_ADD_TORRENT_SCHEMA = vol.All(
+    SERVICE_BASE_SCHEMA.extend(
+        {
+            vol.Required(ATTR_TORRENT): cv.string,
+            vol.Optional(ATTR_DOWNLOAD_PATH): cv.string,
+        }
+    ),
+)
+
+SERVICE_REMOVE_TORRENT_SCHEMA = vol.All(
+    SERVICE_BASE_SCHEMA.extend(
+        {
+            vol.Required(CONF_ID): cv.positive_int,
+            vol.Optional(ATTR_DELETE_DATA, default=DEFAULT_DELETE_DATA): cv.boolean,
+        }
+    )
+)
+
+SERVICE_START_TORRENT_SCHEMA = vol.All(
+    SERVICE_BASE_SCHEMA.extend({vol.Required(CONF_ID): cv.positive_int}),
+)
+
+SERVICE_STOP_TORRENT_SCHEMA = vol.All(
+    SERVICE_BASE_SCHEMA.extend(
+        {
+            vol.Required(CONF_ID): cv.positive_int,
+        }
+    )
+)
+
+
+def _get_coordinator_from_service_data(
+    hass: HomeAssistant, entry_id: str
+) -> TransmissionDataUpdateCoordinator:
+    """Return coordinator for entry id."""
+    entry: TransmissionConfigEntry | None = hass.config_entries.async_get_entry(
+        entry_id
+    )
+    if entry is None or entry.state is not ConfigEntryState.LOADED:
+        raise HomeAssistantError(f"Config entry {entry_id} is not found or not loaded")
+    return entry.runtime_data
+
+
+async def _async_add_torrent(service: ServiceCall) -> None:
+    """Add new torrent to download."""
+    entry_id: str = service.data[CONF_ENTRY_ID]
+    coordinator = _get_coordinator_from_service_data(service.hass, entry_id)
+    torrent: str = service.data[ATTR_TORRENT]
+    download_path: str | None = service.data.get(ATTR_DOWNLOAD_PATH)
+    if torrent.startswith(
+        ("http", "ftp:", "magnet:")
+    ) or service.hass.config.is_allowed_path(torrent):
+        if download_path:
+            await service.hass.async_add_executor_job(
+                partial(
+                    coordinator.api.add_torrent, torrent, download_dir=download_path
+                )
+            )
+        else:
+            await service.hass.async_add_executor_job(
+                coordinator.api.add_torrent, torrent
+            )
+        await coordinator.async_request_refresh()
+    else:
+        _LOGGER.warning("Could not add torrent: unsupported type or no permission")
+
+
+async def _async_start_torrent(service: ServiceCall) -> None:
+    """Start torrent."""
+    entry_id: str = service.data[CONF_ENTRY_ID]
+    coordinator = _get_coordinator_from_service_data(service.hass, entry_id)
+    torrent_id = service.data[CONF_ID]
+    await service.hass.async_add_executor_job(coordinator.api.start_torrent, torrent_id)
+    await coordinator.async_request_refresh()
+
+
+async def _async_stop_torrent(service: ServiceCall) -> None:
+    """Stop torrent."""
+    entry_id: str = service.data[CONF_ENTRY_ID]
+    coordinator = _get_coordinator_from_service_data(service.hass, entry_id)
+    torrent_id = service.data[CONF_ID]
+    await service.hass.async_add_executor_job(coordinator.api.stop_torrent, torrent_id)
+    await coordinator.async_request_refresh()
+
+
+async def _async_remove_torrent(service: ServiceCall) -> None:
+    """Remove torrent."""
+    entry_id: str = service.data[CONF_ENTRY_ID]
+    coordinator = _get_coordinator_from_service_data(service.hass, entry_id)
+    torrent_id = service.data[CONF_ID]
+    delete_data = service.data[ATTR_DELETE_DATA]
+    await service.hass.async_add_executor_job(
+        partial(coordinator.api.remove_torrent, torrent_id, delete_data=delete_data)
+    )
+    await coordinator.async_request_refresh()
+
+
+@callback
+def async_setup_services(hass: HomeAssistant) -> None:
+    """Register services for the Transmission integration."""
+
+    hass.services.async_register(
+        DOMAIN,
+        SERVICE_ADD_TORRENT,
+        _async_add_torrent,
+        schema=SERVICE_ADD_TORRENT_SCHEMA,
+    )
+
+    hass.services.async_register(
+        DOMAIN,
+        SERVICE_REMOVE_TORRENT,
+        _async_remove_torrent,
+        schema=SERVICE_REMOVE_TORRENT_SCHEMA,
+    )
+
+    hass.services.async_register(
+        DOMAIN,
+        SERVICE_START_TORRENT,
+        _async_start_torrent,
+        schema=SERVICE_START_TORRENT_SCHEMA,
+    )
+
+    hass.services.async_register(
+        DOMAIN,
+        SERVICE_STOP_TORRENT,
+        _async_stop_torrent,
+        schema=SERVICE_STOP_TORRENT_SCHEMA,
+    )