Move check_heater_central() function to util.py

Author: bouwew

plugwise/helper.py

@@ -59,6 +59,7 @@
     ResponseError,
 )
 from plugwise.util import (
+    check_heater_central,
     check_model,
     escape_illegal_xml_characters,
     format_measure,
@@ -393,7 +394,7 @@ def _appliance_info_finder(self, appliance: etree, appl: Munch) -> Munch:
                 return None  # pragma: no cover
 
             # Find the valid heater_central
-            self._heater_id = self._check_heater_central()
+            self._heater_id = check_heater_central(self._domain_objects)
 
             #  Info for On-Off device
             if self._on_off_device:
@@ -436,34 +437,6 @@ def _appliance_info_finder(self, appliance: etree, appl: Munch) -> Munch:
 
         return appl
 
-    def _check_heater_central(self) -> str:
-        """Find the valid heater_central, helper-function for _appliance_info_finder().
-
-        Solution for Core Issue #104433,
-        for a system that has two heater_central appliances.
-        """
-        locator = "./appliance[type='heater_central']"
-        hc_count = 0
-        hc_list: list[dict[str, bool]] = []
-        for heater_central in self._domain_objects.findall(locator):
-            hc_count += 1
-            hc_id: str = heater_central.attrib["id"]
-            has_actuators: bool = (
-                heater_central.find("actuator_functionalities/") is not None
-            )
-            hc_list.append({hc_id: has_actuators})
-
-        heater_central_id = list(hc_list[0].keys())[0]
-        if hc_count > 1:
-            for item in hc_list:
-                for key, value in item.items():
-                    if value:
-                        heater_central_id = key
-                        # Stop when a valid id is found
-                        break
-
-        return heater_central_id
-
     def _p1_smartmeter_info_finder(self, appl: Munch) -> None:
         """Collect P1 DSMR Smartmeter info."""
         loc_id = next(iter(self.loc_data.keys()))

plugwise/legacy/helper.py

@@ -46,7 +46,12 @@
     SwitchType,
     ThermoLoc,
 )
-from plugwise.util import format_measure, power_data_local_format, version_to_model
+from plugwise.util import (
+    check_heater_central,
+    format_measure,
+    power_data_local_format,
+    version_to_model,
+)
 
 # This way of importing aiohttp is because of patch/mocking in testing (aiohttp timeouts)
 from defusedxml import ElementTree as etree
@@ -218,7 +223,7 @@ def _appliance_info_finder(self, appliance: etree, appl: Munch) -> Munch:
                 return None
 
             # Find the valid heater_central
-            self._heater_id = self._check_heater_central()
+            self._heater_id = check_heater_central(self._appliances)
 
             #  Info for On-Off device
             if self._on_off_device:
@@ -248,34 +253,6 @@ def _appliance_info_finder(self, appliance: etree, appl: Munch) -> Munch:
 
         return appl
 
-    def _check_heater_central(self) -> str:
-        """Find the valid heater_central, helper-function for _appliance_info_finder().
-
-        Solution for Core Issue #104433,
-        for a system that has two heater_central appliances.
-        """
-        locator = "./appliance[type='heater_central']"
-        hc_count = 0
-        hc_list: list[dict[str, bool]] = []
-        for heater_central in self._appliances.findall(locator):
-            hc_count += 1
-            hc_id: str = heater_central.attrib["id"]
-            has_actuators: bool = (
-                heater_central.find("actuator_functionalities/") is not None
-            )
-            hc_list.append({hc_id: has_actuators})
-
-        heater_central_id = list(hc_list[0].keys())[0]
-        if hc_count > 1:
-            for item in hc_list:  # pragma: no cover
-                for key, value in item.items():  # pragma: no cover
-                    if value:  # pragma: no cover
-                        heater_central_id = key  # pragma: no cover
-                        # Stop when a valid id is found
-                        break  # pragma: no cover
-
-        return heater_central_id
-
     def _p1_smartmeter_info_finder(self, appl: Munch) -> None:
         """Collect P1 DSMR Smartmeter info."""
         loc_id = next(iter(self.loc_data.keys()))

plugwise/util.py

@@ -15,6 +15,37 @@
     DeviceData,
 )
 
+from defusedxml import ElementTree as etree
+
+
+def check_heater_central(xml: etree) -> str:
+    """Find the valid heater_central, helper-function for _appliance_info_finder().
+
+    Solution for Core Issue #104433,
+    for a system that has two heater_central appliances.
+    """
+    locator = "./appliance[type='heater_central']"
+    hc_count = 0
+    hc_list: list[dict[str, bool]] = []
+    for heater_central in xml.findall(locator):
+        hc_count += 1
+        hc_id: str = heater_central.attrib["id"]
+        has_actuators: bool = (
+            heater_central.find("actuator_functionalities/") is not None
+        )
+        hc_list.append({hc_id: has_actuators})
+
+    heater_central_id = list(hc_list[0].keys())[0]
+    if hc_count > 1:
+        for item in hc_list:  # pragma: no cover
+            for key, value in item.items():  # pragma: no cover
+                if value:  # pragma: no cover
+                    heater_central_id = key  # pragma: no cover
+                    # Stop when a valid id is found
+                    break  # pragma: no cover
+
+    return heater_central_id
+
 
 def check_model(name: str | None, vendor_name: str | None) -> str | None:
     """Model checking before using version_to_model."""