60a1948ab0
* Adding switch code for harmony activities * Working on-off * Removing poll code for now * Async updates for current activity * Update our state based on events * Notifications we got connected or disconnected * Remove unncessary constructor arg * Initial switch tests * Additional tests for switch transitions * Test transitions for availability * Testing switch state changes * Tests passing * Final tests * Updating manifest. * Correctly mock the return value from a call to the library * Adding new subscriber classes * Update class name and location * Got the refactor working locally. * Tests passing * Tracking state changes * Remove write_to_config_file - this appears to never be read. It was added far back in the past to account for a harmony library change, but nothing ever reads that path. Removing that side effect from tests is a pain - avoid the side effect completely. * Connection changes tested * Clean up temporary code * Update .coveragerc for harmony component Specifically exclude untested files instead of the whole module * Fix linting * test sending activity change commands by id * Improving coverage * Testing channel change commands * Splitting subscriber logic into it's own class * Improve coverage and tighten up .coveragerc * Test cleanups. * re-add config file writing for harmony remote * Create fixture for the mock harmonyclient * Reduce duplication in subscription callbacks * use async_run_job to call callbacks * Adding some tests for async behaviors with subscribers. * async_call_later for delay in marking remote unavailable * Test disconnection handling in harmony remote * Early exit if activity not specified * Use connection state mixin * Lint fix after rebase * Fix isort * super init for ConnectionStateMixin * Adding @mkeesey to harmony CODEOWNERS
77 lines
2.5 KiB
Python
77 lines
2.5 KiB
Python
"""Mixin class for handling harmony callback subscriptions."""
|
|
|
|
import logging
|
|
from typing import Any, Callable, NamedTuple, Optional
|
|
|
|
from homeassistant.core import callback
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
NoParamCallback = Optional[Callable[[object], Any]]
|
|
ActivityCallback = Optional[Callable[[object, tuple], Any]]
|
|
|
|
|
|
class HarmonyCallback(NamedTuple):
|
|
"""Callback type for Harmony Hub notifications."""
|
|
|
|
connected: NoParamCallback
|
|
disconnected: NoParamCallback
|
|
config_updated: NoParamCallback
|
|
activity_starting: ActivityCallback
|
|
activity_started: ActivityCallback
|
|
|
|
|
|
class HarmonySubscriberMixin:
|
|
"""Base implementation for a subscriber."""
|
|
|
|
def __init__(self, hass):
|
|
"""Initialize an subscriber."""
|
|
super().__init__()
|
|
self._hass = hass
|
|
self._subscriptions = []
|
|
|
|
@callback
|
|
def async_subscribe(self, update_callbacks: HarmonyCallback) -> Callable:
|
|
"""Add a callback subscriber."""
|
|
self._subscriptions.append(update_callbacks)
|
|
|
|
def _unsubscribe():
|
|
self.async_unsubscribe(update_callbacks)
|
|
|
|
return _unsubscribe
|
|
|
|
@callback
|
|
def async_unsubscribe(self, update_callback: HarmonyCallback):
|
|
"""Remove a callback subscriber."""
|
|
self._subscriptions.remove(update_callback)
|
|
|
|
def _config_updated(self, _=None) -> None:
|
|
_LOGGER.debug("config_updated")
|
|
self._call_callbacks("config_updated")
|
|
|
|
def _connected(self, _=None) -> None:
|
|
_LOGGER.debug("connected")
|
|
self._available = True
|
|
self._call_callbacks("connected")
|
|
|
|
def _disconnected(self, _=None) -> None:
|
|
_LOGGER.debug("disconnected")
|
|
self._available = False
|
|
self._call_callbacks("disconnected")
|
|
|
|
def _activity_starting(self, activity_info: tuple) -> None:
|
|
_LOGGER.debug("activity %s starting", activity_info)
|
|
self._call_callbacks("activity_starting", activity_info)
|
|
|
|
def _activity_started(self, activity_info: tuple) -> None:
|
|
_LOGGER.debug("activity %s started", activity_info)
|
|
self._call_callbacks("activity_started", activity_info)
|
|
|
|
def _call_callbacks(self, callback_func_name: str, argument: tuple = None):
|
|
for subscription in self._subscriptions:
|
|
current_callback = getattr(subscription, callback_func_name)
|
|
if current_callback:
|
|
if argument:
|
|
self._hass.async_run_job(current_callback, argument)
|
|
else:
|
|
self._hass.async_run_job(current_callback)
|