Move meteoclimatic coordinator to separate module (home-assistant#148018)

Author: epenet

homeassistant/components/meteoclimatic/__init__.py

@@ -1,43 +1,15 @@
 """Support for Meteoclimatic weather data."""
 
-import logging
-
-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, DOMAIN, PLATFORMS, SCAN_INTERVAL
-
-_LOGGER = logging.getLogger(__name__)
+from .const import DOMAIN, PLATFORMS
+from .coordinator import MeteoclimaticUpdateCoordinator
 
 
 async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     """Set up a Meteoclimatic entry."""
-    station_code = entry.data[CONF_STATION_CODE]
-    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,
-    )
-
+    coordinator = MeteoclimaticUpdateCoordinator(hass, entry)
     await coordinator.async_config_entry_first_refresh()
 
     hass.data.setdefault(DOMAIN, {})

homeassistant/components/meteoclimatic/coordinator.py

@@ -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__

homeassistant/components/meteoclimatic/sensor.py

@@ -18,12 +18,10 @@
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
-from homeassistant.helpers.update_coordinator import (
-    CoordinatorEntity,
-    DataUpdateCoordinator,
-)
+from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
 from .const import ATTRIBUTION, DOMAIN, MANUFACTURER, MODEL
+from .coordinator import MeteoclimaticUpdateCoordinator
 
 SENSOR_TYPES: tuple[SensorEntityDescription, ...] = (
     SensorEntityDescription(
@@ -119,21 +117,25 @@ async def async_setup_entry(
     async_add_entities: AddConfigEntryEntitiesCallback,
 ) -> None:
     """Set up the Meteoclimatic sensor platform."""
-    coordinator = hass.data[DOMAIN][entry.entry_id]
+    coordinator: MeteoclimaticUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
 
     async_add_entities(
         [MeteoclimaticSensor(coordinator, description) for description in SENSOR_TYPES],
         False,
     )
 
 
-class MeteoclimaticSensor(CoordinatorEntity, SensorEntity):
+class MeteoclimaticSensor(
+    CoordinatorEntity[MeteoclimaticUpdateCoordinator], SensorEntity
+):
     """Representation of a Meteoclimatic sensor."""
 
     _attr_attribution = ATTRIBUTION
 
     def __init__(
-        self, coordinator: DataUpdateCoordinator, description: SensorEntityDescription
+        self,
+        coordinator: MeteoclimaticUpdateCoordinator,
+        description: SensorEntityDescription,
     ) -> None:
         """Initialize the Meteoclimatic sensor."""
         super().__init__(coordinator)

homeassistant/components/meteoclimatic/weather.py

@@ -8,12 +8,10 @@
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
-from homeassistant.helpers.update_coordinator import (
-    CoordinatorEntity,
-    DataUpdateCoordinator,
-)
+from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
 from .const import ATTRIBUTION, CONDITION_MAP, DOMAIN, MANUFACTURER, MODEL
+from .coordinator import MeteoclimaticUpdateCoordinator
 
 
 def format_condition(condition):
@@ -31,20 +29,22 @@ async def async_setup_entry(
     async_add_entities: AddConfigEntryEntitiesCallback,
 ) -> None:
     """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)
 
 
-class MeteoclimaticWeather(CoordinatorEntity, WeatherEntity):
+class MeteoclimaticWeather(
+    CoordinatorEntity[MeteoclimaticUpdateCoordinator], WeatherEntity
+):
     """Representation of a weather condition."""
 
     _attr_attribution = ATTRIBUTION
     _attr_native_pressure_unit = UnitOfPressure.HPA
     _attr_native_temperature_unit = UnitOfTemperature.CELSIUS
     _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."""
         super().__init__(coordinator)
         self._unique_id = self.coordinator.data["station"].code

tests/components/meteoclimatic/conftest.py

@@ -8,7 +8,9 @@
 @pytest.fixture(autouse=True)
 def patch_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:
         yield