From f57884cb95fca02492ccb6c5983c8d3f7d88243e Mon Sep 17 00:00:00 2001 From: epenet <6771947+epenet@users.noreply.github.com> Date: Fri, 6 Mar 2026 19:54:20 +0100 Subject: [PATCH] Move kraken API wrapper class to coordinator module (#164942) Co-authored-by: Claude Opus 4.6 --- homeassistant/components/kraken/__init__.py | 128 +---------------- .../components/kraken/coordinator.py | 133 ++++++++++++++++++ homeassistant/components/kraken/sensor.py | 2 +- tests/components/kraken/conftest.py | 4 +- 4 files changed, 139 insertions(+), 128 deletions(-) create mode 100644 homeassistant/components/kraken/coordinator.py diff --git a/homeassistant/components/kraken/__init__.py b/homeassistant/components/kraken/__init__.py index ccdd704d9df..065b647a971 100644 --- a/homeassistant/components/kraken/__init__.py +++ b/homeassistant/components/kraken/__init__.py @@ -2,35 +2,16 @@ from __future__ import annotations -import asyncio -from datetime import timedelta -import logging - -import krakenex -import pykrakenapi - from homeassistant.config_entries import ConfigEntry from homeassistant.const import CONF_SCAN_INTERVAL, Platform from homeassistant.core import HomeAssistant from homeassistant.helpers.dispatcher import async_dispatcher_send -from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed -from .const import ( - CONF_TRACKED_ASSET_PAIRS, - DEFAULT_SCAN_INTERVAL, - DEFAULT_TRACKED_ASSET_PAIR, - DISPATCH_CONFIG_UPDATED, - DOMAIN, - KrakenResponse, -) -from .utils import get_tradable_asset_pairs - -CALL_RATE_LIMIT_SLEEP = 1 +from .const import DISPATCH_CONFIG_UPDATED, DOMAIN +from .coordinator import KrakenData PLATFORMS = [Platform.SENSOR] -_LOGGER = logging.getLogger(__name__) - async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool: """Set up kraken from a config entry.""" @@ -53,111 +34,6 @@ async def async_unload_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> return unload_ok -class KrakenData: - """Define an object to hold kraken data.""" - - def __init__(self, hass: HomeAssistant, config_entry: ConfigEntry) -> None: - """Initialize.""" - self._hass = hass - self._config_entry = config_entry - self._api = pykrakenapi.KrakenAPI(krakenex.API(), retry=0, crl_sleep=0) - self.tradable_asset_pairs: dict[str, str] = {} - self.coordinator: DataUpdateCoordinator[KrakenResponse | None] | None = None - - async def async_update(self) -> KrakenResponse | None: - """Get the latest data from the Kraken.com REST API. - - All tradeable asset pairs are retrieved, not the tracked asset pairs - selected by the user. This enables us to check for an unknown and - thus likely removed asset pair in sensor.py and only log a warning - once. - """ - try: - async with asyncio.timeout(10): - return await self._hass.async_add_executor_job(self._get_kraken_data) - except pykrakenapi.pykrakenapi.KrakenAPIError as error: - if "Unknown asset pair" in str(error): - _LOGGER.warning( - "Kraken.com reported an unknown asset pair. Refreshing list of" - " tradable asset pairs" - ) - await self._async_refresh_tradable_asset_pairs() - else: - raise UpdateFailed( - f"Unable to fetch data from Kraken.com: {error}" - ) from error - except pykrakenapi.pykrakenapi.CallRateLimitError: - _LOGGER.warning( - "Exceeded the Kraken.com call rate limit. Increase the update interval" - " to prevent this error" - ) - return None - - def _get_kraken_data(self) -> KrakenResponse: - websocket_name_pairs = self._get_websocket_name_asset_pairs() - ticker_df = self._api.get_ticker_information(websocket_name_pairs) - # Rename columns to their full name - ticker_df = ticker_df.rename( - columns={ - "a": "ask", - "b": "bid", - "c": "last_trade_closed", - "v": "volume", - "p": "volume_weighted_average", - "t": "number_of_trades", - "l": "low", - "h": "high", - "o": "opening_price", - } - ) - response_dict: KrakenResponse = ticker_df.transpose().to_dict() - return response_dict - - async def _async_refresh_tradable_asset_pairs(self) -> None: - self.tradable_asset_pairs = await self._hass.async_add_executor_job( - get_tradable_asset_pairs, self._api - ) - - async def async_setup(self) -> None: - """Set up the Kraken integration.""" - if not self._config_entry.options: - options = { - CONF_SCAN_INTERVAL: DEFAULT_SCAN_INTERVAL, - CONF_TRACKED_ASSET_PAIRS: [DEFAULT_TRACKED_ASSET_PAIR], - } - self._hass.config_entries.async_update_entry( - self._config_entry, options=options - ) - await self._async_refresh_tradable_asset_pairs() - # Wait 1 second to avoid triggering the KrakenAPI CallRateLimiter - await asyncio.sleep(CALL_RATE_LIMIT_SLEEP) - self.coordinator = DataUpdateCoordinator( - self._hass, - _LOGGER, - name=DOMAIN, - config_entry=self._config_entry, - update_method=self.async_update, - update_interval=timedelta( - seconds=self._config_entry.options[CONF_SCAN_INTERVAL] - ), - ) - await self.coordinator.async_config_entry_first_refresh() - # Wait 1 second to avoid triggering the KrakenAPI CallRateLimiter - await asyncio.sleep(CALL_RATE_LIMIT_SLEEP) - - def _get_websocket_name_asset_pairs(self) -> str: - return ",".join( - pair - for tracked_pair in self._config_entry.options[CONF_TRACKED_ASSET_PAIRS] - if (pair := self.tradable_asset_pairs.get(tracked_pair)) is not None - ) - - def set_update_interval(self, update_interval: int) -> None: - """Set the coordinator update_interval to the supplied update_interval.""" - if self.coordinator is not None: - self.coordinator.update_interval = timedelta(seconds=update_interval) - - async def async_options_updated(hass: HomeAssistant, config_entry: ConfigEntry) -> None: """Triggered by config entry options updates.""" hass.data[DOMAIN].set_update_interval(config_entry.options[CONF_SCAN_INTERVAL]) diff --git a/homeassistant/components/kraken/coordinator.py b/homeassistant/components/kraken/coordinator.py new file mode 100644 index 00000000000..c222e58ba15 --- /dev/null +++ b/homeassistant/components/kraken/coordinator.py @@ -0,0 +1,133 @@ +"""Coordinator for the kraken integration.""" + +from __future__ import annotations + +import asyncio +from datetime import timedelta +import logging + +import krakenex +import pykrakenapi + +from homeassistant.config_entries import ConfigEntry +from homeassistant.const import CONF_SCAN_INTERVAL +from homeassistant.core import HomeAssistant +from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed + +from .const import ( + CONF_TRACKED_ASSET_PAIRS, + DEFAULT_SCAN_INTERVAL, + DEFAULT_TRACKED_ASSET_PAIR, + DOMAIN, + KrakenResponse, +) +from .utils import get_tradable_asset_pairs + +CALL_RATE_LIMIT_SLEEP = 1 + +_LOGGER = logging.getLogger(__name__) + + +class KrakenData: + """Define an object to hold kraken data.""" + + def __init__(self, hass: HomeAssistant, config_entry: ConfigEntry) -> None: + """Initialize.""" + self._hass = hass + self._config_entry = config_entry + self._api = pykrakenapi.KrakenAPI(krakenex.API(), retry=0, crl_sleep=0) + self.tradable_asset_pairs: dict[str, str] = {} + self.coordinator: DataUpdateCoordinator[KrakenResponse | None] | None = None + + async def async_update(self) -> KrakenResponse | None: + """Get the latest data from the Kraken.com REST API. + + All tradeable asset pairs are retrieved, not the tracked asset pairs + selected by the user. This enables us to check for an unknown and + thus likely removed asset pair in sensor.py and only log a warning + once. + """ + try: + async with asyncio.timeout(10): + return await self._hass.async_add_executor_job(self._get_kraken_data) + except pykrakenapi.pykrakenapi.KrakenAPIError as error: + if "Unknown asset pair" in str(error): + _LOGGER.warning( + "Kraken.com reported an unknown asset pair. Refreshing list of" + " tradable asset pairs" + ) + await self._async_refresh_tradable_asset_pairs() + else: + raise UpdateFailed( + f"Unable to fetch data from Kraken.com: {error}" + ) from error + except pykrakenapi.pykrakenapi.CallRateLimitError: + _LOGGER.warning( + "Exceeded the Kraken.com call rate limit. Increase the update interval" + " to prevent this error" + ) + return None + + def _get_kraken_data(self) -> KrakenResponse: + websocket_name_pairs = self._get_websocket_name_asset_pairs() + ticker_df = self._api.get_ticker_information(websocket_name_pairs) + # Rename columns to their full name + ticker_df = ticker_df.rename( + columns={ + "a": "ask", + "b": "bid", + "c": "last_trade_closed", + "v": "volume", + "p": "volume_weighted_average", + "t": "number_of_trades", + "l": "low", + "h": "high", + "o": "opening_price", + } + ) + response_dict: KrakenResponse = ticker_df.transpose().to_dict() + return response_dict + + async def _async_refresh_tradable_asset_pairs(self) -> None: + self.tradable_asset_pairs = await self._hass.async_add_executor_job( + get_tradable_asset_pairs, self._api + ) + + async def async_setup(self) -> None: + """Set up the Kraken integration.""" + if not self._config_entry.options: + options = { + CONF_SCAN_INTERVAL: DEFAULT_SCAN_INTERVAL, + CONF_TRACKED_ASSET_PAIRS: [DEFAULT_TRACKED_ASSET_PAIR], + } + self._hass.config_entries.async_update_entry( + self._config_entry, options=options + ) + await self._async_refresh_tradable_asset_pairs() + # Wait 1 second to avoid triggering the KrakenAPI CallRateLimiter + await asyncio.sleep(CALL_RATE_LIMIT_SLEEP) + self.coordinator = DataUpdateCoordinator( + self._hass, + _LOGGER, + name=DOMAIN, + config_entry=self._config_entry, + update_method=self.async_update, + update_interval=timedelta( + seconds=self._config_entry.options[CONF_SCAN_INTERVAL] + ), + ) + await self.coordinator.async_config_entry_first_refresh() + # Wait 1 second to avoid triggering the KrakenAPI CallRateLimiter + await asyncio.sleep(CALL_RATE_LIMIT_SLEEP) + + def _get_websocket_name_asset_pairs(self) -> str: + return ",".join( + pair + for tracked_pair in self._config_entry.options[CONF_TRACKED_ASSET_PAIRS] + if (pair := self.tradable_asset_pairs.get(tracked_pair)) is not None + ) + + def set_update_interval(self, update_interval: int) -> None: + """Set the coordinator update_interval to the supplied update_interval.""" + if self.coordinator is not None: + self.coordinator.update_interval = timedelta(seconds=update_interval) diff --git a/homeassistant/components/kraken/sensor.py b/homeassistant/components/kraken/sensor.py index 8d5f9ab65af..f301a54ee07 100644 --- a/homeassistant/components/kraken/sensor.py +++ b/homeassistant/components/kraken/sensor.py @@ -22,13 +22,13 @@ from homeassistant.helpers.update_coordinator import ( DataUpdateCoordinator, ) -from . import KrakenData from .const import ( CONF_TRACKED_ASSET_PAIRS, DISPATCH_CONFIG_UPDATED, DOMAIN, KrakenResponse, ) +from .coordinator import KrakenData _LOGGER = logging.getLogger(__name__) diff --git a/tests/components/kraken/conftest.py b/tests/components/kraken/conftest.py index e75122e7f0e..a6eb1ebd679 100644 --- a/tests/components/kraken/conftest.py +++ b/tests/components/kraken/conftest.py @@ -8,5 +8,7 @@ import pytest @pytest.fixture(autouse=True) def mock_call_rate_limit_sleep(): """Patch the call rate limit sleep time.""" - with patch("homeassistant.components.kraken.CALL_RATE_LIMIT_SLEEP", new=0): + with patch( + "homeassistant.components.kraken.coordinator.CALL_RATE_LIMIT_SLEEP", new=0 + ): yield