diff --git a/.github/workflows/builder.yml b/.github/workflows/builder.yml index dd4bded2cc503b..136f1b83d0673e 100644 --- a/.github/workflows/builder.yml +++ b/.github/workflows/builder.yml @@ -531,7 +531,7 @@ jobs: - name: Generate artifact attestation if: needs.init.outputs.channel != 'dev' && needs.init.outputs.publish == 'true' - uses: actions/attest-build-provenance@db473fddc028af60658334401dc6fa3ffd8669fd # v2.3.0 + uses: actions/attest-build-provenance@e8998f949152b193b063cb0ec769d69d929409be # v2.4.0 with: subject-name: ${{ env.HASSFEST_IMAGE_NAME }} subject-digest: ${{ steps.push.outputs.digest }} diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index 36902d13356bc2..583cfdd211c8cf 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -24,11 +24,11 @@ jobs: uses: actions/checkout@v4.2.2 - name: Initialize CodeQL - uses: github/codeql-action/init@v3.28.19 + uses: github/codeql-action/init@v3.29.0 with: languages: python - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v3.28.19 + uses: github/codeql-action/analyze@v3.29.0 with: category: "/language:python" diff --git a/.github/workflows/detect-duplicate-issues.yml b/.github/workflows/detect-duplicate-issues.yml index 509868541fd165..b01a0d68352a42 100644 --- a/.github/workflows/detect-duplicate-issues.yml +++ b/.github/workflows/detect-duplicate-issues.yml @@ -133,12 +133,18 @@ jobs: // Build search query for issues with any of the current integration labels const labelQueries = integrationLabels.map(label => `label:"${label}"`); + + // Calculate date 6 months ago + const sixMonthsAgo = new Date(); + sixMonthsAgo.setMonth(sixMonthsAgo.getMonth() - 6); + const dateFilter = `created:>=${sixMonthsAgo.toISOString().split('T')[0]}`; + let searchQuery; if (labelQueries.length === 1) { - searchQuery = `repo:${context.repo.owner}/${context.repo.repo} is:issue ${labelQueries[0]}`; + searchQuery = `repo:${context.repo.owner}/${context.repo.repo} is:issue ${labelQueries[0]} ${dateFilter}`; } else { - searchQuery = `repo:${context.repo.owner}/${context.repo.repo} is:issue (${labelQueries.join(' OR ')})`; + searchQuery = `repo:${context.repo.owner}/${context.repo.repo} is:issue (${labelQueries.join(' OR ')}) ${dateFilter}`; } console.log(`Search query: ${searchQuery}`); @@ -227,29 +233,34 @@ jobs: if: steps.extract.outputs.should_continue == 'true' && steps.fetch_similar.outputs.has_similar == 'true' uses: actions/ai-inference@v1.1.0 with: - model: openai/gpt-4o-mini + model: openai/gpt-4o system-prompt: | - You are a Home Assistant issue duplicate detector. Your task is to identify potential duplicate issues based on their content. + You are a Home Assistant issue duplicate detector. Your task is to identify TRUE DUPLICATES - issues that report the EXACT SAME problem, not just similar or related issues. + + CRITICAL: An issue is ONLY a duplicate if: + - It describes the SAME problem with the SAME root cause + - Issues about the same integration but different problems are NOT duplicates + - Issues with similar symptoms but different causes are NOT duplicates Important considerations: - Open issues are more relevant than closed ones for duplicate detection - Recently updated issues may indicate ongoing work or discussion - Issues with more comments are generally more relevant and active - - Higher comment count often indicates community engagement and importance - Older closed issues might be resolved differently than newer approaches - Consider the time between issues - very old issues may have different contexts Rules: - 1. Compare the current issue with the provided similar issues + 1. ONLY mark as duplicate if the issues describe IDENTICAL problems 2. Look for issues that report the same problem or request the same functionality - 3. Consider different wording but same underlying issue as duplicates + 3. Different error messages = NOT a duplicate (even if same integration) 4. For CLOSED issues, only mark as duplicate if they describe the EXACT same problem - 5. For OPEN issues, use a lower threshold (70%+ similarity) + 5. For OPEN issues, use a lower threshold (90%+ similarity) 6. Prioritize issues with higher comment counts as they indicate more activity/relevance - 7. Return ONLY a JSON array of issue numbers that are potential duplicates - 8. If no duplicates are found, return an empty array: [] - 9. Maximum 5 potential duplicates, prioritize open issues with comments - 10. Consider the age of issues - prefer recent duplicates over very old ones + 7. When in doubt, do NOT mark as duplicate + 8. Return ONLY a JSON array of issue numbers that are duplicates + 9. If no duplicates are found, return an empty array: [] + 10. Maximum 5 potential duplicates, prioritize open issues with comments + 11. Consider the age of issues - prefer recent duplicates over very old ones Example response format: [1234, 5678, 9012] @@ -259,10 +270,10 @@ jobs: Title: ${{ steps.extract.outputs.current_title }} Body: ${{ steps.extract.outputs.current_body }} - Similar issues to compare against (each includes state, creation date, last update, and comment count): + Other issues to compare against (each includes state, creation date, last update, and comment count): ${{ steps.fetch_similar.outputs.similar_issues }} - Analyze these issues and identify which ones are potential duplicates of the current issue. Consider their state (open/closed), how recently they were updated, and their comment count (higher = more relevant). + Analyze these issues and identify which ones describe IDENTICAL problems and thus are duplicates of the current issue. When sorting them, consider their state (open/closed), how recently they were updated, and their comment count (higher = more relevant). max-tokens: 100 diff --git a/homeassistant/components/fritz/__init__.py b/homeassistant/components/fritz/__init__.py index 9610fe4b34d39e..faf82b4b516ada 100644 --- a/homeassistant/components/fritz/__init__.py +++ b/homeassistant/components/fritz/__init__.py @@ -33,7 +33,7 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: """Set up fritzboxtools integration.""" - await async_setup_services(hass) + async_setup_services(hass) return True diff --git a/homeassistant/components/fritz/services.py b/homeassistant/components/fritz/services.py index 02e6c91f4bfbaf..bba80eadf984bb 100644 --- a/homeassistant/components/fritz/services.py +++ b/homeassistant/components/fritz/services.py @@ -10,7 +10,7 @@ from fritzconnection.lib.fritzwlan import DEFAULT_PASSWORD_LENGTH import voluptuous as vol -from homeassistant.core import HomeAssistant, ServiceCall +from homeassistant.core import HomeAssistant, ServiceCall, callback from homeassistant.exceptions import HomeAssistantError, ServiceValidationError from homeassistant.helpers.service import async_extract_config_entry_ids @@ -64,7 +64,8 @@ async def _async_set_guest_wifi_password(service_call: ServiceCall) -> None: ) from ex -async def async_setup_services(hass: HomeAssistant) -> None: +@callback +def async_setup_services(hass: HomeAssistant) -> None: """Set up services for Fritz integration.""" hass.services.async_register( diff --git a/homeassistant/components/homematicip_cloud/__init__.py b/homeassistant/components/homematicip_cloud/__init__.py index 9cf9ab28db71a2..30038d1f8977ed 100644 --- a/homeassistant/components/homematicip_cloud/__init__.py +++ b/homeassistant/components/homematicip_cloud/__init__.py @@ -63,7 +63,7 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: ) ) - await async_setup_services(hass) + async_setup_services(hass) return True diff --git a/homeassistant/components/homematicip_cloud/services.py b/homeassistant/components/homematicip_cloud/services.py index a0308b14d7e324..1cfb3a55552b13 100644 --- a/homeassistant/components/homematicip_cloud/services.py +++ b/homeassistant/components/homematicip_cloud/services.py @@ -12,7 +12,7 @@ import voluptuous as vol from homeassistant.const import ATTR_ENTITY_ID, ATTR_TEMPERATURE -from homeassistant.core import HomeAssistant, ServiceCall +from homeassistant.core import HomeAssistant, ServiceCall, callback from homeassistant.exceptions import ServiceValidationError from homeassistant.helpers import config_validation as cv from homeassistant.helpers.config_validation import comp_entity_ids @@ -120,7 +120,8 @@ ) -async def async_setup_services(hass: HomeAssistant) -> None: +@callback +def async_setup_services(hass: HomeAssistant) -> None: """Set up the HomematicIP Cloud services.""" @verify_domain_control(hass, DOMAIN) diff --git a/homeassistant/components/lifx/manager.py b/homeassistant/components/lifx/manager.py index 887bc3c3527f67..9fae2628f1dc73 100644 --- a/homeassistant/components/lifx/manager.py +++ b/homeassistant/components/lifx/manager.py @@ -5,7 +5,7 @@ import asyncio from collections.abc import Callable from datetime import timedelta -from typing import Any +from typing import TYPE_CHECKING, Any import aiolifx_effects from aiolifx_themes.painter import ThemePainter @@ -31,9 +31,12 @@ from homeassistant.helpers.service import async_extract_referenced_entity_ids from .const import _ATTR_COLOR_TEMP, ATTR_THEME, DATA_LIFX_MANAGER, DOMAIN -from .coordinator import LIFXUpdateCoordinator, Light +from .coordinator import LIFXUpdateCoordinator from .util import convert_8_to_16, find_hsbk +if TYPE_CHECKING: + from aiolifx.aiolifx import Light + SCAN_INTERVAL = timedelta(seconds=10) SERVICE_EFFECT_COLORLOOP = "effect_colorloop" @@ -426,8 +429,8 @@ async def _start_effect_sky( ) -> None: """Start the firmware-based Sky effect.""" palette = kwargs.get(ATTR_PALETTE) + theme = Theme() if palette is not None: - theme = Theme() for hsbk in palette: theme.add_hsbk(hsbk[0], hsbk[1], hsbk[2], hsbk[3]) diff --git a/homeassistant/components/mealie/__init__.py b/homeassistant/components/mealie/__init__.py index e019dae2c33b57..0221fd45051a96 100644 --- a/homeassistant/components/mealie/__init__.py +++ b/homeassistant/components/mealie/__init__.py @@ -24,7 +24,7 @@ MealieShoppingListCoordinator, MealieStatisticsCoordinator, ) -from .services import setup_services +from .services import async_setup_services from .utils import create_version PLATFORMS: list[Platform] = [Platform.CALENDAR, Platform.SENSOR, Platform.TODO] @@ -34,7 +34,7 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: """Set up the Mealie component.""" - setup_services(hass) + async_setup_services(hass) return True diff --git a/homeassistant/components/mealie/services.py b/homeassistant/components/mealie/services.py index 15e3348adbefdd..0d9a29392a4f7f 100644 --- a/homeassistant/components/mealie/services.py +++ b/homeassistant/components/mealie/services.py @@ -19,6 +19,7 @@ ServiceCall, ServiceResponse, SupportsResponse, + callback, ) from homeassistant.exceptions import HomeAssistantError, ServiceValidationError from homeassistant.helpers import config_validation as cv @@ -98,9 +99,10 @@ ) -def async_get_entry(hass: HomeAssistant, config_entry_id: str) -> MealieConfigEntry: +def _async_get_entry(call: ServiceCall) -> MealieConfigEntry: """Get the Mealie config entry.""" - if not (entry := hass.config_entries.async_get_entry(config_entry_id)): + config_entry_id: str = call.data[ATTR_CONFIG_ENTRY_ID] + if not (entry := call.hass.config_entries.async_get_entry(config_entry_id)): raise ServiceValidationError( translation_domain=DOMAIN, translation_key="integration_not_found", @@ -115,143 +117,149 @@ def async_get_entry(hass: HomeAssistant, config_entry_id: str) -> MealieConfigEn return cast(MealieConfigEntry, entry) -def setup_services(hass: HomeAssistant) -> None: - """Set up the services for the Mealie integration.""" +async def _async_get_mealplan(call: ServiceCall) -> ServiceResponse: + """Get the mealplan for a specific range.""" + entry = _async_get_entry(call) + start_date = call.data.get(ATTR_START_DATE, date.today()) + end_date = call.data.get(ATTR_END_DATE, date.today()) + if end_date < start_date: + raise ServiceValidationError( + translation_domain=DOMAIN, + translation_key="end_date_before_start_date", + ) + client = entry.runtime_data.client + try: + mealplans = await client.get_mealplans(start_date, end_date) + except MealieConnectionError as err: + raise HomeAssistantError( + translation_domain=DOMAIN, + translation_key="connection_error", + ) from err + return {"mealplan": [asdict(x) for x in mealplans.items]} + + +async def _async_get_recipe(call: ServiceCall) -> ServiceResponse: + """Get a recipe.""" + entry = _async_get_entry(call) + recipe_id = call.data[ATTR_RECIPE_ID] + client = entry.runtime_data.client + try: + recipe = await client.get_recipe(recipe_id) + except MealieConnectionError as err: + raise HomeAssistantError( + translation_domain=DOMAIN, + translation_key="connection_error", + ) from err + except MealieNotFoundError as err: + raise ServiceValidationError( + translation_domain=DOMAIN, + translation_key="recipe_not_found", + translation_placeholders={"recipe_id": recipe_id}, + ) from err + return {"recipe": asdict(recipe)} - async def async_get_mealplan(call: ServiceCall) -> ServiceResponse: - """Get the mealplan for a specific range.""" - entry = async_get_entry(hass, call.data[ATTR_CONFIG_ENTRY_ID]) - start_date = call.data.get(ATTR_START_DATE, date.today()) - end_date = call.data.get(ATTR_END_DATE, date.today()) - if end_date < start_date: - raise ServiceValidationError( - translation_domain=DOMAIN, - translation_key="end_date_before_start_date", - ) - client = entry.runtime_data.client - try: - mealplans = await client.get_mealplans(start_date, end_date) - except MealieConnectionError as err: - raise HomeAssistantError( - translation_domain=DOMAIN, - translation_key="connection_error", - ) from err - return {"mealplan": [asdict(x) for x in mealplans.items]} - async def async_get_recipe(call: ServiceCall) -> ServiceResponse: - """Get a recipe.""" - entry = async_get_entry(hass, call.data[ATTR_CONFIG_ENTRY_ID]) - recipe_id = call.data[ATTR_RECIPE_ID] - client = entry.runtime_data.client - try: - recipe = await client.get_recipe(recipe_id) - except MealieConnectionError as err: - raise HomeAssistantError( - translation_domain=DOMAIN, - translation_key="connection_error", - ) from err - except MealieNotFoundError as err: - raise ServiceValidationError( - translation_domain=DOMAIN, - translation_key="recipe_not_found", - translation_placeholders={"recipe_id": recipe_id}, - ) from err +async def _async_import_recipe(call: ServiceCall) -> ServiceResponse: + """Import a recipe.""" + entry = _async_get_entry(call) + url = call.data[ATTR_URL] + include_tags = call.data.get(ATTR_INCLUDE_TAGS, False) + client = entry.runtime_data.client + try: + recipe = await client.import_recipe(url, include_tags) + except MealieValidationError as err: + raise ServiceValidationError( + translation_domain=DOMAIN, + translation_key="could_not_import_recipe", + ) from err + except MealieConnectionError as err: + raise HomeAssistantError( + translation_domain=DOMAIN, + translation_key="connection_error", + ) from err + if call.return_response: return {"recipe": asdict(recipe)} + return None + + +async def _async_set_random_mealplan(call: ServiceCall) -> ServiceResponse: + """Set a random mealplan.""" + entry = _async_get_entry(call) + mealplan_date = call.data[ATTR_DATE] + entry_type = MealplanEntryType(call.data[ATTR_ENTRY_TYPE]) + client = entry.runtime_data.client + try: + mealplan = await client.random_mealplan(mealplan_date, entry_type) + except MealieConnectionError as err: + raise HomeAssistantError( + translation_domain=DOMAIN, + translation_key="connection_error", + ) from err + if call.return_response: + return {"mealplan": asdict(mealplan)} + return None - async def async_import_recipe(call: ServiceCall) -> ServiceResponse: - """Import a recipe.""" - entry = async_get_entry(hass, call.data[ATTR_CONFIG_ENTRY_ID]) - url = call.data[ATTR_URL] - include_tags = call.data.get(ATTR_INCLUDE_TAGS, False) - client = entry.runtime_data.client - try: - recipe = await client.import_recipe(url, include_tags) - except MealieValidationError as err: - raise ServiceValidationError( - translation_domain=DOMAIN, - translation_key="could_not_import_recipe", - ) from err - except MealieConnectionError as err: - raise HomeAssistantError( - translation_domain=DOMAIN, - translation_key="connection_error", - ) from err - if call.return_response: - return {"recipe": asdict(recipe)} - return None - async def async_set_random_mealplan(call: ServiceCall) -> ServiceResponse: - """Set a random mealplan.""" - entry = async_get_entry(hass, call.data[ATTR_CONFIG_ENTRY_ID]) - mealplan_date = call.data[ATTR_DATE] - entry_type = MealplanEntryType(call.data[ATTR_ENTRY_TYPE]) - client = entry.runtime_data.client - try: - mealplan = await client.random_mealplan(mealplan_date, entry_type) - except MealieConnectionError as err: - raise HomeAssistantError( - translation_domain=DOMAIN, - translation_key="connection_error", - ) from err - if call.return_response: - return {"mealplan": asdict(mealplan)} - return None +async def _async_set_mealplan(call: ServiceCall) -> ServiceResponse: + """Set a mealplan.""" + entry = _async_get_entry(call) + mealplan_date = call.data[ATTR_DATE] + entry_type = MealplanEntryType(call.data[ATTR_ENTRY_TYPE]) + client = entry.runtime_data.client + try: + mealplan = await client.set_mealplan( + mealplan_date, + entry_type, + recipe_id=call.data.get(ATTR_RECIPE_ID), + note_title=call.data.get(ATTR_NOTE_TITLE), + note_text=call.data.get(ATTR_NOTE_TEXT), + ) + except MealieConnectionError as err: + raise HomeAssistantError( + translation_domain=DOMAIN, + translation_key="connection_error", + ) from err + if call.return_response: + return {"mealplan": asdict(mealplan)} + return None - async def async_set_mealplan(call: ServiceCall) -> ServiceResponse: - """Set a mealplan.""" - entry = async_get_entry(hass, call.data[ATTR_CONFIG_ENTRY_ID]) - mealplan_date = call.data[ATTR_DATE] - entry_type = MealplanEntryType(call.data[ATTR_ENTRY_TYPE]) - client = entry.runtime_data.client - try: - mealplan = await client.set_mealplan( - mealplan_date, - entry_type, - recipe_id=call.data.get(ATTR_RECIPE_ID), - note_title=call.data.get(ATTR_NOTE_TITLE), - note_text=call.data.get(ATTR_NOTE_TEXT), - ) - except MealieConnectionError as err: - raise HomeAssistantError( - translation_domain=DOMAIN, - translation_key="connection_error", - ) from err - if call.return_response: - return {"mealplan": asdict(mealplan)} - return None + +@callback +def async_setup_services(hass: HomeAssistant) -> None: + """Set up the services for the Mealie integration.""" hass.services.async_register( DOMAIN, SERVICE_GET_MEALPLAN, - async_get_mealplan, + _async_get_mealplan, schema=SERVICE_GET_MEALPLAN_SCHEMA, supports_response=SupportsResponse.ONLY, ) hass.services.async_register( DOMAIN, SERVICE_GET_RECIPE, - async_get_recipe, + _async_get_recipe, schema=SERVICE_GET_RECIPE_SCHEMA, supports_response=SupportsResponse.ONLY, ) hass.services.async_register( DOMAIN, SERVICE_IMPORT_RECIPE, - async_import_recipe, + _async_import_recipe, schema=SERVICE_IMPORT_RECIPE_SCHEMA, supports_response=SupportsResponse.OPTIONAL, ) hass.services.async_register( DOMAIN, SERVICE_SET_RANDOM_MEALPLAN, - async_set_random_mealplan, + _async_set_random_mealplan, schema=SERVICE_SET_RANDOM_MEALPLAN_SCHEMA, supports_response=SupportsResponse.OPTIONAL, ) hass.services.async_register( DOMAIN, SERVICE_SET_MEALPLAN, - async_set_mealplan, + _async_set_mealplan, schema=SERVICE_SET_MEALPLAN_SCHEMA, supports_response=SupportsResponse.OPTIONAL, ) diff --git a/homeassistant/components/netgear_lte/__init__.py b/homeassistant/components/netgear_lte/__init__.py index 47a39a39be08ed..a6df67a7c83b6d 100644 --- a/homeassistant/components/netgear_lte/__init__.py +++ b/homeassistant/components/netgear_lte/__init__.py @@ -96,7 +96,7 @@ def fire_sms_event(sms: SMS) -> None: await coordinator.async_config_entry_first_refresh() entry.runtime_data = coordinator - await async_setup_services(hass, modem) + async_setup_services(hass) await discovery.async_load_platform( hass, diff --git a/homeassistant/components/netgear_lte/services.py b/homeassistant/components/netgear_lte/services.py index 77ed1b91f31fe4..5cac48c26343c0 100644 --- a/homeassistant/components/netgear_lte/services.py +++ b/homeassistant/components/netgear_lte/services.py @@ -1,9 +1,9 @@ """Services for the Netgear LTE integration.""" -from eternalegypt.eternalegypt import Modem import voluptuous as vol -from homeassistant.core import HomeAssistant, ServiceCall +from homeassistant.const import CONF_HOST +from homeassistant.core import HomeAssistant, ServiceCall, callback from homeassistant.helpers import config_validation as cv from .const import ( @@ -16,6 +16,7 @@ FAILOVER_MODES, LOGGER, ) +from .coordinator import NetgearLTEConfigEntry SERVICE_DELETE_SMS = "delete_sms" SERVICE_SET_OPTION = "set_option" @@ -45,29 +46,36 @@ DISCONNECT_LTE_SCHEMA = vol.Schema({vol.Optional(ATTR_HOST): cv.string}) -async def async_setup_services(hass: HomeAssistant, modem: Modem) -> None: - """Set up services for Netgear LTE integration.""" +async def _service_handler(call: ServiceCall) -> None: + """Apply a service.""" + host = call.data.get(ATTR_HOST) + + entry: NetgearLTEConfigEntry | None = None + for entry in call.hass.config_entries.async_loaded_entries(DOMAIN): + if entry.data.get(CONF_HOST) == host: + break + + if not entry or not (modem := entry.runtime_data.modem).token: + LOGGER.error("%s: host %s unavailable", call.service, host) + return - async def service_handler(call: ServiceCall) -> None: - """Apply a service.""" - host = call.data.get(ATTR_HOST) - - if not modem.token: - LOGGER.error("%s: host %s unavailable", call.service, host) - return - - if call.service == SERVICE_DELETE_SMS: - for sms_id in call.data[ATTR_SMS_ID]: - await modem.delete_sms(sms_id) - elif call.service == SERVICE_SET_OPTION: - if failover := call.data.get(ATTR_FAILOVER): - await modem.set_failover_mode(failover) - if autoconnect := call.data.get(ATTR_AUTOCONNECT): - await modem.set_autoconnect_mode(autoconnect) - elif call.service == SERVICE_CONNECT_LTE: - await modem.connect_lte() - elif call.service == SERVICE_DISCONNECT_LTE: - await modem.disconnect_lte() + if call.service == SERVICE_DELETE_SMS: + for sms_id in call.data[ATTR_SMS_ID]: + await modem.delete_sms(sms_id) + elif call.service == SERVICE_SET_OPTION: + if failover := call.data.get(ATTR_FAILOVER): + await modem.set_failover_mode(failover) + if autoconnect := call.data.get(ATTR_AUTOCONNECT): + await modem.set_autoconnect_mode(autoconnect) + elif call.service == SERVICE_CONNECT_LTE: + await modem.connect_lte() + elif call.service == SERVICE_DISCONNECT_LTE: + await modem.disconnect_lte() + + +@callback +def async_setup_services(hass: HomeAssistant) -> None: + """Set up services for Netgear LTE integration.""" service_schemas = { SERVICE_DELETE_SMS: DELETE_SMS_SCHEMA, @@ -77,4 +85,4 @@ async def service_handler(call: ServiceCall) -> None: } for service, schema in service_schemas.items(): - hass.services.async_register(DOMAIN, service, service_handler, schema=schema) + hass.services.async_register(DOMAIN, service, _service_handler, schema=schema) diff --git a/homeassistant/components/overseerr/__init__.py b/homeassistant/components/overseerr/__init__.py index 597d44f66cf4ae..3e7b5f322729f1 100644 --- a/homeassistant/components/overseerr/__init__.py +++ b/homeassistant/components/overseerr/__init__.py @@ -25,7 +25,7 @@ from .const import DOMAIN, EVENT_KEY, JSON_PAYLOAD, LOGGER, REGISTERED_NOTIFICATIONS from .coordinator import OverseerrConfigEntry, OverseerrCoordinator -from .services import setup_services +from .services import async_setup_services PLATFORMS: list[Platform] = [Platform.EVENT, Platform.SENSOR] CONF_CLOUDHOOK_URL = "cloudhook_url" @@ -35,7 +35,7 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: """Set up the Overseerr component.""" - setup_services(hass) + async_setup_services(hass) return True diff --git a/homeassistant/components/overseerr/services.py b/homeassistant/components/overseerr/services.py index 4631e578af8644..4e72f5556033dd 100644 --- a/homeassistant/components/overseerr/services.py +++ b/homeassistant/components/overseerr/services.py @@ -12,6 +12,7 @@ ServiceCall, ServiceResponse, SupportsResponse, + callback, ) from homeassistant.exceptions import HomeAssistantError, ServiceValidationError from homeassistant.util.json import JsonValueType @@ -39,7 +40,7 @@ ) -def async_get_entry(hass: HomeAssistant, config_entry_id: str) -> OverseerrConfigEntry: +def _async_get_entry(hass: HomeAssistant, config_entry_id: str) -> OverseerrConfigEntry: """Get the Overseerr config entry.""" if not (entry := hass.config_entries.async_get_entry(config_entry_id)): raise ServiceValidationError( @@ -56,7 +57,7 @@ def async_get_entry(hass: HomeAssistant, config_entry_id: str) -> OverseerrConfi return cast(OverseerrConfigEntry, entry) -async def get_media( +async def _get_media( client: OverseerrClient, media_type: str, identifier: int ) -> dict[str, Any]: """Get media details.""" @@ -73,43 +74,45 @@ async def get_media( return media -def setup_services(hass: HomeAssistant) -> None: - """Set up the services for the Overseerr integration.""" +async def _async_get_requests(call: ServiceCall) -> ServiceResponse: + """Get requests made to Overseerr.""" + entry = _async_get_entry(call.hass, call.data[ATTR_CONFIG_ENTRY_ID]) + client = entry.runtime_data.client + kwargs: dict[str, Any] = {} + if status := call.data.get(ATTR_STATUS): + kwargs["status"] = status + if sort_order := call.data.get(ATTR_SORT_ORDER): + kwargs["sort"] = sort_order + if requested_by := call.data.get(ATTR_REQUESTED_BY): + kwargs["requested_by"] = requested_by + try: + requests = await client.get_requests(**kwargs) + except OverseerrConnectionError as err: + raise HomeAssistantError( + translation_domain=DOMAIN, + translation_key="connection_error", + translation_placeholders={"error": str(err)}, + ) from err + result: list[dict[str, Any]] = [] + for request in requests: + req = asdict(request) + assert request.media.tmdb_id + req["media"] = await _get_media( + client, request.media.media_type, request.media.tmdb_id + ) + result.append(req) + + return {"requests": cast(list[JsonValueType], result)} - async def async_get_requests(call: ServiceCall) -> ServiceResponse: - """Get requests made to Overseerr.""" - entry = async_get_entry(hass, call.data[ATTR_CONFIG_ENTRY_ID]) - client = entry.runtime_data.client - kwargs: dict[str, Any] = {} - if status := call.data.get(ATTR_STATUS): - kwargs["status"] = status - if sort_order := call.data.get(ATTR_SORT_ORDER): - kwargs["sort"] = sort_order - if requested_by := call.data.get(ATTR_REQUESTED_BY): - kwargs["requested_by"] = requested_by - try: - requests = await client.get_requests(**kwargs) - except OverseerrConnectionError as err: - raise HomeAssistantError( - translation_domain=DOMAIN, - translation_key="connection_error", - translation_placeholders={"error": str(err)}, - ) from err - result: list[dict[str, Any]] = [] - for request in requests: - req = asdict(request) - assert request.media.tmdb_id - req["media"] = await get_media( - client, request.media.media_type, request.media.tmdb_id - ) - result.append(req) - return {"requests": cast(list[JsonValueType], result)} +@callback +def async_setup_services(hass: HomeAssistant) -> None: + """Set up the services for the Overseerr integration.""" hass.services.async_register( DOMAIN, SERVICE_GET_REQUESTS, - async_get_requests, + _async_get_requests, schema=SERVICE_GET_REQUESTS_SCHEMA, supports_response=SupportsResponse.ONLY, ) diff --git a/homeassistant/components/plex/__init__.py b/homeassistant/components/plex/__init__.py index eb57dc46727b21..bc117e4c7f4497 100644 --- a/homeassistant/components/plex/__init__.py +++ b/homeassistant/components/plex/__init__.py @@ -105,7 +105,7 @@ def gdm_scan(): ) hass.data.setdefault(DOMAIN, hass_data) - await async_setup_services(hass) + async_setup_services(hass) hass.http.register_view(PlexImageView()) diff --git a/homeassistant/components/plex/services.py b/homeassistant/components/plex/services.py index 6412a4c3927a2b..1ff7820a2c0d0b 100644 --- a/homeassistant/components/plex/services.py +++ b/homeassistant/components/plex/services.py @@ -7,7 +7,7 @@ import voluptuous as vol from yarl import URL -from homeassistant.core import HomeAssistant, ServiceCall +from homeassistant.core import HomeAssistant, ServiceCall, callback from homeassistant.exceptions import HomeAssistantError from .const import DOMAIN, PLEX_URI_SCHEME, SERVERS, SERVICE_REFRESH_LIBRARY @@ -23,7 +23,8 @@ _LOGGER = logging.getLogger(__package__) -async def async_setup_services(hass: HomeAssistant) -> None: +@callback +def async_setup_services(hass: HomeAssistant) -> None: """Set up services for the Plex component.""" async def async_refresh_library_service(service_call: ServiceCall) -> None: diff --git a/homeassistant/components/screenlogic/__init__.py b/homeassistant/components/screenlogic/__init__.py index 972837f7d75c37..c6e4f0c279c934 100644 --- a/homeassistant/components/screenlogic/__init__.py +++ b/homeassistant/components/screenlogic/__init__.py @@ -18,7 +18,7 @@ from .const import DOMAIN from .coordinator import ScreenlogicDataUpdateCoordinator, async_get_connect_info from .data import ENTITY_MIGRATIONS -from .services import async_load_screenlogic_services +from .services import async_setup_services from .util import generate_unique_id type ScreenLogicConfigEntry = ConfigEntry[ScreenlogicDataUpdateCoordinator] @@ -48,7 +48,7 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: """Set up Screenlogic.""" - async_load_screenlogic_services(hass) + async_setup_services(hass) return True diff --git a/homeassistant/components/screenlogic/services.py b/homeassistant/components/screenlogic/services.py index 44d8ad3ed81a91..3901f1cfd37ed4 100644 --- a/homeassistant/components/screenlogic/services.py +++ b/homeassistant/components/screenlogic/services.py @@ -54,105 +54,110 @@ ) -@callback -def async_load_screenlogic_services(hass: HomeAssistant): - """Set up services for the ScreenLogic integration.""" - - async def get_coordinators( - service_call: ServiceCall, - ) -> list[ScreenlogicDataUpdateCoordinator]: - entry_ids = {service_call.data[ATTR_CONFIG_ENTRY]} - coordinators: list[ScreenlogicDataUpdateCoordinator] = [] - for entry_id in entry_ids: - config_entry = cast( - ScreenLogicConfigEntry | None, - hass.config_entries.async_get_entry(entry_id), +async def _get_coordinators( + service_call: ServiceCall, +) -> list[ScreenlogicDataUpdateCoordinator]: + entry_ids = {service_call.data[ATTR_CONFIG_ENTRY]} + coordinators: list[ScreenlogicDataUpdateCoordinator] = [] + for entry_id in entry_ids: + config_entry = cast( + ScreenLogicConfigEntry | None, + service_call.hass.config_entries.async_get_entry(entry_id), + ) + if not config_entry: + raise ServiceValidationError( + f"Failed to call service '{service_call.service}'. Config entry " + f"'{entry_id}' not found" + ) + if not config_entry.domain == DOMAIN: + raise ServiceValidationError( + f"Failed to call service '{service_call.service}'. Config entry " + f"'{entry_id}' is not a {DOMAIN} config" ) - if not config_entry: - raise ServiceValidationError( - f"Failed to call service '{service_call.service}'. Config entry " - f"'{entry_id}' not found" - ) - if not config_entry.domain == DOMAIN: - raise ServiceValidationError( - f"Failed to call service '{service_call.service}'. Config entry " - f"'{entry_id}' is not a {DOMAIN} config" - ) - if not config_entry.state == ConfigEntryState.LOADED: - raise ServiceValidationError( - f"Failed to call service '{service_call.service}'. Config entry " - f"'{entry_id}' not loaded" - ) - coordinators.append(config_entry.runtime_data) - - return coordinators - - async def async_set_color_mode(service_call: ServiceCall) -> None: - color_num = SUPPORTED_COLOR_MODES[service_call.data[ATTR_COLOR_MODE]] - coordinator: ScreenlogicDataUpdateCoordinator - for coordinator in await get_coordinators(service_call): - _LOGGER.debug( - "Service %s called on %s with mode %s", - SERVICE_SET_COLOR_MODE, - coordinator.gateway.name, - color_num, + if not config_entry.state == ConfigEntryState.LOADED: + raise ServiceValidationError( + f"Failed to call service '{service_call.service}'. Config entry " + f"'{entry_id}' not loaded" ) - try: - await coordinator.gateway.async_set_color_lights(color_num) - # Debounced refresh to catch any secondary changes in the device - await coordinator.async_request_refresh() - except ScreenLogicError as error: - raise HomeAssistantError(error) from error - - async def async_set_super_chlor( - service_call: ServiceCall, - is_on: bool, - runtime: int | None = None, - ) -> None: - coordinator: ScreenlogicDataUpdateCoordinator - for coordinator in await get_coordinators(service_call): - if EQUIPMENT_FLAG.CHLORINATOR not in coordinator.gateway.equipment_flags: - raise ServiceValidationError( - f"Equipment configuration for {coordinator.gateway.name} does not" - f" support {service_call.service}" - ) - rt_log = f" with runtime {runtime}" if runtime else "" - _LOGGER.debug( - "Service %s called on %s%s", - service_call.service, - coordinator.gateway.name, - rt_log, + coordinators.append(config_entry.runtime_data) + + return coordinators + + +async def _async_set_color_mode(service_call: ServiceCall) -> None: + color_num = SUPPORTED_COLOR_MODES[service_call.data[ATTR_COLOR_MODE]] + coordinator: ScreenlogicDataUpdateCoordinator + for coordinator in await _get_coordinators(service_call): + _LOGGER.debug( + "Service %s called on %s with mode %s", + SERVICE_SET_COLOR_MODE, + coordinator.gateway.name, + color_num, + ) + try: + await coordinator.gateway.async_set_color_lights(color_num) + # Debounced refresh to catch any secondary changes in the device + await coordinator.async_request_refresh() + except ScreenLogicError as error: + raise HomeAssistantError(error) from error + + +async def _async_set_super_chlor( + service_call: ServiceCall, + is_on: bool, + runtime: int | None = None, +) -> None: + coordinator: ScreenlogicDataUpdateCoordinator + for coordinator in await _get_coordinators(service_call): + if EQUIPMENT_FLAG.CHLORINATOR not in coordinator.gateway.equipment_flags: + raise ServiceValidationError( + f"Equipment configuration for {coordinator.gateway.name} does not" + f" support {service_call.service}" ) - try: - await coordinator.gateway.async_set_scg_config( - super_chlor_timer=runtime, super_chlorinate=is_on - ) - # Debounced refresh to catch any secondary changes in the device - await coordinator.async_request_refresh() - except ScreenLogicError as error: - raise HomeAssistantError(error) from error - - async def async_start_super_chlor(service_call: ServiceCall) -> None: - runtime = service_call.data[ATTR_RUNTIME] - await async_set_super_chlor(service_call, True, runtime) - - async def async_stop_super_chlor(service_call: ServiceCall) -> None: - await async_set_super_chlor(service_call, False) + rt_log = f" with runtime {runtime}" if runtime else "" + _LOGGER.debug( + "Service %s called on %s%s", + service_call.service, + coordinator.gateway.name, + rt_log, + ) + try: + await coordinator.gateway.async_set_scg_config( + super_chlor_timer=runtime, super_chlorinate=is_on + ) + # Debounced refresh to catch any secondary changes in the device + await coordinator.async_request_refresh() + except ScreenLogicError as error: + raise HomeAssistantError(error) from error + + +async def _async_start_super_chlor(service_call: ServiceCall) -> None: + runtime = service_call.data[ATTR_RUNTIME] + await _async_set_super_chlor(service_call, True, runtime) + + +async def _async_stop_super_chlor(service_call: ServiceCall) -> None: + await _async_set_super_chlor(service_call, False) + + +@callback +def async_setup_services(hass: HomeAssistant): + """Set up services for the ScreenLogic integration.""" hass.services.async_register( - DOMAIN, SERVICE_SET_COLOR_MODE, async_set_color_mode, SET_COLOR_MODE_SCHEMA + DOMAIN, SERVICE_SET_COLOR_MODE, _async_set_color_mode, SET_COLOR_MODE_SCHEMA ) hass.services.async_register( DOMAIN, SERVICE_START_SUPER_CHLORINATION, - async_start_super_chlor, + _async_start_super_chlor, TURN_ON_SUPER_CHLOR_SCHEMA, ) hass.services.async_register( DOMAIN, SERVICE_STOP_SUPER_CHLORINATION, - async_stop_super_chlor, + _async_stop_super_chlor, BASE_SERVICE_SCHEMA, ) diff --git a/homeassistant/components/seventeentrack/__init__.py b/homeassistant/components/seventeentrack/__init__.py index 235a5338cb675b..90fe9f325fae67 100644 --- a/homeassistant/components/seventeentrack/__init__.py +++ b/homeassistant/components/seventeentrack/__init__.py @@ -13,7 +13,7 @@ from .const import DOMAIN from .coordinator import SeventeenTrackCoordinator -from .services import setup_services +from .services import async_setup_services PLATFORMS: list[Platform] = [Platform.SENSOR] @@ -23,7 +23,7 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: """Set up the 17Track component.""" - setup_services(hass) + async_setup_services(hass) return True diff --git a/homeassistant/components/seventeentrack/services.py b/homeassistant/components/seventeentrack/services.py index 5ba0b569b19101..531ff2aea43eed 100644 --- a/homeassistant/components/seventeentrack/services.py +++ b/homeassistant/components/seventeentrack/services.py @@ -12,6 +12,7 @@ ServiceCall, ServiceResponse, SupportsResponse, + callback, ) from homeassistant.exceptions import ServiceValidationError from homeassistant.helpers import config_validation as cv, selector @@ -70,100 +71,106 @@ ) -def setup_services(hass: HomeAssistant) -> None: - """Set up the services for the seventeentrack integration.""" +async def _get_packages(call: ServiceCall) -> ServiceResponse: + """Get packages from 17Track.""" + config_entry_id = call.data[ATTR_CONFIG_ENTRY_ID] + package_states = call.data.get(ATTR_PACKAGE_STATE, []) - async def get_packages(call: ServiceCall) -> ServiceResponse: - """Get packages from 17Track.""" - config_entry_id = call.data[ATTR_CONFIG_ENTRY_ID] - package_states = call.data.get(ATTR_PACKAGE_STATE, []) + await _validate_service(call.hass, config_entry_id) - await _validate_service(config_entry_id) + seventeen_coordinator: SeventeenTrackCoordinator = call.hass.data[DOMAIN][ + config_entry_id + ] + live_packages = sorted( + await seventeen_coordinator.client.profile.packages( + show_archived=seventeen_coordinator.show_archived + ) + ) - seventeen_coordinator: SeventeenTrackCoordinator = hass.data[DOMAIN][ - config_entry_id + return { + "packages": [ + _package_to_dict(package) + for package in live_packages + if slugify(package.status) in package_states or package_states == [] ] - live_packages = sorted( - await seventeen_coordinator.client.profile.packages( - show_archived=seventeen_coordinator.show_archived - ) - ) + } - return { - "packages": [ - package_to_dict(package) - for package in live_packages - if slugify(package.status) in package_states or package_states == [] - ] - } - async def add_package(call: ServiceCall) -> None: - """Add a new package to 17Track.""" - config_entry_id = call.data[ATTR_CONFIG_ENTRY_ID] - tracking_number = call.data[ATTR_PACKAGE_TRACKING_NUMBER] - friendly_name = call.data[ATTR_PACKAGE_FRIENDLY_NAME] +async def _add_package(call: ServiceCall) -> None: + """Add a new package to 17Track.""" + config_entry_id = call.data[ATTR_CONFIG_ENTRY_ID] + tracking_number = call.data[ATTR_PACKAGE_TRACKING_NUMBER] + friendly_name = call.data[ATTR_PACKAGE_FRIENDLY_NAME] - await _validate_service(config_entry_id) + await _validate_service(call.hass, config_entry_id) - seventeen_coordinator: SeventeenTrackCoordinator = hass.data[DOMAIN][ - config_entry_id - ] + seventeen_coordinator: SeventeenTrackCoordinator = call.hass.data[DOMAIN][ + config_entry_id + ] - await seventeen_coordinator.client.profile.add_package( - tracking_number, friendly_name - ) + await seventeen_coordinator.client.profile.add_package( + tracking_number, friendly_name + ) - async def archive_package(call: ServiceCall) -> None: - config_entry_id = call.data[ATTR_CONFIG_ENTRY_ID] - tracking_number = call.data[ATTR_PACKAGE_TRACKING_NUMBER] - await _validate_service(config_entry_id) +async def _archive_package(call: ServiceCall) -> None: + config_entry_id = call.data[ATTR_CONFIG_ENTRY_ID] + tracking_number = call.data[ATTR_PACKAGE_TRACKING_NUMBER] - seventeen_coordinator: SeventeenTrackCoordinator = hass.data[DOMAIN][ - config_entry_id - ] + await _validate_service(call.hass, config_entry_id) - await seventeen_coordinator.client.profile.archive_package(tracking_number) - - def package_to_dict(package: Package) -> dict[str, Any]: - result = { - ATTR_DESTINATION_COUNTRY: package.destination_country, - ATTR_ORIGIN_COUNTRY: package.origin_country, - ATTR_PACKAGE_TYPE: package.package_type, - ATTR_TRACKING_INFO_LANGUAGE: package.tracking_info_language, - ATTR_TRACKING_NUMBER: package.tracking_number, - ATTR_LOCATION: package.location, - ATTR_STATUS: package.status, - ATTR_INFO_TEXT: package.info_text, - ATTR_FRIENDLY_NAME: package.friendly_name, - } - if timestamp := package.timestamp: - result[ATTR_TIMESTAMP] = timestamp.isoformat() - return result - - async def _validate_service(config_entry_id): - entry: ConfigEntry | None = hass.config_entries.async_get_entry(config_entry_id) - if not entry: - raise ServiceValidationError( - translation_domain=DOMAIN, - translation_key="invalid_config_entry", - translation_placeholders={ - "config_entry_id": config_entry_id, - }, - ) - if entry.state != ConfigEntryState.LOADED: - raise ServiceValidationError( - translation_domain=DOMAIN, - translation_key="unloaded_config_entry", - translation_placeholders={ - "config_entry_id": entry.title, - }, - ) + seventeen_coordinator: SeventeenTrackCoordinator = call.hass.data[DOMAIN][ + config_entry_id + ] + + await seventeen_coordinator.client.profile.archive_package(tracking_number) + + +def _package_to_dict(package: Package) -> dict[str, Any]: + result = { + ATTR_DESTINATION_COUNTRY: package.destination_country, + ATTR_ORIGIN_COUNTRY: package.origin_country, + ATTR_PACKAGE_TYPE: package.package_type, + ATTR_TRACKING_INFO_LANGUAGE: package.tracking_info_language, + ATTR_TRACKING_NUMBER: package.tracking_number, + ATTR_LOCATION: package.location, + ATTR_STATUS: package.status, + ATTR_INFO_TEXT: package.info_text, + ATTR_FRIENDLY_NAME: package.friendly_name, + } + if timestamp := package.timestamp: + result[ATTR_TIMESTAMP] = timestamp.isoformat() + return result + + +async def _validate_service(hass: HomeAssistant, config_entry_id: str) -> None: + entry: ConfigEntry | None = hass.config_entries.async_get_entry(config_entry_id) + if not entry: + raise ServiceValidationError( + translation_domain=DOMAIN, + translation_key="invalid_config_entry", + translation_placeholders={ + "config_entry_id": config_entry_id, + }, + ) + if entry.state != ConfigEntryState.LOADED: + raise ServiceValidationError( + translation_domain=DOMAIN, + translation_key="unloaded_config_entry", + translation_placeholders={ + "config_entry_id": entry.title, + }, + ) + + +@callback +def async_setup_services(hass: HomeAssistant) -> None: + """Set up the services for the seventeentrack integration.""" hass.services.async_register( DOMAIN, SERVICE_GET_PACKAGES, - get_packages, + _get_packages, schema=SERVICE_GET_PACKAGES_SCHEMA, supports_response=SupportsResponse.ONLY, ) @@ -171,13 +178,13 @@ async def _validate_service(config_entry_id): hass.services.async_register( DOMAIN, SERVICE_ADD_PACKAGE, - add_package, + _add_package, schema=SERVICE_ADD_PACKAGE_SCHEMA, ) hass.services.async_register( DOMAIN, SERVICE_ARCHIVE_PACKAGE, - archive_package, + _archive_package, schema=SERVICE_ARCHIVE_PACKAGE_SCHEMA, ) diff --git a/homeassistant/components/sonos/__init__.py b/homeassistant/components/sonos/__init__.py index 24580971ae28ca..cbce25197b0281 100644 --- a/homeassistant/components/sonos/__init__.py +++ b/homeassistant/components/sonos/__init__.py @@ -3,8 +3,6 @@ from __future__ import annotations import asyncio -from collections import OrderedDict -from dataclasses import dataclass, field import datetime from functools import partial from ipaddress import AddressValueError, IPv4Address @@ -25,9 +23,8 @@ from homeassistant import config_entries from homeassistant.components import ssdp from homeassistant.components.media_player import DOMAIN as MP_DOMAIN -from homeassistant.config_entries import ConfigEntry from homeassistant.const import CONF_HOSTS, EVENT_HOMEASSISTANT_STOP -from homeassistant.core import CALLBACK_TYPE, Event, HomeAssistant, callback +from homeassistant.core import Event, HomeAssistant, callback from homeassistant.helpers import ( config_validation as cv, device_registry as dr, @@ -46,7 +43,6 @@ from .alarms import SonosAlarms from .const import ( AVAILABILITY_CHECK_INTERVAL, - DATA_SONOS, DATA_SONOS_DISCOVERY_MANAGER, DISCOVERY_INTERVAL, DOMAIN, @@ -62,7 +58,7 @@ ) from .exception import SonosUpdateError from .favorites import SonosFavorites -from .helpers import sync_get_visible_zones +from .helpers import SonosConfigEntry, SonosData, sync_get_visible_zones from .speaker import SonosSpeaker _LOGGER = logging.getLogger(__name__) @@ -95,32 +91,6 @@ ) -@dataclass -class UnjoinData: - """Class to track data necessary for unjoin coalescing.""" - - speakers: list[SonosSpeaker] - event: asyncio.Event = field(default_factory=asyncio.Event) - - -class SonosData: - """Storage class for platform global data.""" - - def __init__(self) -> None: - """Initialize the data.""" - # OrderedDict behavior used by SonosAlarms and SonosFavorites - self.discovered: OrderedDict[str, SonosSpeaker] = OrderedDict() - self.favorites: dict[str, SonosFavorites] = {} - self.alarms: dict[str, SonosAlarms] = {} - self.topology_condition = asyncio.Condition() - self.hosts_heartbeat: CALLBACK_TYPE | None = None - self.discovery_known: set[str] = set() - self.boot_counts: dict[str, int] = {} - self.mdns_names: dict[str, str] = {} - self.entity_id_mappings: dict[str, SonosSpeaker] = {} - self.unjoin_data: dict[str, UnjoinData] = {} - - async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: """Set up the Sonos component.""" conf = config.get(DOMAIN) @@ -137,17 +107,15 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: return True -async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool: +async def async_setup_entry(hass: HomeAssistant, entry: SonosConfigEntry) -> bool: """Set up Sonos from a config entry.""" soco_config.EVENTS_MODULE = events_asyncio soco_config.REQUEST_TIMEOUT = 9.5 soco_config.ZGT_EVENT_FALLBACK = False zonegroupstate.EVENT_CACHE_TIMEOUT = SUBSCRIPTION_TIMEOUT - if DATA_SONOS not in hass.data: - hass.data[DATA_SONOS] = SonosData() + data = entry.runtime_data = SonosData() - data = hass.data[DATA_SONOS] config = hass.data[DOMAIN].get("media_player", {}) hosts = config.get(CONF_HOSTS, []) _LOGGER.debug("Reached async_setup_entry, config=%s", config) @@ -172,12 +140,14 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool: return True -async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool: +async def async_unload_entry( + hass: HomeAssistant, config_entry: SonosConfigEntry +) -> bool: """Unload a Sonos config entry.""" - unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS) + unload_ok = await hass.config_entries.async_unload_platforms( + config_entry, PLATFORMS + ) await hass.data[DATA_SONOS_DISCOVERY_MANAGER].async_shutdown() - hass.data.pop(DATA_SONOS) - hass.data.pop(DATA_SONOS_DISCOVERY_MANAGER) return unload_ok @@ -185,7 +155,11 @@ class SonosDiscoveryManager: """Manage sonos discovery.""" def __init__( - self, hass: HomeAssistant, entry: ConfigEntry, data: SonosData, hosts: list[str] + self, + hass: HomeAssistant, + entry: SonosConfigEntry, + data: SonosData, + hosts: list[str], ) -> None: """Init discovery manager.""" self.hass = hass @@ -380,7 +354,9 @@ def _add_speaker( if soco.uid not in self.data.boot_counts: self.data.boot_counts[soco.uid] = soco.boot_seqnum _LOGGER.debug("Adding new speaker: %s", speaker_info) - speaker = SonosSpeaker(self.hass, soco, speaker_info, zone_group_state_sub) + speaker = SonosSpeaker( + self.hass, self.entry, soco, speaker_info, zone_group_state_sub + ) self.data.discovered[soco.uid] = speaker for coordinator, coord_dict in ( (SonosAlarms, self.data.alarms), @@ -388,7 +364,9 @@ def _add_speaker( ): c_dict: dict[str, Any] = coord_dict if soco.household_id not in c_dict: - new_coordinator = coordinator(self.hass, soco.household_id) + new_coordinator = coordinator( + self.hass, soco.household_id, self.entry + ) new_coordinator.setup(soco) c_dict[soco.household_id] = new_coordinator speaker.setup(self.entry) @@ -622,10 +600,10 @@ async def setup_platforms_and_discovery(self) -> None: async def async_remove_config_entry_device( - hass: HomeAssistant, config_entry: ConfigEntry, device_entry: dr.DeviceEntry + hass: HomeAssistant, config_entry: SonosConfigEntry, device_entry: dr.DeviceEntry ) -> bool: """Remove Sonos config entry from a device.""" - known_devices = hass.data[DATA_SONOS].discovered.keys() + known_devices = config_entry.runtime_data.discovered.keys() for identifier in device_entry.identifiers: if identifier[0] != DOMAIN: continue diff --git a/homeassistant/components/sonos/alarms.py b/homeassistant/components/sonos/alarms.py index afbff8baa6df0f..c3c3b14545fac7 100644 --- a/homeassistant/components/sonos/alarms.py +++ b/homeassistant/components/sonos/alarms.py @@ -12,7 +12,7 @@ from homeassistant.helpers.dispatcher import async_dispatcher_send -from .const import DATA_SONOS, SONOS_ALARMS_UPDATED, SONOS_CREATE_ALARM +from .const import SONOS_ALARMS_UPDATED, SONOS_CREATE_ALARM from .helpers import soco_error from .household_coordinator import SonosHouseholdCoordinator @@ -52,7 +52,7 @@ async def async_update_entities( for alarm_id, alarm in self.alarms.alarms.items(): if alarm_id in self.created_alarm_ids: continue - speaker = self.hass.data[DATA_SONOS].discovered.get(alarm.zone.uid) + speaker = self.config_entry.runtime_data.discovered.get(alarm.zone.uid) if speaker: async_dispatcher_send( self.hass, SONOS_CREATE_ALARM, speaker, [alarm_id] diff --git a/homeassistant/components/sonos/binary_sensor.py b/homeassistant/components/sonos/binary_sensor.py index e2e981b293c3da..8a4c3abe24847c 100644 --- a/homeassistant/components/sonos/binary_sensor.py +++ b/homeassistant/components/sonos/binary_sensor.py @@ -9,7 +9,6 @@ BinarySensorDeviceClass, BinarySensorEntity, ) -from homeassistant.config_entries import ConfigEntry from homeassistant.const import EntityCategory from homeassistant.core import HomeAssistant, callback from homeassistant.helpers.dispatcher import async_dispatcher_connect @@ -17,7 +16,7 @@ from .const import SONOS_CREATE_BATTERY, SONOS_CREATE_MIC_SENSOR from .entity import SonosEntity -from .helpers import soco_error +from .helpers import SonosConfigEntry, soco_error from .speaker import SonosSpeaker ATTR_BATTERY_POWER_SOURCE = "power_source" @@ -27,7 +26,7 @@ async def async_setup_entry( hass: HomeAssistant, - config_entry: ConfigEntry, + config_entry: SonosConfigEntry, async_add_entities: AddConfigEntryEntitiesCallback, ) -> None: """Set up Sonos from a config entry.""" @@ -35,13 +34,13 @@ async def async_setup_entry( @callback def _async_create_battery_entity(speaker: SonosSpeaker) -> None: _LOGGER.debug("Creating battery binary_sensor on %s", speaker.zone_name) - entity = SonosPowerEntity(speaker) + entity = SonosPowerEntity(speaker, config_entry) async_add_entities([entity]) @callback def _async_create_mic_entity(speaker: SonosSpeaker) -> None: _LOGGER.debug("Creating microphone binary_sensor on %s", speaker.zone_name) - async_add_entities([SonosMicrophoneSensorEntity(speaker)]) + async_add_entities([SonosMicrophoneSensorEntity(speaker, config_entry)]) config_entry.async_on_unload( async_dispatcher_connect( @@ -62,9 +61,9 @@ class SonosPowerEntity(SonosEntity, BinarySensorEntity): _attr_entity_category = EntityCategory.DIAGNOSTIC _attr_device_class = BinarySensorDeviceClass.BATTERY_CHARGING - def __init__(self, speaker: SonosSpeaker) -> None: + def __init__(self, speaker: SonosSpeaker, config_entry: SonosConfigEntry) -> None: """Initialize the power entity binary sensor.""" - super().__init__(speaker) + super().__init__(speaker, config_entry) self._attr_unique_id = f"{self.soco.uid}-power" async def _async_fallback_poll(self) -> None: @@ -95,9 +94,9 @@ class SonosMicrophoneSensorEntity(SonosEntity, BinarySensorEntity): _attr_entity_category = EntityCategory.DIAGNOSTIC _attr_translation_key = "microphone" - def __init__(self, speaker: SonosSpeaker) -> None: + def __init__(self, speaker: SonosSpeaker, config_entry: SonosConfigEntry) -> None: """Initialize the microphone binary sensor entity.""" - super().__init__(speaker) + super().__init__(speaker, config_entry) self._attr_unique_id = f"{self.soco.uid}-microphone" async def _async_fallback_poll(self) -> None: diff --git a/homeassistant/components/sonos/const.py b/homeassistant/components/sonos/const.py index 614be2b18171f0..76e0a915060a50 100644 --- a/homeassistant/components/sonos/const.py +++ b/homeassistant/components/sonos/const.py @@ -10,7 +10,6 @@ UPNP_ST = "urn:schemas-upnp-org:device:ZonePlayer:1" DOMAIN = "sonos" -DATA_SONOS = "sonos_media_player" DATA_SONOS_DISCOVERY_MANAGER = "sonos_discovery_manager" PLATFORMS = [ Platform.BINARY_SENSOR, diff --git a/homeassistant/components/sonos/diagnostics.py b/homeassistant/components/sonos/diagnostics.py index a0207af77ab2ed..35d81edbea04f9 100644 --- a/homeassistant/components/sonos/diagnostics.py +++ b/homeassistant/components/sonos/diagnostics.py @@ -5,11 +5,11 @@ import time from typing import Any -from homeassistant.config_entries import ConfigEntry from homeassistant.core import HomeAssistant from homeassistant.helpers.device_registry import DeviceEntry -from .const import DATA_SONOS, DOMAIN +from .const import DOMAIN +from .helpers import SonosConfigEntry from .speaker import SonosSpeaker MEDIA_DIAGNOSTIC_ATTRIBUTES = ( @@ -45,27 +45,29 @@ async def async_get_config_entry_diagnostics( - hass: HomeAssistant, config_entry: ConfigEntry + hass: HomeAssistant, config_entry: SonosConfigEntry ) -> dict[str, Any]: """Return diagnostics for a config entry.""" payload: dict[str, Any] = {"current_timestamp": time.monotonic()} for section in ("discovered", "discovery_known"): payload[section] = {} - data: set[Any] | dict[str, Any] = getattr(hass.data[DATA_SONOS], section) + data: set[Any] | dict[str, Any] = getattr(config_entry.runtime_data, section) if isinstance(data, set): payload[section] = data continue for key, value in data.items(): if isinstance(value, SonosSpeaker): - payload[section][key] = await async_generate_speaker_info(hass, value) + payload[section][key] = await async_generate_speaker_info( + hass, config_entry, value + ) else: payload[section][key] = value return payload async def async_get_device_diagnostics( - hass: HomeAssistant, config_entry: ConfigEntry, device: DeviceEntry + hass: HomeAssistant, config_entry: SonosConfigEntry, device: DeviceEntry ) -> dict[str, Any]: """Return diagnostics for a device.""" uid = next( @@ -75,10 +77,10 @@ async def async_get_device_diagnostics( if uid is None: return {} - if (speaker := hass.data[DATA_SONOS].discovered.get(uid)) is None: + if (speaker := config_entry.runtime_data.discovered.get(uid)) is None: return {} - return await async_generate_speaker_info(hass, speaker) + return await async_generate_speaker_info(hass, config_entry, speaker) async def async_generate_media_info( @@ -107,7 +109,7 @@ def poll_current_track_info() -> dict[str, Any] | str: async def async_generate_speaker_info( - hass: HomeAssistant, speaker: SonosSpeaker + hass: HomeAssistant, config_entry: SonosConfigEntry, speaker: SonosSpeaker ) -> dict[str, Any]: """Generate the diagnostic payload for a specific speaker.""" payload: dict[str, Any] = {} @@ -132,7 +134,7 @@ def get_contents( payload["enabled_entities"] = sorted( entity_id - for entity_id, s in hass.data[DATA_SONOS].entity_id_mappings.items() + for entity_id, s in config_entry.runtime_data.entity_id_mappings.items() if s is speaker ) payload["media"] = await async_generate_media_info(hass, speaker) diff --git a/homeassistant/components/sonos/entity.py b/homeassistant/components/sonos/entity.py index a9a76b3b4d0ffa..58108f9974ce76 100644 --- a/homeassistant/components/sonos/entity.py +++ b/homeassistant/components/sonos/entity.py @@ -13,8 +13,9 @@ from homeassistant.helpers.dispatcher import async_dispatcher_connect from homeassistant.helpers.entity import Entity -from .const import DATA_SONOS, DOMAIN, SONOS_FALLBACK_POLL, SONOS_STATE_UPDATED +from .const import DOMAIN, SONOS_FALLBACK_POLL, SONOS_STATE_UPDATED from .exception import SonosUpdateError +from .helpers import SonosConfigEntry from .speaker import SonosSpeaker _LOGGER = logging.getLogger(__name__) @@ -26,13 +27,14 @@ class SonosEntity(Entity): _attr_should_poll = False _attr_has_entity_name = True - def __init__(self, speaker: SonosSpeaker) -> None: + def __init__(self, speaker: SonosSpeaker, config_entry: SonosConfigEntry) -> None: """Initialize a SonosEntity.""" self.speaker = speaker + self.config_entry = config_entry async def async_added_to_hass(self) -> None: """Handle common setup when added to hass.""" - self.hass.data[DATA_SONOS].entity_id_mappings[self.entity_id] = self.speaker + self.config_entry.runtime_data.entity_id_mappings[self.entity_id] = self.speaker self.async_on_remove( async_dispatcher_connect( self.hass, @@ -50,7 +52,7 @@ async def async_added_to_hass(self) -> None: async def async_will_remove_from_hass(self) -> None: """Clean up when entity is removed.""" - del self.hass.data[DATA_SONOS].entity_id_mappings[self.entity_id] + del self.config_entry.runtime_data.entity_id_mappings[self.entity_id] async def async_fallback_poll(self, now: datetime.datetime) -> None: """Poll the entity if subscriptions fail.""" diff --git a/homeassistant/components/sonos/helpers.py b/homeassistant/components/sonos/helpers.py index 8ced5a87b28568..3350df430f8102 100644 --- a/homeassistant/components/sonos/helpers.py +++ b/homeassistant/components/sonos/helpers.py @@ -2,7 +2,10 @@ from __future__ import annotations +import asyncio +from collections import OrderedDict from collections.abc import Callable +from dataclasses import dataclass, field import logging from typing import TYPE_CHECKING, Any, Concatenate, overload @@ -10,13 +13,17 @@ from soco import SoCo from soco.exceptions import SoCoException, SoCoUPnPException +from homeassistant.config_entries import ConfigEntry +from homeassistant.core import CALLBACK_TYPE from homeassistant.helpers.dispatcher import dispatcher_send from .const import SONOS_SPEAKER_ACTIVITY from .exception import SonosUpdateError if TYPE_CHECKING: + from .alarms import SonosAlarms from .entity import SonosEntity + from .favorites import SonosFavorites from .household_coordinator import SonosHouseholdCoordinator from .media import SonosMedia from .speaker import SonosSpeaker @@ -120,3 +127,30 @@ def sync_get_visible_zones(soco: SoCo) -> set[SoCo]: _ = soco.household_id _ = soco.uid return soco.visible_zones + + +@dataclass +class UnjoinData: + """Class to track data necessary for unjoin coalescing.""" + + speakers: list[SonosSpeaker] = field(default_factory=list) + event: asyncio.Event = field(default_factory=asyncio.Event) + + +@dataclass +class SonosData: + """Storage class for platform global data.""" + + discovered: OrderedDict[str, SonosSpeaker] = field(default_factory=OrderedDict) + favorites: dict[str, SonosFavorites] = field(default_factory=dict) + alarms: dict[str, SonosAlarms] = field(default_factory=dict) + topology_condition: asyncio.Condition = field(default_factory=asyncio.Condition) + hosts_heartbeat: CALLBACK_TYPE | None = None + discovery_known: set[str] = field(default_factory=set) + boot_counts: dict[str, int] = field(default_factory=dict) + mdns_names: dict[str, str] = field(default_factory=dict) + entity_id_mappings: dict[str, SonosSpeaker] = field(default_factory=dict) + unjoin_data: dict[str, UnjoinData] = field(default_factory=dict) + + +type SonosConfigEntry = ConfigEntry[SonosData] diff --git a/homeassistant/components/sonos/household_coordinator.py b/homeassistant/components/sonos/household_coordinator.py index 8fcecdf4d5e7f4..a2c128dce946b4 100644 --- a/homeassistant/components/sonos/household_coordinator.py +++ b/homeassistant/components/sonos/household_coordinator.py @@ -5,16 +5,18 @@ import asyncio from collections.abc import Callable, Coroutine import logging -from typing import Any +from typing import TYPE_CHECKING, Any from soco import SoCo from homeassistant.core import HomeAssistant, callback from homeassistant.helpers.debounce import Debouncer -from .const import DATA_SONOS from .exception import SonosUpdateError +if TYPE_CHECKING: + from .helpers import SonosConfigEntry + _LOGGER = logging.getLogger(__name__) @@ -23,12 +25,15 @@ class SonosHouseholdCoordinator: cache_update_lock: asyncio.Lock - def __init__(self, hass: HomeAssistant, household_id: str) -> None: + def __init__( + self, hass: HomeAssistant, household_id: str, config_entry: SonosConfigEntry + ) -> None: """Initialize the data.""" self.hass = hass self.household_id = household_id self.async_poll: Callable[[], Coroutine[None, None, None]] | None = None self.last_processed_event_id: int | None = None + self.config_entry = config_entry def setup(self, soco: SoCo) -> None: """Set up the SonosAlarm instance.""" @@ -54,7 +59,7 @@ def class_type(self) -> str: async def _async_poll(self) -> None: """Poll any known speaker.""" - discovered = self.hass.data[DATA_SONOS].discovered + discovered = self.config_entry.runtime_data.discovered for uid, speaker in discovered.items(): _LOGGER.debug("Polling %s using %s", self.class_type, speaker.soco) diff --git a/homeassistant/components/sonos/media_player.py b/homeassistant/components/sonos/media_player.py index f1f95659469ab4..96e4d34ddc4fd1 100644 --- a/homeassistant/components/sonos/media_player.py +++ b/homeassistant/components/sonos/media_player.py @@ -5,7 +5,7 @@ import datetime from functools import partial import logging -from typing import Any +from typing import TYPE_CHECKING, Any from soco import SoCo, alarms from soco.core import ( @@ -40,7 +40,6 @@ ) from homeassistant.components.plex import PLEX_URI_SCHEME from homeassistant.components.plex.services import process_plex_payload -from homeassistant.config_entries import ConfigEntry from homeassistant.const import ATTR_TIME from homeassistant.core import HomeAssistant, ServiceCall, SupportsResponse, callback from homeassistant.exceptions import HomeAssistantError, ServiceValidationError @@ -49,9 +48,8 @@ from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback from homeassistant.helpers.event import async_call_later -from . import UnjoinData, media_browser +from . import media_browser from .const import ( - DATA_SONOS, DOMAIN, MEDIA_TYPE_DIRECTORY, MEDIA_TYPES_TO_SONOS, @@ -67,9 +65,12 @@ SOURCE_TV, ) from .entity import SonosEntity -from .helpers import soco_error +from .helpers import UnjoinData, soco_error from .speaker import SonosMedia, SonosSpeaker +if TYPE_CHECKING: + from .helpers import SonosConfigEntry + _LOGGER = logging.getLogger(__name__) LONG_SERVICE_TIMEOUT = 30.0 @@ -108,7 +109,7 @@ async def async_setup_entry( hass: HomeAssistant, - config_entry: ConfigEntry, + config_entry: SonosConfigEntry, async_add_entities: AddConfigEntryEntitiesCallback, ) -> None: """Set up Sonos from a config entry.""" @@ -118,7 +119,7 @@ async def async_setup_entry( def async_create_entities(speaker: SonosSpeaker) -> None: """Handle device discovery and create entities.""" _LOGGER.debug("Creating media_player on %s", speaker.zone_name) - async_add_entities([SonosMediaPlayerEntity(speaker)]) + async_add_entities([SonosMediaPlayerEntity(speaker, config_entry)]) @service.verify_domain_control(hass, DOMAIN) async def async_service_handle(service_call: ServiceCall) -> None: @@ -136,11 +137,11 @@ async def async_service_handle(service_call: ServiceCall) -> None: if service_call.service == SERVICE_SNAPSHOT: await SonosSpeaker.snapshot_multi( - hass, speakers, service_call.data[ATTR_WITH_GROUP] + hass, config_entry, speakers, service_call.data[ATTR_WITH_GROUP] ) elif service_call.service == SERVICE_RESTORE: await SonosSpeaker.restore_multi( - hass, speakers, service_call.data[ATTR_WITH_GROUP] + hass, config_entry, speakers, service_call.data[ATTR_WITH_GROUP] ) config_entry.async_on_unload( @@ -231,9 +232,9 @@ class SonosMediaPlayerEntity(SonosEntity, MediaPlayerEntity): _attr_media_content_type = MediaType.MUSIC _attr_device_class = MediaPlayerDeviceClass.SPEAKER - def __init__(self, speaker: SonosSpeaker) -> None: + def __init__(self, speaker: SonosSpeaker, config_entry: SonosConfigEntry) -> None: """Initialize the media player entity.""" - super().__init__(speaker) + super().__init__(speaker, config_entry) self._attr_unique_id = self.soco.uid async def async_added_to_hass(self) -> None: @@ -298,9 +299,9 @@ def state(self) -> MediaPlayerState: async def _async_fallback_poll(self) -> None: """Retrieve latest state by polling.""" - await ( - self.hass.data[DATA_SONOS].favorites[self.speaker.household_id].async_poll() - ) + favorites = self.config_entry.runtime_data.favorites[self.speaker.household_id] + assert favorites.async_poll + await favorites.async_poll() await self.hass.async_add_executor_job(self._update) def _update(self) -> None: @@ -880,12 +881,16 @@ async def async_join_players(self, group_members: list[str]) -> None: """Join `group_members` as a player group with the current player.""" speakers = [] for entity_id in group_members: - if speaker := self.hass.data[DATA_SONOS].entity_id_mappings.get(entity_id): + if speaker := self.config_entry.runtime_data.entity_id_mappings.get( + entity_id + ): speakers.append(speaker) else: raise HomeAssistantError(f"Not a known Sonos entity_id: {entity_id}") - await SonosSpeaker.join_multi(self.hass, self.speaker, speakers) + await SonosSpeaker.join_multi( + self.hass, self.config_entry, self.speaker, speakers + ) async def async_unjoin_player(self) -> None: """Remove this player from any group. @@ -894,7 +899,7 @@ async def async_unjoin_player(self) -> None: which optimizes the order in which speakers are removed from their groups. Removing coordinators last better preserves playqueues on the speakers. """ - sonos_data = self.hass.data[DATA_SONOS] + sonos_data = self.config_entry.runtime_data household_id = self.speaker.household_id async def async_process_unjoin(now: datetime.datetime) -> None: @@ -903,7 +908,9 @@ async def async_process_unjoin(now: datetime.datetime) -> None: _LOGGER.debug( "Processing unjoins for %s", [x.zone_name for x in unjoin_data.speakers] ) - await SonosSpeaker.unjoin_multi(self.hass, unjoin_data.speakers) + await SonosSpeaker.unjoin_multi( + self.hass, self.config_entry, unjoin_data.speakers + ) unjoin_data.event.set() if unjoin_data := sonos_data.unjoin_data.get(household_id): diff --git a/homeassistant/components/sonos/number.py b/homeassistant/components/sonos/number.py index c23ba51a877e43..8e4b4fb5b42362 100644 --- a/homeassistant/components/sonos/number.py +++ b/homeassistant/components/sonos/number.py @@ -6,7 +6,6 @@ from typing import cast from homeassistant.components.number import NumberEntity -from homeassistant.config_entries import ConfigEntry from homeassistant.const import EntityCategory from homeassistant.core import HomeAssistant from homeassistant.helpers.dispatcher import async_dispatcher_connect @@ -14,7 +13,7 @@ from .const import SONOS_CREATE_LEVELS from .entity import SonosEntity -from .helpers import soco_error +from .helpers import SonosConfigEntry, soco_error from .speaker import SonosSpeaker LEVEL_TYPES = { @@ -69,7 +68,7 @@ def _balance_from_number(value: float) -> tuple[int, int]: async def async_setup_entry( hass: HomeAssistant, - config_entry: ConfigEntry, + config_entry: SonosConfigEntry, async_add_entities: AddConfigEntryEntitiesCallback, ) -> None: """Set up the Sonos number platform from a config entry.""" @@ -93,7 +92,9 @@ async def _async_create_entities(speaker: SonosSpeaker) -> None: _LOGGER.debug( "Creating %s number control on %s", level_type, speaker.zone_name ) - entities.append(SonosLevelEntity(speaker, level_type, valid_range)) + entities.append( + SonosLevelEntity(speaker, config_entry, level_type, valid_range) + ) async_add_entities(entities) config_entry.async_on_unload( @@ -107,10 +108,14 @@ class SonosLevelEntity(SonosEntity, NumberEntity): _attr_entity_category = EntityCategory.CONFIG def __init__( - self, speaker: SonosSpeaker, level_type: str, valid_range: tuple[int, int] + self, + speaker: SonosSpeaker, + config_entry: SonosConfigEntry, + level_type: str, + valid_range: tuple[int, int], ) -> None: """Initialize the level entity.""" - super().__init__(speaker) + super().__init__(speaker, config_entry) self._attr_unique_id = f"{self.soco.uid}-{level_type}" self._attr_translation_key = level_type self.level_type = level_type diff --git a/homeassistant/components/sonos/sensor.py b/homeassistant/components/sonos/sensor.py index d888ee669bb935..6b507ec910a606 100644 --- a/homeassistant/components/sonos/sensor.py +++ b/homeassistant/components/sonos/sensor.py @@ -5,7 +5,6 @@ import logging from homeassistant.components.sensor import SensorDeviceClass, SensorEntity -from homeassistant.config_entries import ConfigEntry from homeassistant.const import PERCENTAGE, EntityCategory from homeassistant.core import HomeAssistant, callback from homeassistant.helpers.dispatcher import async_dispatcher_connect @@ -20,7 +19,7 @@ ) from .entity import SonosEntity, SonosPollingEntity from .favorites import SonosFavorites -from .helpers import soco_error +from .helpers import SonosConfigEntry, soco_error from .speaker import SonosSpeaker _LOGGER = logging.getLogger(__name__) @@ -28,7 +27,7 @@ async def async_setup_entry( hass: HomeAssistant, - config_entry: ConfigEntry, + config_entry: SonosConfigEntry, async_add_entities: AddConfigEntryEntitiesCallback, ) -> None: """Set up Sonos from a config entry.""" @@ -38,13 +37,13 @@ def _async_create_audio_format_entity( speaker: SonosSpeaker, audio_format: str ) -> None: _LOGGER.debug("Creating audio input format sensor on %s", speaker.zone_name) - entity = SonosAudioInputFormatSensorEntity(speaker, audio_format) + entity = SonosAudioInputFormatSensorEntity(speaker, config_entry, audio_format) async_add_entities([entity]) @callback def _async_create_battery_sensor(speaker: SonosSpeaker) -> None: _LOGGER.debug("Creating battery level sensor on %s", speaker.zone_name) - entity = SonosBatteryEntity(speaker) + entity = SonosBatteryEntity(speaker, config_entry) async_add_entities([entity]) @callback @@ -82,9 +81,9 @@ class SonosBatteryEntity(SonosEntity, SensorEntity): _attr_entity_category = EntityCategory.DIAGNOSTIC _attr_native_unit_of_measurement = PERCENTAGE - def __init__(self, speaker: SonosSpeaker) -> None: + def __init__(self, speaker: SonosSpeaker, config_entry: SonosConfigEntry) -> None: """Initialize the battery sensor.""" - super().__init__(speaker) + super().__init__(speaker, config_entry) self._attr_unique_id = f"{self.soco.uid}-battery" async def _async_fallback_poll(self) -> None: @@ -109,9 +108,11 @@ class SonosAudioInputFormatSensorEntity(SonosPollingEntity, SensorEntity): _attr_translation_key = "audio_input_format" _attr_should_poll = True - def __init__(self, speaker: SonosSpeaker, audio_format: str) -> None: + def __init__( + self, speaker: SonosSpeaker, config_entry: SonosConfigEntry, audio_format: str + ) -> None: """Initialize the audio input format sensor.""" - super().__init__(speaker) + super().__init__(speaker, config_entry) self._attr_unique_id = f"{self.soco.uid}-audio-format" self._attr_native_value = audio_format diff --git a/homeassistant/components/sonos/speaker.py b/homeassistant/components/sonos/speaker.py index d339e861a131ab..aee0a40c184b13 100644 --- a/homeassistant/components/sonos/speaker.py +++ b/homeassistant/components/sonos/speaker.py @@ -21,7 +21,6 @@ from sonos_websocket import SonosWebsocket from homeassistant.components.media_player import DOMAIN as MP_DOMAIN -from homeassistant.config_entries import ConfigEntry from homeassistant.core import HomeAssistant, callback from homeassistant.exceptions import HomeAssistantError from homeassistant.helpers import entity_registry as er @@ -38,7 +37,6 @@ from .const import ( AVAILABILITY_TIMEOUT, BATTERY_SCAN_INTERVAL, - DATA_SONOS, DOMAIN, SCAN_INTERVAL, SONOS_CHECK_ACTIVITY, @@ -66,7 +64,8 @@ from .statistics import ActivityStatistics, EventStatistics if TYPE_CHECKING: - from . import SonosData + from .helpers import SonosConfigEntry + NEVER_TIME = -1200.0 RESUB_COOLDOWN_SECONDS = 10.0 @@ -95,13 +94,15 @@ class SonosSpeaker: def __init__( self, hass: HomeAssistant, + config_entry: SonosConfigEntry, soco: SoCo, speaker_info: dict[str, Any], zone_group_state_sub: SubscriptionBase | None, ) -> None: """Initialize a SonosSpeaker.""" self.hass = hass - self.data: SonosData = hass.data[DATA_SONOS] + self.config_entry = config_entry + self.data = config_entry.runtime_data self.soco = soco self.websocket: SonosWebsocket | None = None self.household_id: str = soco.household_id @@ -179,7 +180,10 @@ def __init__( self._group_members_missing: set[str] = set() async def async_setup( - self, entry: ConfigEntry, has_battery: bool, dispatches: list[tuple[Any, ...]] + self, + entry: SonosConfigEntry, + has_battery: bool, + dispatches: list[tuple[Any, ...]], ) -> None: """Complete setup in async context.""" # Battery events can be infrequent, polling is still necessary @@ -216,7 +220,7 @@ async def async_setup( await self.async_subscribe() - def setup(self, entry: ConfigEntry) -> None: + def setup(self, entry: SonosConfigEntry) -> None: """Run initial setup of the speaker.""" self.media.play_mode = self.soco.play_mode self.update_volume() @@ -961,15 +965,16 @@ def join(self, speakers: list[SonosSpeaker]) -> list[SonosSpeaker]: @staticmethod async def join_multi( hass: HomeAssistant, + config_entry: SonosConfigEntry, master: SonosSpeaker, speakers: list[SonosSpeaker], ) -> None: """Form a group with other players.""" - async with hass.data[DATA_SONOS].topology_condition: + async with config_entry.runtime_data.topology_condition: group: list[SonosSpeaker] = await hass.async_add_executor_job( master.join, speakers ) - await SonosSpeaker.wait_for_groups(hass, [group]) + await SonosSpeaker.wait_for_groups(hass, config_entry, [group]) @soco_error() def unjoin(self) -> None: @@ -980,7 +985,11 @@ def unjoin(self) -> None: self.coordinator = None @staticmethod - async def unjoin_multi(hass: HomeAssistant, speakers: list[SonosSpeaker]) -> None: + async def unjoin_multi( + hass: HomeAssistant, + config_entry: SonosConfigEntry, + speakers: list[SonosSpeaker], + ) -> None: """Unjoin several players from their group.""" def _unjoin_all(speakers: list[SonosSpeaker]) -> None: @@ -992,9 +1001,11 @@ def _unjoin_all(speakers: list[SonosSpeaker]) -> None: for speaker in joined_speakers + coordinators: speaker.unjoin() - async with hass.data[DATA_SONOS].topology_condition: + async with config_entry.runtime_data.topology_condition: await hass.async_add_executor_job(_unjoin_all, speakers) - await SonosSpeaker.wait_for_groups(hass, [[s] for s in speakers]) + await SonosSpeaker.wait_for_groups( + hass, config_entry, [[s] for s in speakers] + ) @soco_error() def snapshot(self, with_group: bool) -> None: @@ -1008,7 +1019,10 @@ def snapshot(self, with_group: bool) -> None: @staticmethod async def snapshot_multi( - hass: HomeAssistant, speakers: list[SonosSpeaker], with_group: bool + hass: HomeAssistant, + config_entry: SonosConfigEntry, + speakers: list[SonosSpeaker], + with_group: bool, ) -> None: """Snapshot all the speakers and optionally their groups.""" @@ -1023,7 +1037,7 @@ def _snapshot_all(speakers: Collection[SonosSpeaker]) -> None: for speaker in list(speakers_set): speakers_set.update(speaker.sonos_group) - async with hass.data[DATA_SONOS].topology_condition: + async with config_entry.runtime_data.topology_condition: await hass.async_add_executor_job(_snapshot_all, speakers_set) @soco_error() @@ -1041,7 +1055,10 @@ def restore(self) -> None: @staticmethod async def restore_multi( - hass: HomeAssistant, speakers: list[SonosSpeaker], with_group: bool + hass: HomeAssistant, + config_entry: SonosConfigEntry, + speakers: list[SonosSpeaker], + with_group: bool, ) -> None: """Restore snapshots for all the speakers.""" @@ -1119,16 +1136,18 @@ def _restore_players(speakers: Collection[SonosSpeaker]) -> None: assert len(speaker.snapshot_group) speakers_set.update(speaker.snapshot_group) - async with hass.data[DATA_SONOS].topology_condition: + async with config_entry.runtime_data.topology_condition: groups = await hass.async_add_executor_job( _restore_groups, speakers_set, with_group ) - await SonosSpeaker.wait_for_groups(hass, groups) + await SonosSpeaker.wait_for_groups(hass, config_entry, groups) await hass.async_add_executor_job(_restore_players, speakers_set) @staticmethod async def wait_for_groups( - hass: HomeAssistant, groups: list[list[SonosSpeaker]] + hass: HomeAssistant, + config_entry: SonosConfigEntry, + groups: list[list[SonosSpeaker]], ) -> None: """Wait until all groups are present, or timeout.""" @@ -1151,11 +1170,11 @@ def _test_groups(groups: list[list[SonosSpeaker]]) -> bool: try: async with asyncio.timeout(5): while not _test_groups(groups): - await hass.data[DATA_SONOS].topology_condition.wait() + await config_entry.runtime_data.topology_condition.wait() except TimeoutError: _LOGGER.warning("Timeout waiting for target groups %s", groups) - any_speaker = next(iter(hass.data[DATA_SONOS].discovered.values())) + any_speaker = next(iter(config_entry.runtime_data.discovered.values())) any_speaker.soco.zone_group_state.clear_cache() # diff --git a/homeassistant/components/sonos/switch.py b/homeassistant/components/sonos/switch.py index 052dbd990b2573..582845d10a2122 100644 --- a/homeassistant/components/sonos/switch.py +++ b/homeassistant/components/sonos/switch.py @@ -10,7 +10,6 @@ from soco.exceptions import SoCoSlaveException, SoCoUPnPException from homeassistant.components.switch import ENTITY_ID_FORMAT, SwitchEntity -from homeassistant.config_entries import ConfigEntry from homeassistant.const import ATTR_TIME, EntityCategory from homeassistant.core import HomeAssistant, callback from homeassistant.helpers import device_registry as dr, entity_registry as er @@ -18,15 +17,15 @@ from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback from homeassistant.helpers.event import async_track_time_change +from .alarms import SonosAlarms from .const import ( - DATA_SONOS, DOMAIN, SONOS_ALARMS_UPDATED, SONOS_CREATE_ALARM, SONOS_CREATE_SWITCHES, ) from .entity import SonosEntity, SonosPollingEntity -from .helpers import soco_error +from .helpers import SonosConfigEntry, soco_error from .speaker import SonosSpeaker _LOGGER = logging.getLogger(__name__) @@ -73,22 +72,22 @@ async def async_setup_entry( hass: HomeAssistant, - config_entry: ConfigEntry, + config_entry: SonosConfigEntry, async_add_entities: AddConfigEntryEntitiesCallback, ) -> None: """Set up Sonos from a config entry.""" async def _async_create_alarms(speaker: SonosSpeaker, alarm_ids: list[str]) -> None: entities = [] - created_alarms = ( - hass.data[DATA_SONOS].alarms[speaker.household_id].created_alarm_ids - ) + created_alarms = config_entry.runtime_data.alarms[ + speaker.household_id + ].created_alarm_ids for alarm_id in alarm_ids: if alarm_id in created_alarms: continue _LOGGER.debug("Creating alarm %s on %s", alarm_id, speaker.zone_name) created_alarms.add(alarm_id) - entities.append(SonosAlarmEntity(alarm_id, speaker)) + entities.append(SonosAlarmEntity(alarm_id, speaker, config_entry)) async_add_entities(entities) def available_soco_attributes(speaker: SonosSpeaker) -> list[str]: @@ -113,7 +112,7 @@ async def _async_create_switches(speaker: SonosSpeaker) -> None: feature_type, speaker.zone_name, ) - entities.append(SonosSwitchEntity(feature_type, speaker)) + entities.append(SonosSwitchEntity(feature_type, speaker, config_entry)) async_add_entities(entities) config_entry.async_on_unload( @@ -127,9 +126,11 @@ async def _async_create_switches(speaker: SonosSpeaker) -> None: class SonosSwitchEntity(SonosPollingEntity, SwitchEntity): """Representation of a Sonos feature switch.""" - def __init__(self, feature_type: str, speaker: SonosSpeaker) -> None: + def __init__( + self, feature_type: str, speaker: SonosSpeaker, config_entry: SonosConfigEntry + ) -> None: """Initialize the switch.""" - super().__init__(speaker) + super().__init__(speaker, config_entry) self.feature_type = feature_type self.needs_coordinator = feature_type in COORDINATOR_FEATURES self._attr_entity_category = EntityCategory.CONFIG @@ -185,9 +186,11 @@ class SonosAlarmEntity(SonosEntity, SwitchEntity): _attr_entity_category = EntityCategory.CONFIG _attr_icon = "mdi:alarm" - def __init__(self, alarm_id: str, speaker: SonosSpeaker) -> None: + def __init__( + self, alarm_id: str, speaker: SonosSpeaker, config_entry: SonosConfigEntry + ) -> None: """Initialize the switch.""" - super().__init__(speaker) + super().__init__(speaker, config_entry) self._attr_unique_id = f"alarm-{speaker.household_id}:{alarm_id}" self.alarm_id = alarm_id self.household_id = speaker.household_id @@ -218,7 +221,9 @@ async def async_write_state_daily(now: datetime.datetime) -> None: @property def alarm(self) -> Alarm: """Return the alarm instance.""" - return self.hass.data[DATA_SONOS].alarms[self.household_id].get(self.alarm_id) + return self.config_entry.runtime_data.alarms[self.household_id].get( + self.alarm_id + ) @property def name(self) -> str: @@ -230,7 +235,9 @@ def name(self) -> str: async def _async_fallback_poll(self) -> None: """Call the central alarm polling method.""" - await self.hass.data[DATA_SONOS].alarms[self.household_id].async_poll() + alarms: SonosAlarms = self.config_entry.runtime_data.alarms[self.household_id] + assert alarms.async_poll + await alarms.async_poll() @callback def async_check_if_available(self) -> bool: @@ -252,9 +259,9 @@ async def async_update_state(self) -> None: return if self.speaker.soco.uid != self.alarm.zone.uid: - self.speaker = self.hass.data[DATA_SONOS].discovered.get( - self.alarm.zone.uid - ) + speaker = self.config_entry.runtime_data.discovered.get(self.alarm.zone.uid) + assert speaker + self.speaker = speaker if self.speaker is None: raise RuntimeError( "No configured Sonos speaker has been found to match the alarm." diff --git a/homeassistant/components/swiss_public_transport/__init__.py b/homeassistant/components/swiss_public_transport/__init__.py index 0d0c4dc6169c49..49fe99497722e3 100644 --- a/homeassistant/components/swiss_public_transport/__init__.py +++ b/homeassistant/components/swiss_public_transport/__init__.py @@ -35,7 +35,7 @@ SwissPublicTransportDataUpdateCoordinator, ) from .helper import offset_opendata, unique_id_from_config -from .services import setup_services +from .services import async_setup_services _LOGGER = logging.getLogger(__name__) @@ -47,7 +47,7 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: """Set up the Swiss public transport component.""" - setup_services(hass) + async_setup_services(hass) return True diff --git a/homeassistant/components/swiss_public_transport/services.py b/homeassistant/components/swiss_public_transport/services.py index 3abf1a14b9f4ce..1ac116b4ca9299 100644 --- a/homeassistant/components/swiss_public_transport/services.py +++ b/homeassistant/components/swiss_public_transport/services.py @@ -8,6 +8,7 @@ ServiceCall, ServiceResponse, SupportsResponse, + callback, ) from homeassistant.exceptions import HomeAssistantError, ServiceValidationError from homeassistant.helpers.selector import ( @@ -39,7 +40,7 @@ ) -def async_get_entry( +def _async_get_entry( hass: HomeAssistant, config_entry_id: str ) -> SwissPublicTransportConfigEntry: """Get the Swiss public transport config entry.""" @@ -58,34 +59,36 @@ def async_get_entry( return entry -def setup_services(hass: HomeAssistant) -> None: - """Set up the services for the Swiss public transport integration.""" +async def _async_fetch_connections( + call: ServiceCall, +) -> ServiceResponse: + """Fetch a set of connections.""" + config_entry = _async_get_entry(call.hass, call.data[ATTR_CONFIG_ENTRY_ID]) + + limit = call.data.get(ATTR_LIMIT) or CONNECTIONS_COUNT + try: + connections = await config_entry.runtime_data.fetch_connections_as_json( + limit=int(limit) + ) + except UpdateFailed as e: + raise HomeAssistantError( + translation_domain=DOMAIN, + translation_key="cannot_connect", + translation_placeholders={ + "error": str(e), + }, + ) from e + return {"connections": connections} - async def async_fetch_connections( - call: ServiceCall, - ) -> ServiceResponse: - """Fetch a set of connections.""" - config_entry = async_get_entry(hass, call.data[ATTR_CONFIG_ENTRY_ID]) - limit = call.data.get(ATTR_LIMIT) or CONNECTIONS_COUNT - try: - connections = await config_entry.runtime_data.fetch_connections_as_json( - limit=int(limit) - ) - except UpdateFailed as e: - raise HomeAssistantError( - translation_domain=DOMAIN, - translation_key="cannot_connect", - translation_placeholders={ - "error": str(e), - }, - ) from e - return {"connections": connections} +@callback +def async_setup_services(hass: HomeAssistant) -> None: + """Set up the services for the Swiss public transport integration.""" hass.services.async_register( DOMAIN, SERVICE_FETCH_CONNECTIONS, - async_fetch_connections, + _async_fetch_connections, schema=SERVICE_FETCH_CONNECTIONS_SCHEMA, supports_response=SupportsResponse.ONLY, ) diff --git a/homeassistant/components/tado/__init__.py b/homeassistant/components/tado/__init__.py index 74768ee01faf4e..0513d63b893ae8 100644 --- a/homeassistant/components/tado/__init__.py +++ b/homeassistant/components/tado/__init__.py @@ -35,7 +35,7 @@ ) from .coordinator import TadoDataUpdateCoordinator, TadoMobileDeviceUpdateCoordinator from .models import TadoData -from .services import setup_services +from .services import async_setup_services PLATFORMS = [ Platform.BINARY_SENSOR, @@ -58,7 +58,7 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: """Set up Tado.""" - setup_services(hass) + async_setup_services(hass) return True diff --git a/homeassistant/components/tado/services.py b/homeassistant/components/tado/services.py index d931ea303e9172..a855f323978782 100644 --- a/homeassistant/components/tado/services.py +++ b/homeassistant/components/tado/services.py @@ -29,26 +29,27 @@ ) -@callback -def setup_services(hass: HomeAssistant) -> None: - """Set up the services for the Tado integration.""" +async def _add_meter_reading(call: ServiceCall) -> None: + """Send meter reading to Tado.""" + entry_id: str = call.data[CONF_CONFIG_ENTRY] + reading: int = call.data[CONF_READING] + _LOGGER.debug("Add meter reading %s", reading) + + entry = call.hass.config_entries.async_get_entry(entry_id) + if entry is None: + raise ServiceValidationError("Config entry not found") - async def add_meter_reading(call: ServiceCall) -> None: - """Send meter reading to Tado.""" - entry_id: str = call.data[CONF_CONFIG_ENTRY] - reading: int = call.data[CONF_READING] - _LOGGER.debug("Add meter reading %s", reading) + coordinator = entry.runtime_data.coordinator + response: dict = await coordinator.set_meter_reading(call.data[CONF_READING]) - entry = hass.config_entries.async_get_entry(entry_id) - if entry is None: - raise ServiceValidationError("Config entry not found") + if ATTR_MESSAGE in response: + raise HomeAssistantError(response[ATTR_MESSAGE]) - coordinator = entry.runtime_data.coordinator - response: dict = await coordinator.set_meter_reading(call.data[CONF_READING]) - if ATTR_MESSAGE in response: - raise HomeAssistantError(response[ATTR_MESSAGE]) +@callback +def async_setup_services(hass: HomeAssistant) -> None: + """Set up the services for the Tado integration.""" hass.services.async_register( - DOMAIN, SERVICE_ADD_METER_READING, add_meter_reading, SCHEMA_ADD_METER_READING + DOMAIN, SERVICE_ADD_METER_READING, _add_meter_reading, SCHEMA_ADD_METER_READING ) diff --git a/homeassistant/components/vodafone_station/utils.py b/homeassistant/components/vodafone_station/utils.py index 4f900412fafad7..faa498afdd6ff5 100644 --- a/homeassistant/components/vodafone_station/utils.py +++ b/homeassistant/components/vodafone_station/utils.py @@ -9,5 +9,5 @@ async def async_client_session(hass: HomeAssistant) -> ClientSession: """Return a new aiohttp session.""" return aiohttp_client.async_create_clientsession( - hass, verify_ssl=False, cookie_jar=CookieJar(unsafe=True) + hass, verify_ssl=False, cookie_jar=CookieJar(unsafe=True, quote_cookie=False) ) diff --git a/homeassistant/components/xiaomi_miio/fan.py b/homeassistant/components/xiaomi_miio/fan.py index c69bd150226533..d10bdaad2172d7 100644 --- a/homeassistant/components/xiaomi_miio/fan.py +++ b/homeassistant/components/xiaomi_miio/fan.py @@ -25,6 +25,8 @@ from miio.integrations.airpurifier.zhimi.airpurifier_miot import ( OperationMode as AirpurifierMiotOperationMode, ) +from miio.integrations.fan.dmaker.fan import FanStatusP5 +from miio.integrations.fan.dmaker.fan_miot import FanStatusMiot from miio.integrations.fan.zhimi.zhimi_miot import ( OperationModeFanZA5 as FanZA5OperationMode, ) @@ -330,6 +332,12 @@ def percentage(self) -> int | None: """Return the percentage based speed of the fan.""" return None + @property + def is_on(self) -> bool | None: + """Return true if device is on.""" + # Base FanEntity uses percentage to determine if the device is on. + return self._attr_is_on + async def async_turn_on( self, percentage: int | None = None, @@ -1077,12 +1085,14 @@ async def async_set_percentage(self, percentage: int) -> None: class XiaomiFanP5(XiaomiGenericFan): """Representation of a Xiaomi Fan P5.""" + coordinator: DataUpdateCoordinator[FanStatusP5] + def __init__( self, device: MiioDevice, entry: XiaomiMiioConfigEntry, unique_id: str | None, - coordinator: DataUpdateCoordinator[Any], + coordinator: DataUpdateCoordinator[FanStatusP5], ) -> None: """Initialize the fan.""" super().__init__(device, entry, unique_id, coordinator) @@ -1140,13 +1150,15 @@ async def async_set_percentage(self, percentage: int) -> None: class XiaomiFanMiot(XiaomiGenericFan): """Representation of a Xiaomi Fan Miot.""" + coordinator: DataUpdateCoordinator[FanStatusMiot] + @property - def operation_mode_class(self): + def operation_mode_class(self) -> type[FanOperationMode]: """Hold operation mode class.""" return FanOperationMode @callback - def _handle_coordinator_update(self): + def _handle_coordinator_update(self) -> None: """Fetch state from the device.""" self._attr_is_on = self.coordinator.data.is_on self._attr_preset_mode = self.coordinator.data.mode.name diff --git a/tests/components/lifx/test_light.py b/tests/components/lifx/test_light.py index 58843d63f9a3ed..d66908c1b1aeb0 100644 --- a/tests/components/lifx/test_light.py +++ b/tests/components/lifx/test_light.py @@ -843,7 +843,7 @@ async def test_sky_effect(hass: HomeAssistant) -> None: SERVICE_EFFECT_SKY, { ATTR_ENTITY_ID: entity_id, - ATTR_PALETTE: [], + ATTR_PALETTE: None, ATTR_SKY_TYPE: "Clouds", ATTR_CLOUD_SATURATION_MAX: 180, ATTR_CLOUD_SATURATION_MIN: 50, @@ -854,7 +854,7 @@ async def test_sky_effect(hass: HomeAssistant) -> None: bulb.power_level = 65535 bulb.effect = { "effect": "SKY", - "palette": [], + "palette": None, "sky_type": 2, "cloud_saturation_min": 50, "cloud_saturation_max": 180, diff --git a/tests/components/sonos/test_services.py b/tests/components/sonos/test_services.py index da894ff4548baa..8f83ce2f8145c3 100644 --- a/tests/components/sonos/test_services.py +++ b/tests/components/sonos/test_services.py @@ -5,12 +5,15 @@ import pytest from homeassistant.components.media_player import DOMAIN as MP_DOMAIN, SERVICE_JOIN -from homeassistant.components.sonos.const import DATA_SONOS from homeassistant.core import HomeAssistant from homeassistant.exceptions import HomeAssistantError +from tests.common import MockConfigEntry -async def test_media_player_join(hass: HomeAssistant, async_autosetup_sonos) -> None: + +async def test_media_player_join( + hass: HomeAssistant, async_autosetup_sonos, config_entry: MockConfigEntry +) -> None: """Test join service.""" valid_entity_id = "media_player.zone_a" mocked_entity_id = "media_player.mocked" @@ -29,7 +32,10 @@ async def test_media_player_join(hass: HomeAssistant, async_autosetup_sonos) -> mock_entity_id_mappings = {mocked_entity_id: mocked_speaker} with ( - patch.dict(hass.data[DATA_SONOS].entity_id_mappings, mock_entity_id_mappings), + patch.dict( + config_entry.runtime_data.entity_id_mappings, + mock_entity_id_mappings, + ), patch( "homeassistant.components.sonos.speaker.SonosSpeaker.join_multi" ) as mock_join_multi, @@ -41,5 +47,7 @@ async def test_media_player_join(hass: HomeAssistant, async_autosetup_sonos) -> blocking=True, ) - found_speaker = hass.data[DATA_SONOS].entity_id_mappings[valid_entity_id] - mock_join_multi.assert_called_with(hass, found_speaker, [mocked_speaker]) + found_speaker = config_entry.runtime_data.entity_id_mappings[valid_entity_id] + mock_join_multi.assert_called_with( + hass, config_entry, found_speaker, [mocked_speaker] + ) diff --git a/tests/components/sonos/test_speaker.py b/tests/components/sonos/test_speaker.py index 40d126c64f2aa2..468b848dfb50fc 100644 --- a/tests/components/sonos/test_speaker.py +++ b/tests/components/sonos/test_speaker.py @@ -9,13 +9,18 @@ SERVICE_MEDIA_PLAY, ) from homeassistant.components.sonos import DOMAIN -from homeassistant.components.sonos.const import DATA_SONOS, SCAN_INTERVAL +from homeassistant.components.sonos.const import SCAN_INTERVAL from homeassistant.core import HomeAssistant from homeassistant.util import dt as dt_util from .conftest import MockSoCo, SonosMockEvent -from tests.common import async_fire_time_changed, load_fixture, load_json_value_fixture +from tests.common import ( + MockConfigEntry, + async_fire_time_changed, + load_fixture, + load_json_value_fixture, +) async def test_fallback_to_polling( @@ -33,7 +38,7 @@ async def test_fallback_to_polling( await hass.async_block_till_done() await fire_zgs_event() - speaker = list(hass.data[DATA_SONOS].discovered.values())[0] + speaker = list(config_entry.runtime_data.discovered.values())[0] assert speaker.soco is soco assert speaker._subscriptions assert not speaker.subscriptions_failed @@ -56,7 +61,7 @@ async def test_fallback_to_polling( async def test_subscription_creation_fails( - hass: HomeAssistant, async_setup_sonos + hass: HomeAssistant, async_setup_sonos, config_entry: MockConfigEntry ) -> None: """Test that subscription creation failures are handled.""" with patch( @@ -66,7 +71,7 @@ async def test_subscription_creation_fails( await async_setup_sonos() await hass.async_block_till_done(wait_background_tasks=True) - speaker = list(hass.data[DATA_SONOS].discovered.values())[0] + speaker = list(config_entry.runtime_data.discovered.values())[0] assert not speaker._subscriptions with patch.object(speaker, "_resub_cooldown_expires_at", None): diff --git a/tests/components/sonos/test_statistics.py b/tests/components/sonos/test_statistics.py index 4f28ec314121ea..84f8fca138e4ed 100644 --- a/tests/components/sonos/test_statistics.py +++ b/tests/components/sonos/test_statistics.py @@ -1,14 +1,19 @@ """Tests for the Sonos statistics.""" -from homeassistant.components.sonos.const import DATA_SONOS from homeassistant.core import HomeAssistant +from tests.common import MockConfigEntry + async def test_statistics_duplicate( - hass: HomeAssistant, async_autosetup_sonos, soco, device_properties_event + hass: HomeAssistant, + async_autosetup_sonos, + soco, + device_properties_event, + config_entry: MockConfigEntry, ) -> None: """Test Sonos statistics.""" - speaker = list(hass.data[DATA_SONOS].discovered.values())[0] + speaker = list(config_entry.runtime_data.discovered.values())[0] subscription = soco.deviceProperties.subscribe.return_value sub_callback = subscription.callback