Move pvpc coordinator to separate module (#117559)

This commit is contained in:
epenet 2024-05-16 16:06:50 +02:00 committed by GitHub
parent 6f5e820090
commit d019c25ae4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 63 additions and 54 deletions

View file

@ -1,24 +1,15 @@
"""The pvpc_hourly_pricing integration to collect Spain official electric prices."""
from datetime import timedelta
import logging
from aiopvpc import BadApiTokenAuthError, EsiosApiData, PVPCData
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_API_TOKEN, Platform
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import ConfigEntryAuthFailed
from homeassistant.helpers import config_validation as cv
from homeassistant.helpers.aiohttp_client import async_get_clientsession
import homeassistant.helpers.entity_registry as er
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
from homeassistant.util import dt as dt_util
from .const import ATTR_POWER, ATTR_POWER_P3, ATTR_TARIFF, DOMAIN
from .const import ATTR_POWER, ATTR_POWER_P3, DOMAIN
from .coordinator import ElecPricesDataUpdateCoordinator
from .helpers import get_enabled_sensor_keys
_LOGGER = logging.getLogger(__name__)
PLATFORMS: list[Platform] = [Platform.SENSOR]
CONFIG_SCHEMA = cv.removed(DOMAIN, raise_if_present=False)
@ -58,44 +49,3 @@ async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
if unload_ok:
hass.data[DOMAIN].pop(entry.entry_id)
return unload_ok
class ElecPricesDataUpdateCoordinator(DataUpdateCoordinator[EsiosApiData]): # pylint: disable=hass-enforce-coordinator-module
"""Class to manage fetching Electricity prices data from API."""
def __init__(
self, hass: HomeAssistant, entry: ConfigEntry, sensor_keys: set[str]
) -> None:
"""Initialize."""
self.api = PVPCData(
session=async_get_clientsession(hass),
tariff=entry.data[ATTR_TARIFF],
local_timezone=hass.config.time_zone,
power=entry.data[ATTR_POWER],
power_valley=entry.data[ATTR_POWER_P3],
api_token=entry.data.get(CONF_API_TOKEN),
sensor_keys=tuple(sensor_keys),
)
super().__init__(
hass, _LOGGER, name=DOMAIN, update_interval=timedelta(minutes=30)
)
self._entry = entry
@property
def entry_id(self) -> str:
"""Return entry ID."""
return self._entry.entry_id
async def _async_update_data(self) -> EsiosApiData:
"""Update electricity prices from the ESIOS API."""
try:
api_data = await self.api.async_update_all(self.data, dt_util.utcnow())
except BadApiTokenAuthError as exc:
raise ConfigEntryAuthFailed from exc
if (
not api_data
or not api_data.sensors
or not any(api_data.availability.values())
):
raise UpdateFailed
return api_data

View file

@ -0,0 +1,59 @@
"""The pvpc_hourly_pricing integration to collect Spain official electric prices."""
from datetime import timedelta
import logging
from aiopvpc import BadApiTokenAuthError, EsiosApiData, PVPCData
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_API_TOKEN
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import ConfigEntryAuthFailed
from homeassistant.helpers.aiohttp_client import async_get_clientsession
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
from homeassistant.util import dt as dt_util
from .const import ATTR_POWER, ATTR_POWER_P3, ATTR_TARIFF, DOMAIN
_LOGGER = logging.getLogger(__name__)
class ElecPricesDataUpdateCoordinator(DataUpdateCoordinator[EsiosApiData]):
"""Class to manage fetching Electricity prices data from API."""
def __init__(
self, hass: HomeAssistant, entry: ConfigEntry, sensor_keys: set[str]
) -> None:
"""Initialize."""
self.api = PVPCData(
session=async_get_clientsession(hass),
tariff=entry.data[ATTR_TARIFF],
local_timezone=hass.config.time_zone,
power=entry.data[ATTR_POWER],
power_valley=entry.data[ATTR_POWER_P3],
api_token=entry.data.get(CONF_API_TOKEN),
sensor_keys=tuple(sensor_keys),
)
super().__init__(
hass, _LOGGER, name=DOMAIN, update_interval=timedelta(minutes=30)
)
self._entry = entry
@property
def entry_id(self) -> str:
"""Return entry ID."""
return self._entry.entry_id
async def _async_update_data(self) -> EsiosApiData:
"""Update electricity prices from the ESIOS API."""
try:
api_data = await self.api.async_update_all(self.data, dt_util.utcnow())
except BadApiTokenAuthError as exc:
raise ConfigEntryAuthFailed from exc
if (
not api_data
or not api_data.sensors
or not any(api_data.availability.values())
):
raise UpdateFailed
return api_data

View file

@ -23,8 +23,8 @@ from homeassistant.helpers.event import async_track_time_change
from homeassistant.helpers.typing import StateType
from homeassistant.helpers.update_coordinator import CoordinatorEntity
from . import ElecPricesDataUpdateCoordinator
from .const import DOMAIN
from .coordinator import ElecPricesDataUpdateCoordinator
from .helpers import make_sensor_unique_id
_LOGGER = logging.getLogger(__name__)

View file

@ -4,7 +4,7 @@ from http import HTTPStatus
import pytest
from homeassistant.components.pvpc_hourly_pricing import ATTR_TARIFF, DOMAIN
from homeassistant.components.pvpc_hourly_pricing.const import ATTR_TARIFF, DOMAIN
from homeassistant.const import ATTR_UNIT_OF_MEASUREMENT, CURRENCY_EURO, UnitOfEnergy
from tests.common import load_fixture