mirror of
https://github.com/home-assistant/core.git
synced 2025-07-23 21:27:38 +00:00
Migrate harmony to use async_run_hass_job (#113178)
This commit is contained in:
parent
fb163278a4
commit
a65908becc
@ -20,7 +20,7 @@ from homeassistant.components.remote import (
|
|||||||
RemoteEntityFeature,
|
RemoteEntityFeature,
|
||||||
)
|
)
|
||||||
from homeassistant.config_entries import ConfigEntry
|
from homeassistant.config_entries import ConfigEntry
|
||||||
from homeassistant.core import HomeAssistant, callback
|
from homeassistant.core import HassJob, HomeAssistant, callback
|
||||||
from homeassistant.helpers import entity_platform
|
from homeassistant.helpers import entity_platform
|
||||||
import homeassistant.helpers.config_validation as cv
|
import homeassistant.helpers.config_validation as cv
|
||||||
from homeassistant.helpers.dispatcher import async_dispatcher_connect
|
from homeassistant.helpers.dispatcher import async_dispatcher_connect
|
||||||
@ -117,11 +117,11 @@ class HarmonyRemote(HarmonyEntity, RemoteEntity, RestoreEntity):
|
|||||||
self.async_on_remove(
|
self.async_on_remove(
|
||||||
self._data.async_subscribe(
|
self._data.async_subscribe(
|
||||||
HarmonyCallback(
|
HarmonyCallback(
|
||||||
connected=self.async_got_connected,
|
connected=HassJob(self.async_got_connected),
|
||||||
disconnected=self.async_got_disconnected,
|
disconnected=HassJob(self.async_got_disconnected),
|
||||||
config_updated=self.async_new_config,
|
config_updated=HassJob(self.async_new_config),
|
||||||
activity_starting=self.async_new_activity,
|
activity_starting=HassJob(self.async_new_activity),
|
||||||
activity_started=self.async_new_activity_finished,
|
activity_started=HassJob(self.async_new_activity_finished),
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
@ -7,7 +7,7 @@ import logging
|
|||||||
from homeassistant.components.select import SelectEntity
|
from homeassistant.components.select import SelectEntity
|
||||||
from homeassistant.config_entries import ConfigEntry
|
from homeassistant.config_entries import ConfigEntry
|
||||||
from homeassistant.const import CONF_NAME
|
from homeassistant.const import CONF_NAME
|
||||||
from homeassistant.core import HomeAssistant, callback
|
from homeassistant.core import HassJob, HomeAssistant, callback
|
||||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||||
|
|
||||||
from .const import ACTIVITY_POWER_OFF, DOMAIN, HARMONY_DATA
|
from .const import ACTIVITY_POWER_OFF, DOMAIN, HARMONY_DATA
|
||||||
@ -66,13 +66,14 @@ class HarmonyActivitySelect(HarmonyEntity, SelectEntity):
|
|||||||
|
|
||||||
async def async_added_to_hass(self) -> None:
|
async def async_added_to_hass(self) -> None:
|
||||||
"""Call when entity is added to hass."""
|
"""Call when entity is added to hass."""
|
||||||
|
activity_update_job = HassJob(self._async_activity_update)
|
||||||
self.async_on_remove(
|
self.async_on_remove(
|
||||||
self._data.async_subscribe(
|
self._data.async_subscribe(
|
||||||
HarmonyCallback(
|
HarmonyCallback(
|
||||||
connected=self.async_got_connected,
|
connected=HassJob(self.async_got_connected),
|
||||||
disconnected=self.async_got_disconnected,
|
disconnected=HassJob(self.async_got_disconnected),
|
||||||
activity_starting=self._async_activity_update,
|
activity_starting=activity_update_job,
|
||||||
activity_started=self._async_activity_update,
|
activity_started=activity_update_job,
|
||||||
config_updated=None,
|
config_updated=None,
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
@ -3,16 +3,15 @@
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from collections.abc import Callable
|
|
||||||
import logging
|
import logging
|
||||||
from typing import Any, NamedTuple
|
from typing import Any, NamedTuple
|
||||||
|
|
||||||
from homeassistant.core import CALLBACK_TYPE, HomeAssistant, callback
|
from homeassistant.core import CALLBACK_TYPE, HassJob, HomeAssistant, callback
|
||||||
|
|
||||||
_LOGGER = logging.getLogger(__name__)
|
_LOGGER = logging.getLogger(__name__)
|
||||||
|
|
||||||
NoParamCallback = Callable[[], Any] | None
|
NoParamCallback = HassJob[[], Any] | None
|
||||||
ActivityCallback = Callable[[tuple], Any] | None
|
ActivityCallback = HassJob[[tuple], Any] | None
|
||||||
|
|
||||||
|
|
||||||
class HarmonyCallback(NamedTuple):
|
class HarmonyCallback(NamedTuple):
|
||||||
@ -89,9 +88,8 @@ class HarmonySubscriberMixin:
|
|||||||
self, callback_func_name: str, argument: tuple | None = None
|
self, callback_func_name: str, argument: tuple | None = None
|
||||||
) -> None:
|
) -> None:
|
||||||
for subscription in self._subscriptions:
|
for subscription in self._subscriptions:
|
||||||
current_callback = getattr(subscription, callback_func_name)
|
if current_callback_job := getattr(subscription, callback_func_name):
|
||||||
if current_callback:
|
|
||||||
if argument:
|
if argument:
|
||||||
self._hass.async_run_job(current_callback, argument)
|
self._hass.async_run_hass_job(current_callback_job, argument)
|
||||||
else:
|
else:
|
||||||
self._hass.async_run_job(current_callback)
|
self._hass.async_run_hass_job(current_callback_job)
|
||||||
|
@ -8,7 +8,7 @@ from homeassistant.components.script import scripts_with_entity
|
|||||||
from homeassistant.components.switch import DOMAIN as SWITCH_DOMAIN, SwitchEntity
|
from homeassistant.components.switch import DOMAIN as SWITCH_DOMAIN, SwitchEntity
|
||||||
from homeassistant.config_entries import ConfigEntry
|
from homeassistant.config_entries import ConfigEntry
|
||||||
from homeassistant.const import CONF_NAME
|
from homeassistant.const import CONF_NAME
|
||||||
from homeassistant.core import HomeAssistant, callback
|
from homeassistant.core import HassJob, HomeAssistant, callback
|
||||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||||
from homeassistant.helpers.issue_registry import IssueSeverity, async_create_issue
|
from homeassistant.helpers.issue_registry import IssueSeverity, async_create_issue
|
||||||
|
|
||||||
@ -83,13 +83,14 @@ class HarmonyActivitySwitch(HarmonyEntity, SwitchEntity):
|
|||||||
|
|
||||||
async def async_added_to_hass(self) -> None:
|
async def async_added_to_hass(self) -> None:
|
||||||
"""Call when entity is added to hass."""
|
"""Call when entity is added to hass."""
|
||||||
|
activity_update_job = HassJob(self._async_activity_update)
|
||||||
self.async_on_remove(
|
self.async_on_remove(
|
||||||
self._data.async_subscribe(
|
self._data.async_subscribe(
|
||||||
HarmonyCallback(
|
HarmonyCallback(
|
||||||
connected=self.async_got_connected,
|
connected=HassJob(self.async_got_connected),
|
||||||
disconnected=self.async_got_disconnected,
|
disconnected=HassJob(self.async_got_disconnected),
|
||||||
activity_starting=self._async_activity_update,
|
activity_starting=activity_update_job,
|
||||||
activity_started=self._async_activity_update,
|
activity_started=activity_update_job,
|
||||||
config_updated=None,
|
config_updated=None,
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
@ -7,7 +7,7 @@ from homeassistant.components.harmony.subscriber import (
|
|||||||
HarmonyCallback,
|
HarmonyCallback,
|
||||||
HarmonySubscriberMixin,
|
HarmonySubscriberMixin,
|
||||||
)
|
)
|
||||||
from homeassistant.core import HomeAssistant
|
from homeassistant.core import HassJob, HomeAssistant
|
||||||
|
|
||||||
_NO_PARAM_CALLBACKS = {
|
_NO_PARAM_CALLBACKS = {
|
||||||
"connected": "_connected",
|
"connected": "_connected",
|
||||||
@ -48,18 +48,18 @@ async def test_async_callbacks(hass: HomeAssistant) -> None:
|
|||||||
"""Ensure we handle async callbacks."""
|
"""Ensure we handle async callbacks."""
|
||||||
subscriber = HarmonySubscriberMixin(hass)
|
subscriber = HarmonySubscriberMixin(hass)
|
||||||
|
|
||||||
callbacks = {k: AsyncMock() for k in _ALL_CALLBACK_NAMES}
|
callbacks = {k: HassJob(AsyncMock()) for k in _ALL_CALLBACK_NAMES}
|
||||||
subscriber.async_subscribe(HarmonyCallback(**callbacks))
|
subscriber.async_subscribe(HarmonyCallback(**callbacks))
|
||||||
_call_all_callbacks(subscriber)
|
_call_all_callbacks(subscriber)
|
||||||
await hass.async_block_till_done()
|
await hass.async_block_till_done()
|
||||||
|
|
||||||
for callback_name in _NO_PARAM_CALLBACKS:
|
for callback_name in _NO_PARAM_CALLBACKS:
|
||||||
callback_mock = callbacks[callback_name]
|
callback_mock = callbacks[callback_name]
|
||||||
callback_mock.assert_awaited_once()
|
callback_mock.target.assert_awaited_once()
|
||||||
|
|
||||||
for callback_name in _ACTIVITY_CALLBACKS:
|
for callback_name in _ACTIVITY_CALLBACKS:
|
||||||
callback_mock = callbacks[callback_name]
|
callback_mock = callbacks[callback_name]
|
||||||
callback_mock.assert_awaited_once_with(_ACTIVITY_TUPLE)
|
callback_mock.target.assert_awaited_once_with(_ACTIVITY_TUPLE)
|
||||||
|
|
||||||
|
|
||||||
async def test_long_async_callbacks(hass: HomeAssistant) -> None:
|
async def test_long_async_callbacks(hass: HomeAssistant) -> None:
|
||||||
@ -77,8 +77,8 @@ async def test_long_async_callbacks(hass: HomeAssistant) -> None:
|
|||||||
async def notifies_when_called():
|
async def notifies_when_called():
|
||||||
notifier_event_two.set()
|
notifier_event_two.set()
|
||||||
|
|
||||||
callbacks_one = {k: blocks_until_notified for k in _ALL_CALLBACK_NAMES}
|
callbacks_one = {k: HassJob(blocks_until_notified) for k in _ALL_CALLBACK_NAMES}
|
||||||
callbacks_two = {k: notifies_when_called for k in _ALL_CALLBACK_NAMES}
|
callbacks_two = {k: HassJob(notifies_when_called) for k in _ALL_CALLBACK_NAMES}
|
||||||
subscriber.async_subscribe(HarmonyCallback(**callbacks_one))
|
subscriber.async_subscribe(HarmonyCallback(**callbacks_one))
|
||||||
subscriber.async_subscribe(HarmonyCallback(**callbacks_two))
|
subscriber.async_subscribe(HarmonyCallback(**callbacks_two))
|
||||||
|
|
||||||
@ -92,29 +92,29 @@ async def test_callbacks(hass: HomeAssistant) -> None:
|
|||||||
"""Ensure we handle non-async callbacks."""
|
"""Ensure we handle non-async callbacks."""
|
||||||
subscriber = HarmonySubscriberMixin(hass)
|
subscriber = HarmonySubscriberMixin(hass)
|
||||||
|
|
||||||
callbacks = {k: MagicMock() for k in _ALL_CALLBACK_NAMES}
|
callbacks = {k: HassJob(MagicMock()) for k in _ALL_CALLBACK_NAMES}
|
||||||
subscriber.async_subscribe(HarmonyCallback(**callbacks))
|
subscriber.async_subscribe(HarmonyCallback(**callbacks))
|
||||||
_call_all_callbacks(subscriber)
|
_call_all_callbacks(subscriber)
|
||||||
await hass.async_block_till_done()
|
await hass.async_block_till_done()
|
||||||
|
|
||||||
for callback_name in _NO_PARAM_CALLBACKS:
|
for callback_name in _NO_PARAM_CALLBACKS:
|
||||||
callback_mock = callbacks[callback_name]
|
callback_mock = callbacks[callback_name]
|
||||||
callback_mock.assert_called_once()
|
callback_mock.target.assert_called_once()
|
||||||
|
|
||||||
for callback_name in _ACTIVITY_CALLBACKS:
|
for callback_name in _ACTIVITY_CALLBACKS:
|
||||||
callback_mock = callbacks[callback_name]
|
callback_mock = callbacks[callback_name]
|
||||||
callback_mock.assert_called_once_with(_ACTIVITY_TUPLE)
|
callback_mock.target.assert_called_once_with(_ACTIVITY_TUPLE)
|
||||||
|
|
||||||
|
|
||||||
async def test_subscribe_unsubscribe(hass: HomeAssistant) -> None:
|
async def test_subscribe_unsubscribe(hass: HomeAssistant) -> None:
|
||||||
"""Ensure we handle subscriptions and unsubscriptions correctly."""
|
"""Ensure we handle subscriptions and unsubscriptions correctly."""
|
||||||
subscriber = HarmonySubscriberMixin(hass)
|
subscriber = HarmonySubscriberMixin(hass)
|
||||||
|
|
||||||
callback_one = {k: MagicMock() for k in _ALL_CALLBACK_NAMES}
|
callback_one = {k: HassJob(MagicMock()) for k in _ALL_CALLBACK_NAMES}
|
||||||
unsub_one = subscriber.async_subscribe(HarmonyCallback(**callback_one))
|
unsub_one = subscriber.async_subscribe(HarmonyCallback(**callback_one))
|
||||||
callback_two = {k: MagicMock() for k in _ALL_CALLBACK_NAMES}
|
callback_two = {k: HassJob(MagicMock()) for k in _ALL_CALLBACK_NAMES}
|
||||||
_ = subscriber.async_subscribe(HarmonyCallback(**callback_two))
|
_ = subscriber.async_subscribe(HarmonyCallback(**callback_two))
|
||||||
callback_three = {k: MagicMock() for k in _ALL_CALLBACK_NAMES}
|
callback_three = {k: HassJob(MagicMock()) for k in _ALL_CALLBACK_NAMES}
|
||||||
unsub_three = subscriber.async_subscribe(HarmonyCallback(**callback_three))
|
unsub_three = subscriber.async_subscribe(HarmonyCallback(**callback_three))
|
||||||
|
|
||||||
unsub_one()
|
unsub_one()
|
||||||
@ -124,14 +124,14 @@ async def test_subscribe_unsubscribe(hass: HomeAssistant) -> None:
|
|||||||
await hass.async_block_till_done()
|
await hass.async_block_till_done()
|
||||||
|
|
||||||
for callback_name in _NO_PARAM_CALLBACKS:
|
for callback_name in _NO_PARAM_CALLBACKS:
|
||||||
callback_one[callback_name].assert_not_called()
|
callback_one[callback_name].target.assert_not_called()
|
||||||
callback_two[callback_name].assert_called_once()
|
callback_two[callback_name].target.assert_called_once()
|
||||||
callback_three[callback_name].assert_not_called()
|
callback_three[callback_name].target.assert_not_called()
|
||||||
|
|
||||||
for callback_name in _ACTIVITY_CALLBACKS:
|
for callback_name in _ACTIVITY_CALLBACKS:
|
||||||
callback_one[callback_name].assert_not_called()
|
callback_one[callback_name].target.assert_not_called()
|
||||||
callback_two[callback_name].assert_called_once_with(_ACTIVITY_TUPLE)
|
callback_two[callback_name].target.assert_called_once_with(_ACTIVITY_TUPLE)
|
||||||
callback_three[callback_name].assert_not_called()
|
callback_three[callback_name].target.assert_not_called()
|
||||||
|
|
||||||
|
|
||||||
def _call_all_callbacks(subscriber):
|
def _call_all_callbacks(subscriber):
|
||||||
|
Loading…
x
Reference in New Issue
Block a user