jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-22 20:57:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Allow config entries unload action to be coroutine (#91531)

Browse Source 
* Allow config entries unload action to be coroutine

* Adjust comment
This commit is contained in:
epenet 2023-04-17 14:41:25 +02:00 committed by GitHub
parent 6a80f5fc60
commit 3364f0fce2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
homeassistant/config_entries.py
View File

@ -310,8 +310,10 @@ class ConfigEntry:
# Function to cancel a scheduled retry # Function to cancel a scheduled retry
self._async_cancel_retry_setup: Callable[[], Any] | None = None self._async_cancel_retry_setup: Callable[[], Any] | None = None
# Hold list for functions to call on unload. # Hold list for actions to call on unload.
self._on_unload: list[CALLBACK_TYPE] | None = None self._on_unload: list[
Callable[[], Coroutine[Any, Any, None] | None]
] | None = None
# Reload lock to prevent conflicting reloads # Reload lock to prevent conflicting reloads
self.reload_lock = asyncio.Lock() self.reload_lock = asyncio.Lock()
@ -395,7 +397,7 @@ class ConfigEntry:
self.domain, self.domain,
error_reason, error_reason,
) )
await self._async_process_on_unload() await self._async_process_on_unload(hass)
result = False result = False
except ConfigEntryAuthFailed as ex: except ConfigEntryAuthFailed as ex:
message = str(ex) message = str(ex)
@ -410,7 +412,7 @@ class ConfigEntry:
self.domain, self.domain,
auth_message, auth_message,
) )
await self._async_process_on_unload() await self._async_process_on_unload(hass)
self.async_start_reauth(hass) self.async_start_reauth(hass)
result = False result = False
except ConfigEntryNotReady as ex: except ConfigEntryNotReady as ex:
@ -461,7 +463,7 @@ class ConfigEntry:
EVENT_HOMEASSISTANT_STARTED, setup_again EVENT_HOMEASSISTANT_STARTED, setup_again
) )
await self._async_process_on_unload() await self._async_process_on_unload(hass)
return return
# pylint: disable-next=broad-except # pylint: disable-next=broad-except
except (asyncio.CancelledError, SystemExit, Exception): except (asyncio.CancelledError, SystemExit, Exception):
@ -544,7 +546,7 @@ class ConfigEntry:
if result and integration.domain == self.domain: if result and integration.domain == self.domain:
self.async_set_state(hass, ConfigEntryState.NOT_LOADED, None) self.async_set_state(hass, ConfigEntryState.NOT_LOADED, None)
await self._async_process_on_unload() await self._async_process_on_unload(hass)
return result return result
except Exception as ex: # pylint: disable=broad-except except Exception as ex: # pylint: disable=broad-except
@ -674,17 +676,20 @@ class ConfigEntry:
} }
@callback @callback
def async_on_unload(self, func: CALLBACK_TYPE) -> None: def async_on_unload(
self, func: Callable[[], Coroutine[Any, Any, None] | None]
) -> None:
"""Add a function to call when config entry is unloaded.""" """Add a function to call when config entry is unloaded."""
if self._on_unload is None: if self._on_unload is None:
self._on_unload = [] self._on_unload = []
self._on_unload.append(func) self._on_unload.append(func)
async def _async_process_on_unload(self) -> None: async def _async_process_on_unload(self, hass: HomeAssistant) -> None:
"""Process the on_unload callbacks and wait for pending tasks.""" """Process the on_unload callbacks and wait for pending tasks."""
if self._on_unload is not None: if self._on_unload is not None:
while self._on_unload: while self._on_unload:
self._on_unload.pop()() if job := self._on_unload.pop()():
self._tasks.add(hass.async_create_task(job))
if not self._tasks and not self._background_tasks: if not self._tasks and not self._background_tasks:
return return

11
tests/test_config_entries.py
View File

@ -3867,7 +3867,7 @@ async def test_task_tracking(hass: HomeAssistant) -> None:
event = asyncio.Event() event = asyncio.Event()
results = [] results = []
async def test_task(): async def test_task() -> None:
try: try:
await event.wait() await event.wait()
results.append("normal") results.append("normal")
@ -3875,9 +3875,14 @@ async def test_task_tracking(hass: HomeAssistant) -> None:
results.append("background") results.append("background")
raise raise
async def test_unload() -> None:
await event.wait()
results.append("on_unload")
entry.async_on_unload(test_unload)
entry.async_create_task(hass, test_task()) entry.async_create_task(hass, test_task())
entry.async_create_background_task(hass, test_task(), "background-task-name") entry.async_create_background_task(hass, test_task(), "background-task-name")
await asyncio.sleep(0) await asyncio.sleep(0)
hass.loop.call_soon(event.set) hass.loop.call_soon(event.set)
await entry._async_process_on_unload() await entry._async_process_on_unload(hass)
assert results == ["background", "normal"] assert results == ["on_unload", "background", "normal"]