Merge pull request #637 from plugwise/timeout_cleanup

Clean up timeout-related, pass _request-function as an argument

Author: bouwew

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v1.4.3
+
+- Clean up timeout-related, pass _request-function as an argument.
+
 ## v1.4.2
 
 - Bugfix: implement solution for issue reported in [#739](https://github.com/plugwise/plugwise-beta/issues/739)

plugwise/__init__.py

@@ -6,7 +6,6 @@
 
 from plugwise.constants import (
     DEFAULT_PORT,
-    DEFAULT_TIMEOUT,
     DEFAULT_USERNAME,
     DOMAIN_OBJECTS,
     LOGGER,
@@ -61,7 +60,6 @@ def __init__(
         self._host = host
         self._passwd = password
         self._port = port
-        self._timeout = timeout
         self._user = username
         self._websession = websession
 
@@ -128,7 +126,7 @@ async def connect(self) -> bool:
         self._smile_api = SmileAPI(
             self._host,
             self._passwd,
-            self._timeout,
+            self._request,
             self._websession,
             self._cooling_present,
             self._elga,
@@ -152,7 +150,7 @@ async def connect(self) -> bool:
          ) if not self.smile_legacy else SmileLegacyAPI(
             self._host,
             self._passwd,
-            self._timeout,
+            self._request,
             self._websession,
             self._is_thermostat,
             self._on_off_device,
@@ -194,9 +192,6 @@ async def _smile_detect(self, result: etree, dsmrmain: etree) -> None:
         else:
             model = await self._smile_detect_legacy(result, dsmrmain, model)
 
-        if not self.smile_legacy:
-            self._timeout = DEFAULT_TIMEOUT
-
         if model == "Unknown" or self.smile_fw_version is None:  # pragma: no cover
             # Corner case check
             LOGGER.error(

plugwise/legacy/smile.py

@@ -4,6 +4,7 @@
 """
 from __future__ import annotations
 
+from collections.abc import Awaitable, Callable
 import datetime as dt
 from typing import Any
 
@@ -24,14 +25,13 @@
     ThermoLoc,
 )
 from plugwise.exceptions import ConnectionFailedError, PlugwiseError
-from plugwise.helper import SmileComm
 from plugwise.legacy.data import SmileLegacyData
 
 import aiohttp
 from munch import Munch
 
 
-class SmileLegacyAPI(SmileComm, SmileLegacyData):
+class SmileLegacyAPI(SmileLegacyData):
     """The Plugwise SmileLegacyAPI class."""
 
     # pylint: disable=too-many-instance-attributes, too-many-public-methods
@@ -40,7 +40,7 @@ def __init__(
         self,
         host: str,
         password: str,
-        timeout: int,
+        request: Callable[..., Awaitable[Any]],
         websession: aiohttp.ClientSession,
         _is_thermostat: bool,
         _on_off_device: bool,
@@ -60,14 +60,6 @@ def __init__(
         username: str = DEFAULT_USERNAME,
     ) -> None:
         """Set the constructor for this class."""
-        super().__init__(
-            host,
-            password,
-            port,
-            timeout,
-            username,
-            websession,
-         )
         SmileLegacyData.__init__(self)
 
         self._cooling_present = False
@@ -76,8 +68,8 @@ def __init__(
         self._opentherm_device = _opentherm_device
         self._stretch_v2 = _stretch_v2
         self._target_smile = _target_smile
-        self._timeout = timeout
         self.loc_data = loc_data
+        self.request = request
         self.smile_fw_version = smile_fw_version
         self.smile_hostname = smile_hostname
         self.smile_hw_version = smile_hw_version
@@ -91,12 +83,12 @@ def __init__(
 
     async def full_update_device(self) -> None:
         """Perform a first fetch of all XML data, needed for initialization."""
-        self._domain_objects = await self._request(DOMAIN_OBJECTS)
-        self._locations = await self._request(LOCATIONS)
-        self._modules = await self._request(MODULES)
+        self._domain_objects = await self.request(DOMAIN_OBJECTS)
+        self._locations = await self.request(LOCATIONS)
+        self._modules = await self.request(MODULES)
         # P1 legacy has no appliances
         if self.smile_type != "power":
-            self._appliances = await self._request(APPLIANCES)
+            self._appliances = await self.request(APPLIANCES)
 
     def get_all_devices(self) -> None:
         """Determine the evices present from the obtained XML-data.
@@ -131,12 +123,12 @@ async def async_update(self) -> PlugwiseData:
             self.get_all_devices()
         # Otherwise perform an incremental update
         else:
-            self._domain_objects = await self._request(DOMAIN_OBJECTS)
+            self._domain_objects = await self.request(DOMAIN_OBJECTS)
             match self._target_smile:
                 case "smile_v2":
-                    self._modules = await self._request(MODULES)
+                    self._modules = await self.request(MODULES)
                 case self._target_smile if self._target_smile in REQUIRE_APPLIANCES:
-                    self._appliances = await self._request(APPLIANCES)
+                    self._appliances = await self.request(APPLIANCES)
 
             self._update_gw_devices()
 
@@ -291,10 +283,10 @@ async def set_temperature(self, _: str, items: dict[str, float]) -> None:
         await self.call_request(uri, method="put", data=data)
 
     async def call_request(self, uri: str, **kwargs: Any) -> None:
-        """ConnectionFailedError wrapper for calling _request()."""
+        """ConnectionFailedError wrapper for calling request()."""
         method: str = kwargs["method"]
         data: str | None = kwargs.get("data")
         try:
-            await self._request(uri, method=method, data=data)
+            await self.request(uri, method=method, data=data)
         except ConnectionFailedError as exc:
             raise ConnectionFailedError from exc

plugwise/smile.py

@@ -4,6 +4,7 @@
 """
 from __future__ import annotations
 
+from collections.abc import Awaitable, Callable
 import datetime as dt
 from typing import Any
 
@@ -28,7 +29,6 @@
 )
 from plugwise.data import SmileData
 from plugwise.exceptions import ConnectionFailedError, DataMissingError, PlugwiseError
-from plugwise.helper import SmileComm
 
 import aiohttp
 from defusedxml import ElementTree as etree
@@ -37,7 +37,7 @@
 from munch import Munch
 
 
-class SmileAPI(SmileComm, SmileData):
+class SmileAPI(SmileData):
     """The Plugwise SmileAPI helper class for actual Plugwise devices."""
 
     # pylint: disable=too-many-instance-attributes, too-many-public-methods
@@ -46,7 +46,7 @@ def __init__(
         self,
         host: str,
         password: str,
-        timeout: int,
+        request: Callable[..., Awaitable[Any]],
         websession: aiohttp.ClientSession,
         _cooling_present: bool,
         _elga: bool,
@@ -69,14 +69,6 @@ def __init__(
         username: str = DEFAULT_USERNAME,
     ) -> None:
         """Set the constructor for this class."""
-        super().__init__(
-            host,
-            password,
-            port,
-            timeout,
-            username,
-            websession,
-        )
         SmileData.__init__(self)
 
         self._cooling_present = _cooling_present
@@ -86,9 +78,9 @@ def __init__(
         self._on_off_device = _on_off_device
         self._opentherm_device = _opentherm_device
         self._schedule_old_states = _schedule_old_states
-        self._timeout = timeout
         self.gateway_id = gateway_id
         self.loc_data = loc_data
+        self.request = request
         self.smile_fw_version = smile_fw_version
         self.smile_hostname = smile_hostname
         self.smile_hw_version = smile_hw_version
@@ -103,7 +95,7 @@ def __init__(
 
     async def full_update_device(self) -> None:
         """Perform a first fetch of all XML data, needed for initialization."""
-        self._domain_objects = await self._request(DOMAIN_OBJECTS)
+        self._domain_objects = await self.request(DOMAIN_OBJECTS)
         self._get_plugwise_notifications()
 
     def get_all_devices(self) -> None:
@@ -461,10 +453,10 @@ async def set_temperature(self, loc_id: str, items: dict[str, float]) -> None:
         await self.call_request(uri, method="put", data=data)
 
     async def call_request(self, uri: str, **kwargs: Any) -> None:
-        """ConnectionFailedError wrapper for calling _request()."""
+        """ConnectionFailedError wrapper for calling request()."""
         method: str = kwargs["method"]
         data: str | None = kwargs.get("data")
         try:
-            await self._request(uri, method=method, data=data)
+            await self.request(uri, method=method, data=data)
         except ConnectionFailedError as exc:
             raise ConnectionFailedError from exc

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name            = "plugwise"
-version         = "1.4.2"
+version         = "1.4.3"
 license         = {file = "LICENSE"}
 description     = "Plugwise Smile (Adam/Anna/P1) and Stretch module for Python 3."
 readme          = "README.md"