Quality: improve typing via plugwise v0.31.3

.github/workflows/test.yml

@@ -4,7 +4,7 @@
 name: Test with HA-core
 
 env:
-  CACHE_VERSION: 1
+  CACHE_VERSION: 2
   DEFAULT_PYTHON: "3.11"
 
 on:
@@ -44,18 +44,21 @@ jobs:
             ${{ env.CACHE_VERSION}}-${{ runner.os }}-base-hacore
             ${{ env.CACHE_VERSION}}-${{ runner.os }}
             ${{ env.CACHE_VERSION}}
-      - name: Create HA-core Python virtual environment
+      - name: Test through core (full, not split)
         run: |
-          scripts/core-testing.sh core_prep
-      - name: Prepare HA-core Python virtual environment
-        run: |
-          scripts/core-testing.sh pip_prep
-      - name: Test
-        run: |
-          scripts/core-testing.sh testing
-      - name: Quality
-        run: |
-          scripts/core-testing.sh quality
+          GITHUB_ACTIONS="" scripts/core-testing.sh
+  #      - name: Create HA-core Python virtual environment
+  #        run: |
+  #          scripts/core-testing.sh core_prep
+  #      - name: Prepare HA-core Python virtual environment
+  #        run: |
+  #          scripts/core-testing.sh pip_prep
+  #      - name: Test
+  #        run: |
+  #          scripts/core-testing.sh testing
+  #      - name: Quality
+  #        run: |
+  #          scripts/core-testing.sh quality
 
   shellcheck:
     name: Shellcheck

CHANGELOG.md

@@ -2,9 +2,11 @@
 
 ## Versions from 0.40 and up
 
-### Ongoing / Unreleased
+### 0.40.2
 
 - CI improvements
+- Implement strict typing, also via [plugwise v0.31.3](https://github.com/plugwise/python-plugwise/releases/tag/v0.31.3)
+- Dynamic generated fixtures re-introduced
 
 ### 0.40.1
 

custom_components/plugwise/__init__.py

@@ -8,7 +8,7 @@
 from homeassistant.components.switch import DOMAIN as SWITCH_DOMAIN
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import Platform
-from homeassistant.core import HomeAssistant, callback
+from homeassistant.core import HomeAssistant, ServiceCall, callback
 from homeassistant.helpers import device_registry as dr, entity_registry as er
 from plugwise.exceptions import PlugwiseError
 
@@ -60,15 +60,16 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     )
 
     async def delete_notification(
-        self,
-    ):  # pragma: no cover  # pw-beta: HA service - delete_notification
+        call: ServiceCall,
+    ) -> None:  # pragma: no cover  # pw-beta: HA service - delete_notification
         """Service: delete the Plugwise Notification."""
         LOGGER.debug(
-            "Service delete PW Notification called for %s", coordinator.api.smile_name
+            "Service delete PW Notification called for %s",
+            coordinator.api.smile_name,
         )
         try:
-            deleted = await coordinator.api.delete_notification()
-            LOGGER.debug("PW Notification deleted: %s", deleted)
+            await coordinator.api.delete_notification()
+            LOGGER.debug("PW Notification deleted")
         except PlugwiseError:
             LOGGER.debug(
                 "Failed to delete the Plugwise Notification for %s",
@@ -88,12 +89,12 @@ async def delete_notification(
 
 async def _update_listener(
     hass: HomeAssistant, entry: ConfigEntry
-):  # pragma: no cover  # pw-beta
+) -> None:  # pragma: no cover  # pw-beta
     """Handle options update."""
     await hass.config_entries.async_reload(entry.entry_id)
 
 
-async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry):
+async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     """Unload a config entry."""
     if unload_ok := await hass.config_entries.async_unload_platforms(
         entry, PLATFORMS_GATEWAY

custom_components/plugwise/binary_sensor.py

@@ -30,13 +30,11 @@ async def async_setup_entry(
 
     entities: list[PlugwiseBinarySensorEntity] = []
     for device_id, device in coordinator.data.devices.items():
+        if "binary_sensors" not in device:
+            continue
         for description in PW_BINARY_SENSOR_TYPES:
-            if (
-                "binary_sensors" not in device
-                or description.key not in device["binary_sensors"]
-            ):
+            if description.key not in device["binary_sensors"]:
                 continue
-
             entities.append(
                 PlugwiseBinarySensorEntity(
                     coordinator,
@@ -45,6 +43,7 @@ async def async_setup_entry(
                 )
             )
             LOGGER.debug("Add %s binary sensor", description.key)
+
     async_add_entities(entities)
 
 
@@ -66,17 +65,17 @@ def __init__(
         self._notification: dict[str, str] = {}  # pw-beta
 
     @property
-    def is_on(self) -> bool | None:
+    def is_on(self) -> bool:
         """Return true if the binary sensor is on."""
-        if (
-            self._notification
-        ):  # pw-beta: show Plugwise notifications as HA persistent notifications
+        # pw-beta: show Plugwise notifications as HA persistent notifications
+        if self._notification:
             for notify_id, message in self._notification.items():
                 self.hass.components.persistent_notification.async_create(
                     message, "Plugwise Notification:", f"{DOMAIN}.{notify_id}"
                 )
 
-        return self.device["binary_sensors"].get(self.entity_description.key)
+        # return self.device["binary_sensors"][self.entity_description.key]  # type: ignore [literal-required]
+        return self.entity_description.value_fn(self.device)
 
     @property
     def icon(self) -> str | None:

custom_components/plugwise/climate.py

@@ -95,9 +95,9 @@ def __init__(
 
         self._attr_min_temp = self.device["thermostat"]["lower_bound"]
         self._attr_max_temp = self.device["thermostat"]["upper_bound"]
-        # Ensure we don't drop below 0.1
+        # Fix unpractical resolution provided by Plugwise
         self._attr_target_temperature_step = max(
-            self.device["thermostat"]["resolution"], 0.1
+            self.device["thermostat"]["resolution"], 0.5
         )
 
     @property
@@ -156,13 +156,13 @@ def hvac_action(self) -> HVACAction:  # pw-beta add to Core
         if control_state == "off":
             return HVACAction.IDLE
 
-        hc_data = self.coordinator.data.devices[
-            self.coordinator.data.gateway["heater_id"]
-        ]
-        if hc_data["binary_sensors"]["heating_state"]:
-            return HVACAction.HEATING
-        if hc_data["binary_sensors"].get("cooling_state", False):  # pw-beta adds False
-            return HVACAction.COOLING
+        heater: str | None = self.coordinator.data.gateway["heater_id"]
+        if heater is not None:
+            heater_data = self.coordinator.data.devices[heater]
+            if heater_data["binary_sensors"]["heating_state"]:
+                return HVACAction.HEATING
+            if heater_data["binary_sensors"].get("cooling_state", False):
+                return HVACAction.COOLING
 
         return HVACAction.IDLE
 

custom_components/plugwise/coordinator.py

@@ -1,6 +1,5 @@
 """DataUpdateCoordinator for Plugwise."""
 from datetime import timedelta
-from typing import NamedTuple, cast
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_PORT, CONF_USERNAME
@@ -10,8 +9,7 @@
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
 from homeassistant.helpers.debounce import Debouncer
 from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
-from plugwise import Smile
-from plugwise.constants import DeviceData, GatewayData
+from plugwise import PlugwiseData, Smile
 from plugwise.exceptions import (
     ConnectionFailedError,
     InvalidAuthentication,
@@ -23,28 +21,25 @@
 from .const import DEFAULT_PORT, DEFAULT_SCAN_INTERVAL, DEFAULT_USERNAME, DOMAIN, LOGGER
 
 
-class PlugwiseData(NamedTuple):
-    """Plugwise data stored in the DataUpdateCoordinator."""
-
-    gateway: GatewayData
-    devices: dict[str, DeviceData]
-
-
 class PlugwiseDataUpdateCoordinator(DataUpdateCoordinator[PlugwiseData]):
     """Class to manage fetching Plugwise data from single endpoint."""
 
     _connected: bool = False
 
     def __init__(
-        self, hass: HomeAssistant, entry: ConfigEntry, cooldown: float
+        self,
+        hass: HomeAssistant,
+        entry: ConfigEntry,
+        cooldown: float,
+        update_interval: timedelta = timedelta(seconds=60),
     ) -> None:  # pw-beta cooldown
         """Initialize the coordinator."""
         super().__init__(
             hass,
             LOGGER,
             name=DOMAIN,
             # Core directly updates from const's DEFAULT_SCAN_INTERVAL
-            update_interval=timedelta(seconds=60),
+            update_interval=update_interval,
             # Don't refresh immediately, give the device time to process
             # the change in state before we query it.
             request_refresh_debouncer=Debouncer(
@@ -65,12 +60,12 @@ def __init__(
         )
         self._entry = entry
         self._unavailable_logged = False
+        self.update_interval = update_interval
 
     async def _connect(self) -> None:
         """Connect to the Plugwise Smile."""
         self._connected = await self.api.connect()
         self.api.get_all_devices()
-        self.name = self.api.smile_name
 
         self.update_interval = DEFAULT_SCAN_INTERVAL.get(
             self.api.smile_type, timedelta(seconds=60)
@@ -88,9 +83,7 @@ async def _async_update_data(self) -> PlugwiseData:
             if not self._connected:
                 await self._connect()
             data = await self.api.async_update()
-            LOGGER.debug(
-                f"{self.api.smile_name} data: %s", PlugwiseData(data[0], data[1])
-            )
+            LOGGER.debug(f"{self.api.smile_name} data: %s", data)
             if self._unavailable_logged:
                 self._unavailable_logged = False
         except InvalidAuthentication as err:
@@ -112,7 +105,4 @@ async def _async_update_data(self) -> PlugwiseData:
                 self._unavailable_logged = True
                 raise UpdateFailed("Failed to connect") from err
 
-        return PlugwiseData(
-            gateway=cast(GatewayData, data[0]),
-            devices=cast(dict[str, DeviceData], data[1]),
-        )
+        return data

custom_components/plugwise/entity.py

@@ -66,7 +66,7 @@ def available(self) -> bool:
         """Return if entity is available."""
         return (
             self._dev_id in self.coordinator.data.devices
-            and ("available" not in self.device or self.device["available"])
+            and ("available" not in self.device or self.device["available"] is True)
             and super().available
         )
 

custom_components/plugwise/manifest.json

@@ -8,6 +8,6 @@
   "integration_type": "hub",
   "iot_class": "local_polling",
   "loggers": ["plugwise"],
-  "requirements": ["plugwise==0.31.0"],
-  "version": "0.40.1"
+  "requirements": ["plugwise==0.31.3"],
+  "version": "0.40.2"
 }