Merge pull request #750 from plugwise/impl-126896

Downstreaming Core PR #126896

Author: bouwew

CHANGELOG.md

@@ -2,8 +2,10 @@
 
 ## Versions from 0.40 and up
 
-## Ongoing
+## v0.54.1
 
+- Fix typing error
+- Downstream Core PR #126896
 - Optimize test code, improve docstrings and add comments
 
 ## v0.54.0

custom_components/plugwise/climate.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Any
+from typing import Any, cast
 
 from homeassistant.components.climate import (
     ATTR_HVAC_MODE,
@@ -238,7 +238,7 @@ def hvac_action(self) -> HVACAction:  # pw-beta add to Core
 
         # Adam provides the hvac_action for each thermostat
         if (control_state := self.device.get(CONTROL_STATE)) in (HVACAction.COOLING, HVACAction.HEATING, HVACAction.PREHEATING):
-            return control_state
+            return cast(HVACAction, control_state)
         if control_state == HVACMode.OFF:
             return HVACAction.IDLE
 

custom_components/plugwise/config_flow.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Any
+from typing import Any, Self
 
 from plugwise import Smile
 from plugwise.exceptions import (
@@ -46,16 +46,13 @@
     ANNA_WITH_ADAM,
     CONF_HOMEKIT_EMULATION,  # pw-beta option
     CONF_REFRESH_INTERVAL,  # pw-beta option
-    CONTEXT,
     DEFAULT_PORT,
     DEFAULT_SCAN_INTERVAL,  # pw-beta option
     DEFAULT_USERNAME,
     DOMAIN,
-    FLOW_ID,
     FLOW_SMILE,
     FLOW_STRETCH,
     INIT,
-    PRODUCT,
     SMILE,
     SMILE_OPEN_THERM,
     SMILE_THERMO,
@@ -130,6 +127,7 @@ class PlugwiseConfigFlow(ConfigFlow, domain=DOMAIN):
     MINOR_VERSION = 1
 
     discovery_info: ZeroconfServiceInfo | None = None
+    product: str = "Unknown Smile"
     _username: str = DEFAULT_USERNAME
 
     async def async_step_zeroconf(
@@ -138,8 +136,8 @@ async def async_step_zeroconf(
         """Prepare configuration for a discovered Plugwise Smile."""
         self.discovery_info = discovery_info
         _properties = discovery_info.properties
-        _product = _properties.get(PRODUCT, "Unknown Smile")
         _version = _properties.get(VERSION, "n/a")
+        self.product = _product = _properties.get("product", "Unknown Smile")
         unique_id = discovery_info.hostname.split(".")[0].split("-")[0]
         if DEFAULT_USERNAME not in unique_id:
             self._username = STRETCH_USERNAME
@@ -173,36 +171,32 @@ async def async_step_zeroconf(
         # If we have discovered an Adam or Anna, both might be on the network.
         # In that case, we need to cancel the Anna flow, as the Adam should
         # be added.
-        for flow in self._async_in_progress():
-            # This is an Anna, and there is already an Adam flow in progress
-            if (
-                _product == SMILE_THERMO
-                and CONTEXT in flow
-                and flow[CONTEXT].get(PRODUCT) == SMILE_OPEN_THERM
-            ):
-                return self.async_abort(reason=ANNA_WITH_ADAM)
-
-            # This is an Adam, and there is already an Anna flow in progress
-            if (
-                _product == SMILE_OPEN_THERM
-                and CONTEXT in flow
-                and flow[CONTEXT].get(PRODUCT) == SMILE_THERMO
-                and FLOW_ID in flow
-            ):
-                self.hass.config_entries.flow.async_abort(flow[FLOW_ID])
+        if self.hass.config_entries.flow.async_has_matching_flow(self):
+            return self.async_abort(reason="anna_with_adam")
 
         _name = f"{ZEROCONF_MAP.get(_product, _product)} v{_version}"
         self.context.update(
             {
                 TITLE_PLACEHOLDERS: {CONF_NAME: _name},
                 ATTR_CONFIGURATION_URL: (
                     f"http://{discovery_info.host}:{discovery_info.port}"
-                ),
-                PRODUCT: _product,
+                )
             }
         )
         return await self.async_step_user()
 
+    def is_matching(self, other_flow: Self) -> bool:
+        """Return True if other_flow is matching this flow."""
+        # This is an Anna, and there is already an Adam flow in progress
+        if self.product == SMILE_THERMO and other_flow.product == SMILE_OPEN_THERM:
+            return True
+
+        # This is an Adam, and there is already an Anna flow in progress
+        if self.product == SMILE_OPEN_THERM and other_flow.product == SMILE_THERMO:
+            self.hass.config_entries.flow.async_abort(other_flow.flow_id)
+
+        return False
+
     async def async_step_user(
         self, user_input: dict[str, Any] | None = None
     ) -> ConfigFlowResult:

custom_components/plugwise/manifest.json

@@ -8,6 +8,6 @@
   "iot_class": "local_polling",
   "loggers": ["plugwise"],
   "requirements": ["plugwise==1.5.0"],
-  "version": "0.54.0",
+  "version": "0.54.1",
   "zeroconf": ["_plugwise._tcp.local."]
 }

hacs.json

@@ -9,6 +9,6 @@
     "sensor",
     "switch"
   ],
-  "homeassistant": "2024.8.0",
+  "homeassistant": "2024.11.0",
   "render_readme": true
 }

tests/components/plugwise/test_config_flow.py

@@ -254,9 +254,9 @@ async def test_zeroconf_abort_anna_with_adam(hass: HomeAssistant) -> None:
     assert result.get("type") == FlowResultType.FORM
     assert result.get("step_id") == "user"
 
-    flows_in_progress = hass.config_entries.flow.async_progress()
+    flows_in_progress = hass.config_entries.flow._handler_progress_index[DOMAIN]
     assert len(flows_in_progress) == 1
-    assert flows_in_progress[0]["context"]["product"] == "smile_thermo"
+    assert list(flows_in_progress)[0].product == "smile_thermo"
 
     # Discover Adam, Anna should be aborted and no longer present
     result2 = await hass.config_entries.flow.async_init(
@@ -268,9 +268,9 @@ async def test_zeroconf_abort_anna_with_adam(hass: HomeAssistant) -> None:
     assert result2.get("type") == FlowResultType.FORM
     assert result2.get("step_id") == "user"
 
-    flows_in_progress = hass.config_entries.flow.async_progress()
+    flows_in_progress = hass.config_entries.flow._handler_progress_index[DOMAIN]
     assert len(flows_in_progress) == 1
-    assert flows_in_progress[0]["context"]["product"] == "smile_open_therm"
+    assert list(flows_in_progress)[0].product == "smile_open_therm"
 
     # Discover Anna again, Anna should be aborted directly
     result3 = await hass.config_entries.flow.async_init(
@@ -282,9 +282,9 @@ async def test_zeroconf_abort_anna_with_adam(hass: HomeAssistant) -> None:
     assert result3.get("reason") == "anna_with_adam"
 
     # Adam should still be there
-    flows_in_progress = hass.config_entries.flow.async_progress()
+    flows_in_progress = hass.config_entries.flow._handler_progress_index[DOMAIN]
     assert len(flows_in_progress) == 1
-    assert flows_in_progress[0]["context"]["product"] == "smile_open_therm"
+    assert list(flows_in_progress)[0].product == "smile_open_therm"
 
 
 async def test_zercoconf_discovery_update_configuration(

tests/ruff.toml

@@ -0,0 +1,11 @@
+# This extend our general Ruff rules specifically for tests
+extend = "../pyproject.toml"
+
+[lint]
+
+extend-ignore = [
+    "B904", # Use raise from to specify exception cause
+    "N815", # Variable {name} in class scope should not be mixedCase
+    "RUF018", # Avoid assignment expressions in assert statements
+    "SLF001", # Private member accessed: Tests do often test internals a lot
+]