Move error-message in raise, clean up

Author: bouwew

plugwise/smile.py

@@ -34,7 +34,7 @@
 from .exceptions import (
     ConnectionFailedError,
     InvalidSetupError,
-    InvalidXMLError,
+    PlugwiseException,
     UnsupportedDeviceError,
 )
 from .helper import SmileComm, SmileHelper, update_helper
@@ -275,21 +275,18 @@ async def connect(self) -> bool:
         dsmrmain = result.find("./module/protocols/dsmrmain")
         if "Plugwise" not in names:
             if dsmrmain is None:  # pragma: no cover
-                LOGGER.error(
-                    "Connected but expected text not returned, \
-                    we got %s. Please create an issue on \
-                    http://github.com/plugwise/python-plugwise",
-                    result,
+                raise ConnectionFailedError(
+                    f"Connected but expected text not returned, \
+                    we got {result}. Please create an issue on \
+                    http://github.com/plugwise/python-plugwise"
                 )
-                raise ConnectionFailedError
 
         # Check if Anna is connected to an Adam
         if "159.2" in models:
-            LOGGER.error(
+            raise InvalidSetupError(
                 "Your Anna is connected to an Adam, make \
-                sure to only add the Adam as integration.",
+                sure to only add the Adam as integration."
             )
-            raise InvalidSetupError
 
         # Determine smile specifics
         await self._smile_detect(result, dsmrmain)
@@ -320,38 +317,31 @@ async def _smile_detect_legacy(self, result: etree, dsmrmain: etree) -> str:
         if result.find('./appliance[type="thermostat"]') is None:
             # It's a P1 legacy:
             if dsmrmain is not None:
-                try:
-                    status = await self._request(STATUS)
-                    self.smile_fw_version = status.find("./system/version").text
-                    model = status.find("./system/product").text
-                    self.smile_hostname = status.find("./network/hostname").text
-                    self.smile_mac_address = status.find("./network/mac_address").text
-                except InvalidXMLError:  # pragma: no cover
-                    # Corner case check
-                    raise ConnectionFailedError
+                status = await self._request(STATUS)
+                self.smile_fw_version = status.find("./system/version").text
+                model = status.find("./system/product").text
+                self.smile_hostname = status.find("./network/hostname").text
+                self.smile_mac_address = status.find("./network/mac_address").text
 
             # Or a legacy Stretch:
             elif network is not None:
-                try:
-                    system = await self._request(SYSTEM)
-                    self.smile_fw_version = system.find("./gateway/firmware").text
-                    model = system.find("./gateway/product").text
-                    self.smile_hostname = system.find("./gateway/hostname").text
-                    # If wlan0 contains data it's active, so eth0 should be checked last
-                    for network in ["wlan0", "eth0"]:
-                        locator = f"./{network}/mac"
-                        if (net_locator := system.find(locator)) is not None:
-                            self.smile_mac_address = net_locator.text
-                except InvalidXMLError:  # pragma: no cover
-                    # Corner case check
-                    raise ConnectionFailedError
+                system = await self._request(SYSTEM)
+                self.smile_fw_version = system.find("./gateway/firmware").text
+                model = system.find("./gateway/product").text
+                self.smile_hostname = system.find("./gateway/hostname").text
+                # If wlan0 contains data it's active, so eth0 should be checked last
+                for network in ["wlan0", "eth0"]:
+                    locator = f"./{network}/mac"
+                    if (net_locator := system.find(locator)) is not None:
+                        self.smile_mac_address = net_locator.text
+
             else:  # pragma: no cover
                 # No cornercase, just end of the line
-                LOGGER.error(
+                raise ConnectionFailedError(
                     "Connected but no gateway device information found, please create \
                      an issue on http://github.com/plugwise/python-plugwise"
                 )
-                raise ConnectionFailedError
+
         return model
 
     async def _smile_detect(self, result: etree, dsmrmain: etree) -> None:
@@ -370,23 +360,20 @@ async def _smile_detect(self, result: etree, dsmrmain: etree) -> None:
 
         if model is None or self.smile_fw_version is None:  # pragma: no cover
             # Corner case check
-            LOGGER.error(
+            raise UnsupportedDeviceError(
                 "Unable to find model or version information, please create \
                  an issue on http://github.com/plugwise/python-plugwise"
             )
-            raise UnsupportedDeviceError
 
         ver = semver.VersionInfo.parse(self.smile_fw_version)
         target_smile = f"{model}_v{ver.major}"
         LOGGER.debug("Plugwise identified as %s", target_smile)
         if target_smile not in SMILES:
-            LOGGER.error(
-                'Your version Smile identified as "%s" seems\
+            raise UnsupportedDeviceError(
+                "Your version Smile identified as {target_smile} seems\
                  unsupported by our plugin, please create an issue\
-                 on http://github.com/plugwise/python-plugwise',
-                target_smile,
+                 on http://github.com/plugwise/python-plugwise"
             )
-            raise UnsupportedDeviceError
 
         self.smile_name = SMILES[target_smile]["friendly_name"]
         self.smile_type = SMILES[target_smile]["type"]
@@ -480,7 +467,7 @@ async def _set_schedule_state_legacy(self, name: str, status: str) -> bool:
                 schedule_rule_id = rule.attrib["id"]
 
         if schedule_rule_id is None:
-            return False
+            raise PlugwiseException("No schedule available.")
 
         state = "false"
         if status == "on":
@@ -497,7 +484,6 @@ async def _set_schedule_state_legacy(self, name: str, status: str) -> bool:
         )
 
         await self._request(uri, method="put", data=data)
-        return True
 
     async def set_schedule_state(self, loc_id: str, name: str, state: str) -> bool:
         """Set the Schedule, with the given name, on the relevant Thermostat.
@@ -508,7 +494,7 @@ async def set_schedule_state(self, loc_id: str, name: str, state: str) -> bool:
 
         schedule_rule = self._rule_ids_by_name(name, loc_id)
         if not schedule_rule or schedule_rule is None:
-            return False
+            raise PlugwiseException("No schedule available.")
 
         schedule_rule_id: str = next(iter(schedule_rule))
 
@@ -543,19 +529,16 @@ async def set_schedule_state(self, loc_id: str, name: str, state: str) -> bool:
         )
         await self._request(uri, method="put", data=data)
 
-        return True
-
     async def _set_preset_legacy(self, preset: str) -> bool:
         """Set the given Preset on the relevant Thermostat - from DOMAIN_OBJECTS."""
         locator = f'rule/directives/when/then[@icon="{preset}"].../.../...'
         if (rule := self._domain_objects.find(locator)) is None:
-            return False
+            raise PlugwiseException("No presets available.")
 
         uri = RULES
         data = f'<rules><rule id="{rule.attrib["id"]}"><active>true</active></rule></rules>'
 
         await self._request(uri, method="put", data=data)
-        return True
 
     async def set_preset(self, loc_id: str, preset: str) -> bool:
         """Set the given Preset on the relevant Thermostat - from LOCATIONS."""
@@ -567,7 +550,7 @@ async def set_preset(self, loc_id: str, preset: str) -> bool:
         location_type = current_location.find("type").text
 
         if preset not in self._presets(loc_id):
-            return False
+            raise PlugwiseException("Preset not available.")
 
         uri = f"{LOCATIONS};id={loc_id}"
         data = (
@@ -577,7 +560,6 @@ async def set_preset(self, loc_id: str, preset: str) -> bool:
         )
 
         await self._request(uri, method="put", data=data)
-        return True
 
     async def set_temperature(self, loc_id: str, temperature: str) -> bool:
         """Set the given Temperature on the relevant Thermostat."""
@@ -588,7 +570,6 @@ async def set_temperature(self, loc_id: str, temperature: str) -> bool:
         )
 
         await self._request(uri, method="put", data=data)
-        return True
 
     async def set_max_boiler_temperature(self, temperature: str) -> bool:
         """Set the max. Boiler Temperature on the Central heating boiler."""
@@ -601,7 +582,6 @@ async def set_max_boiler_temperature(self, temperature: str) -> bool:
         data = f"<thermostat_functionality><setpoint>{temperature}</setpoint></thermostat_functionality>"
 
         await self._request(uri, method="put", data=data)
-        return True
 
     async def _set_groupswitch_member_state(
         self, members: list[str], state: str, switch: Munch
@@ -619,8 +599,6 @@ async def _set_groupswitch_member_state(
 
             await self._request(uri, method="put", data=data)
 
-        return True
-
     async def set_switch_state(
         self, appl_id: str, members: list[str] | None, model: str, state: str
     ) -> bool:
@@ -659,15 +637,14 @@ async def set_switch_state(
             lock_state: str = self._appliances.find(locator).text
             # Don't bother switching a relay when the corresponding lock-state is true
             if lock_state == "true":
-                return False
+                return
 
         await self._request(uri, method="put", data=data)
-        return True
 
     async def set_regulation_mode(self, mode: str) -> bool:
         """Set the heating regulation mode."""
         if mode not in self._allowed_modes:
-            return False
+            raise PlugwiseException("Invalid regulation mode.")
 
         uri = f"{APPLIANCES};type=gateway/regulation_mode_control"
         duration = ""
@@ -676,11 +653,9 @@ async def set_regulation_mode(self, mode: str) -> bool:
         data = f"<regulation_mode_control_functionality>{duration}<mode>{mode}</mode></regulation_mode_control_functionality>"
 
         await self._request(uri, method="put", data=data)
-        return True
 
     async def delete_notification(self) -> bool:
         """Delete the active Plugwise Notification."""
         uri = NOTIFICATIONS
 
         await self._request(uri, method="delete")
-        return True