mirror of
https://github.com/home-assistant/core.git
synced 2025-07-21 12:17:07 +00:00
Move meteoclimatic coordinator to separate module (#148018)
This commit is contained in:
parent
b1e3561ead
commit
7d36a2e3a7
@ -1,43 +1,15 @@
|
|||||||
"""Support for Meteoclimatic weather data."""
|
"""Support for Meteoclimatic weather data."""
|
||||||
|
|
||||||
import logging
|
|
||||||
|
|
||||||
from meteoclimatic import MeteoclimaticClient
|
|
||||||
from meteoclimatic.exceptions import MeteoclimaticError
|
|
||||||
|
|
||||||
from homeassistant.config_entries import ConfigEntry
|
from homeassistant.config_entries import ConfigEntry
|
||||||
from homeassistant.core import HomeAssistant
|
from homeassistant.core import HomeAssistant
|
||||||
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
|
|
||||||
|
|
||||||
from .const import CONF_STATION_CODE, DOMAIN, PLATFORMS, SCAN_INTERVAL
|
from .const import DOMAIN, PLATFORMS
|
||||||
|
from .coordinator import MeteoclimaticUpdateCoordinator
|
||||||
_LOGGER = logging.getLogger(__name__)
|
|
||||||
|
|
||||||
|
|
||||||
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
||||||
"""Set up a Meteoclimatic entry."""
|
"""Set up a Meteoclimatic entry."""
|
||||||
station_code = entry.data[CONF_STATION_CODE]
|
coordinator = MeteoclimaticUpdateCoordinator(hass, entry)
|
||||||
meteoclimatic_client = MeteoclimaticClient()
|
|
||||||
|
|
||||||
async def async_update_data():
|
|
||||||
"""Obtain the latest data from Meteoclimatic."""
|
|
||||||
try:
|
|
||||||
data = await hass.async_add_executor_job(
|
|
||||||
meteoclimatic_client.weather_at_station, station_code
|
|
||||||
)
|
|
||||||
except MeteoclimaticError as err:
|
|
||||||
raise UpdateFailed(f"Error while retrieving data: {err}") from err
|
|
||||||
return data.__dict__
|
|
||||||
|
|
||||||
coordinator = DataUpdateCoordinator(
|
|
||||||
hass,
|
|
||||||
_LOGGER,
|
|
||||||
config_entry=entry,
|
|
||||||
name=f"Meteoclimatic weather for {entry.title} ({station_code})",
|
|
||||||
update_method=async_update_data,
|
|
||||||
update_interval=SCAN_INTERVAL,
|
|
||||||
)
|
|
||||||
|
|
||||||
await coordinator.async_config_entry_first_refresh()
|
await coordinator.async_config_entry_first_refresh()
|
||||||
|
|
||||||
hass.data.setdefault(DOMAIN, {})
|
hass.data.setdefault(DOMAIN, {})
|
||||||
|
43
homeassistant/components/meteoclimatic/coordinator.py
Normal file
43
homeassistant/components/meteoclimatic/coordinator.py
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
"""Support for Meteoclimatic weather data."""
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
from meteoclimatic import MeteoclimaticClient
|
||||||
|
from meteoclimatic.exceptions import MeteoclimaticError
|
||||||
|
|
||||||
|
from homeassistant.config_entries import ConfigEntry
|
||||||
|
from homeassistant.core import HomeAssistant
|
||||||
|
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
|
||||||
|
|
||||||
|
from .const import CONF_STATION_CODE, SCAN_INTERVAL
|
||||||
|
|
||||||
|
_LOGGER = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
class MeteoclimaticUpdateCoordinator(DataUpdateCoordinator[dict[str, Any]]):
|
||||||
|
"""Coordinator for Meteoclimatic weather data."""
|
||||||
|
|
||||||
|
config_entry: ConfigEntry
|
||||||
|
|
||||||
|
def __init__(self, hass: HomeAssistant, entry: ConfigEntry) -> None:
|
||||||
|
"""Initialize the coordinator."""
|
||||||
|
self._station_code = entry.data[CONF_STATION_CODE]
|
||||||
|
super().__init__(
|
||||||
|
hass,
|
||||||
|
_LOGGER,
|
||||||
|
config_entry=entry,
|
||||||
|
name=f"Meteoclimatic weather for {entry.title} ({self._station_code})",
|
||||||
|
update_interval=SCAN_INTERVAL,
|
||||||
|
)
|
||||||
|
self._meteoclimatic_client = MeteoclimaticClient()
|
||||||
|
|
||||||
|
async def _async_update_data(self) -> dict[str, Any]:
|
||||||
|
"""Obtain the latest data from Meteoclimatic."""
|
||||||
|
try:
|
||||||
|
data = await self.hass.async_add_executor_job(
|
||||||
|
self._meteoclimatic_client.weather_at_station, self._station_code
|
||||||
|
)
|
||||||
|
except MeteoclimaticError as err:
|
||||||
|
raise UpdateFailed(f"Error while retrieving data: {err}") from err
|
||||||
|
return data.__dict__
|
@ -18,12 +18,10 @@ from homeassistant.const import (
|
|||||||
from homeassistant.core import HomeAssistant
|
from homeassistant.core import HomeAssistant
|
||||||
from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
|
from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
|
||||||
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
|
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
|
||||||
from homeassistant.helpers.update_coordinator import (
|
from homeassistant.helpers.update_coordinator import CoordinatorEntity
|
||||||
CoordinatorEntity,
|
|
||||||
DataUpdateCoordinator,
|
|
||||||
)
|
|
||||||
|
|
||||||
from .const import ATTRIBUTION, DOMAIN, MANUFACTURER, MODEL
|
from .const import ATTRIBUTION, DOMAIN, MANUFACTURER, MODEL
|
||||||
|
from .coordinator import MeteoclimaticUpdateCoordinator
|
||||||
|
|
||||||
SENSOR_TYPES: tuple[SensorEntityDescription, ...] = (
|
SENSOR_TYPES: tuple[SensorEntityDescription, ...] = (
|
||||||
SensorEntityDescription(
|
SensorEntityDescription(
|
||||||
@ -119,7 +117,7 @@ async def async_setup_entry(
|
|||||||
async_add_entities: AddConfigEntryEntitiesCallback,
|
async_add_entities: AddConfigEntryEntitiesCallback,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Set up the Meteoclimatic sensor platform."""
|
"""Set up the Meteoclimatic sensor platform."""
|
||||||
coordinator = hass.data[DOMAIN][entry.entry_id]
|
coordinator: MeteoclimaticUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
|
||||||
|
|
||||||
async_add_entities(
|
async_add_entities(
|
||||||
[MeteoclimaticSensor(coordinator, description) for description in SENSOR_TYPES],
|
[MeteoclimaticSensor(coordinator, description) for description in SENSOR_TYPES],
|
||||||
@ -127,13 +125,17 @@ async def async_setup_entry(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
class MeteoclimaticSensor(CoordinatorEntity, SensorEntity):
|
class MeteoclimaticSensor(
|
||||||
|
CoordinatorEntity[MeteoclimaticUpdateCoordinator], SensorEntity
|
||||||
|
):
|
||||||
"""Representation of a Meteoclimatic sensor."""
|
"""Representation of a Meteoclimatic sensor."""
|
||||||
|
|
||||||
_attr_attribution = ATTRIBUTION
|
_attr_attribution = ATTRIBUTION
|
||||||
|
|
||||||
def __init__(
|
def __init__(
|
||||||
self, coordinator: DataUpdateCoordinator, description: SensorEntityDescription
|
self,
|
||||||
|
coordinator: MeteoclimaticUpdateCoordinator,
|
||||||
|
description: SensorEntityDescription,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Initialize the Meteoclimatic sensor."""
|
"""Initialize the Meteoclimatic sensor."""
|
||||||
super().__init__(coordinator)
|
super().__init__(coordinator)
|
||||||
|
@ -8,12 +8,10 @@ from homeassistant.const import UnitOfPressure, UnitOfSpeed, UnitOfTemperature
|
|||||||
from homeassistant.core import HomeAssistant
|
from homeassistant.core import HomeAssistant
|
||||||
from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
|
from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
|
||||||
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
|
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
|
||||||
from homeassistant.helpers.update_coordinator import (
|
from homeassistant.helpers.update_coordinator import CoordinatorEntity
|
||||||
CoordinatorEntity,
|
|
||||||
DataUpdateCoordinator,
|
|
||||||
)
|
|
||||||
|
|
||||||
from .const import ATTRIBUTION, CONDITION_MAP, DOMAIN, MANUFACTURER, MODEL
|
from .const import ATTRIBUTION, CONDITION_MAP, DOMAIN, MANUFACTURER, MODEL
|
||||||
|
from .coordinator import MeteoclimaticUpdateCoordinator
|
||||||
|
|
||||||
|
|
||||||
def format_condition(condition):
|
def format_condition(condition):
|
||||||
@ -31,12 +29,14 @@ async def async_setup_entry(
|
|||||||
async_add_entities: AddConfigEntryEntitiesCallback,
|
async_add_entities: AddConfigEntryEntitiesCallback,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Set up the Meteoclimatic weather platform."""
|
"""Set up the Meteoclimatic weather platform."""
|
||||||
coordinator = hass.data[DOMAIN][entry.entry_id]
|
coordinator: MeteoclimaticUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
|
||||||
|
|
||||||
async_add_entities([MeteoclimaticWeather(coordinator)], False)
|
async_add_entities([MeteoclimaticWeather(coordinator)], False)
|
||||||
|
|
||||||
|
|
||||||
class MeteoclimaticWeather(CoordinatorEntity, WeatherEntity):
|
class MeteoclimaticWeather(
|
||||||
|
CoordinatorEntity[MeteoclimaticUpdateCoordinator], WeatherEntity
|
||||||
|
):
|
||||||
"""Representation of a weather condition."""
|
"""Representation of a weather condition."""
|
||||||
|
|
||||||
_attr_attribution = ATTRIBUTION
|
_attr_attribution = ATTRIBUTION
|
||||||
@ -44,7 +44,7 @@ class MeteoclimaticWeather(CoordinatorEntity, WeatherEntity):
|
|||||||
_attr_native_temperature_unit = UnitOfTemperature.CELSIUS
|
_attr_native_temperature_unit = UnitOfTemperature.CELSIUS
|
||||||
_attr_native_wind_speed_unit = UnitOfSpeed.KILOMETERS_PER_HOUR
|
_attr_native_wind_speed_unit = UnitOfSpeed.KILOMETERS_PER_HOUR
|
||||||
|
|
||||||
def __init__(self, coordinator: DataUpdateCoordinator) -> None:
|
def __init__(self, coordinator: MeteoclimaticUpdateCoordinator) -> None:
|
||||||
"""Initialise the weather platform."""
|
"""Initialise the weather platform."""
|
||||||
super().__init__(coordinator)
|
super().__init__(coordinator)
|
||||||
self._unique_id = self.coordinator.data["station"].code
|
self._unique_id = self.coordinator.data["station"].code
|
||||||
|
@ -8,7 +8,9 @@ import pytest
|
|||||||
@pytest.fixture(autouse=True)
|
@pytest.fixture(autouse=True)
|
||||||
def patch_requests():
|
def patch_requests():
|
||||||
"""Stub out services that makes requests."""
|
"""Stub out services that makes requests."""
|
||||||
patch_client = patch("homeassistant.components.meteoclimatic.MeteoclimaticClient")
|
patch_client = patch(
|
||||||
|
"homeassistant.components.meteoclimatic.coordinator.MeteoclimaticClient"
|
||||||
|
)
|
||||||
|
|
||||||
with patch_client:
|
with patch_client:
|
||||||
yield
|
yield
|
||||||
|
Loading…
x
Reference in New Issue
Block a user