aioWiserHeatAPI 1.5.1__tar.gz → 1.5.3__tar.gz

{aioWiserHeatAPI-1.5.1 → aioWiserHeatAPI-1.5.3}/PKG-INFO

@@ -1,25 +1,24 @@
 Metadata-Version: 2.1
 Name: aioWiserHeatAPI
-Version: 1.5.1
+Version: 1.5.3
 Summary: An AsyncIO API for controlling the Drayton Wiser Heating system
 Home-page: https://github.com/msp1974/aioWiserHeatAPI
 Author: Mark Parker
 Author-email: msparker@sky.com
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: zeroconf>=0.47.1
-Requires-Dist: aiohttp>=3.8.1
-Requires-Dist: aiofiles>=0.8.0
-Requires-Dist: pyyaml>=6.0
-Requires-Dist: httpx>=0.25.0
+Requires-Dist: zeroconf>=0.127.0
+Requires-Dist: aiohttp>=3.9.1
+Requires-Dist: aiofiles>=23.2.1
+Requires-Dist: pyyaml>=6.0.1
 
-# Drayton Wiser Hub API Async v1.5.1
+# Drayton Wiser Hub API Async v1.5.3
 
 This repository contains a simple API which queries the Drayton Wiser Heating sysystem used in the UK.
 
@@ -73,6 +72,14 @@ Documentation available in [info.md](https://github.com/msp1974/wiserHeatAPIv2/b
 
 ## Changelog
 
+### v1.5.3
+
+* Fixed issue whereby json conversion errors due to control characters in string
+
+### v1.5.2
+
+* Revert to aiohttp and fix errors with v3.9.x that caused move to httpx
+
 ### v1.5.1
 
 * Fix nuances with httpx

{aioWiserHeatAPI-1.5.1 → aioWiserHeatAPI-1.5.3}/README.md

@@ -1,4 +1,4 @@
-# Drayton Wiser Hub API Async v1.5.1
+# Drayton Wiser Hub API Async v1.5.3
 
 This repository contains a simple API which queries the Drayton Wiser Heating sysystem used in the UK.
 
@@ -52,6 +52,14 @@ Documentation available in [info.md](https://github.com/msp1974/wiserHeatAPIv2/b
 
 ## Changelog
 
+### v1.5.3
+
+* Fixed issue whereby json conversion errors due to control characters in string
+
+### v1.5.2
+
+* Revert to aiohttp and fix errors with v3.9.x that caused move to httpx
+
 ### v1.5.1
 
 * Fix nuances with httpx

{aioWiserHeatAPI-1.5.1 → aioWiserHeatAPI-1.5.3}/aioWiserHeatAPI/__init__.py

@@ -3,6 +3,6 @@ import logging
 name = "aioWiserHeatAPI"
 __all__ = ["wiserAPI", "wiserDiscovery"]
 
-__VERSION__ = "1.5.1"
+__VERSION__ = "1.5.3"
 
 _LOGGER = logging.getLogger(__name__)

{aioWiserHeatAPI-1.5.1 → aioWiserHeatAPI-1.5.3}/aioWiserHeatAPI/rest_controller.py

@@ -1,12 +1,12 @@
+"""Module to manage rest commands of Wiser hub"""
 import asyncio
 import enum
 import json
 import re
 from dataclasses import dataclass
-from typing import Any, Optional, cast
+from typing import Optional
 
 import aiohttp
-import httpx
 
 from aioWiserHeatAPI.helpers.extra_config import _WiserExtraConfig
 
@@ -27,6 +27,8 @@ from .exceptions import (
 
 @dataclass
 class WiserAPIParams:
+    """Class to hold default values"""
+
     passive_mode_increment = 0.5
     stored_manual_target_temperature_alt_source = "current"
 
@@ -44,6 +46,8 @@ class _WiserConnectionInfo(object):
 
 # Enums
 class WiserRestActionEnum(enum.Enum):
+    """Enumeration of http methods"""
+
     GET = "get"
     POST = "post"
     PATCH = "patch"
@@ -57,18 +61,20 @@ class _WiserRestController(object):
 
     def __init__(
         self,
-        session: Optional[aiohttp.ClientSession] = None,
         timeout: Optional[float] = REST_TIMEOUT,
         wiser_connection_info: Optional[_WiserConnectionInfo] = None,
     ):
         self._wiser_connection_info = wiser_connection_info
         self._api_parameters = WiserAPIParams()
-
-        self._timeout = timeout  # aiohttp.ClientTimeout(total=timeout)
+        self._timeout = aiohttp.ClientTimeout(total=timeout)
         self._hub_name = None
         self._extra_config_file = None
         self._extra_config: _WiserExtraConfig = None
 
+    def remove_control_characters(self, data: str):
+        """Remove control charactwers from string."""
+        return re.sub(r"[\x00-\x1f]", "", data)
+
     async def _do_hub_action(
         self,
         action: WiserRestActionEnum,
@@ -88,12 +94,11 @@ class _WiserRestController(object):
             self._wiser_connection_info.port,
         )
 
-        kwargs = {
-            "headers": {
-                "SECRET": self._wiser_connection_info.secret,
-                "Content-Type": "application/json;charset=UTF-8",
-                "Connection": "close",
-            }
+        kwargs = {}
+
+        kwargs["headers"] = {
+            "SECRET": self._wiser_connection_info.secret,
+            "Content-Type": "application/json;charset=UTF-8",
         }
 
         if data is not None:
@@ -103,34 +108,47 @@ class _WiserRestController(object):
             kwargs["timeout"] = self._timeout
 
         try:
-            async with httpx.AsyncClient() as client:
-                response = await getattr(client, action.value)(
+            async with aiohttp.ClientSession(
+                version=aiohttp.HttpVersion10,
+            ) as session:
+                async with getattr(session, action.value)(
                     url,
                     **kwargs,
-                )
-
-                if response.status_code >= 400:
-                    self._process_nok_response(
-                        response, url, data, raise_for_endpoint_error
-                    )
-                else:
-                    content = await response.aread()
-                    if len(content) > 0:
-                        response = content.decode("utf-8", "ignore").encode(
-                            "utf-8"
+                ) as response:
+                    if not response.ok:
+                        self._process_nok_response(
+                            response, url, data, raise_for_endpoint_error
                         )
-                        return json.loads(response)
                     else:
-                        return {}
-                return {}
+                        content = await response.read()
+                        if len(content) > 0:
+                            response = content.decode("utf-8", "ignore")
+                            return json.loads(
+                                self.remove_control_characters(response),
+                            )
+                        else:
+                            return {}
+                    return {}
 
-        except httpx.TimeoutException as ex:
+        except asyncio.TimeoutError as ex:
             raise WiserHubConnectionError(
-                f"Connection timeout trying to communicate with Wiser Hub {self._wiser_connection_info.host} for url {url}. Error is {ex}"
+                f"Connection timeout trying to communicate with Wiser Hub "
+                f"{self._wiser_connection_info.host} for url {url}"
             ) from ex
-        except httpx.NetworkError as ex:
+        except ConnectionResetError as ex:
             raise WiserHubConnectionError(
-                f"Connection error trying to communicate with Wiser Hub {self._wiser_connection_info.host} for url {url}. Error is {ex}"
+                f"Connection was reset by the hub during communication "
+                f"{self._wiser_connection_info.host} for url {url}.  Error is {ex}"
+            ) from ex
+        except aiohttp.ClientResponseError as ex:
+            raise WiserHubConnectionError(
+                f"Response error trying to communicate with Wiser Hub "
+                f"{self._wiser_connection_info.host} for url {url}.  Error is {ex}"
+            ) from ex
+        except aiohttp.ClientConnectorError as ex:
+            raise WiserHubConnectionError(
+                f"Connection error trying to communicate with Wiser Hub "
+                f"{self._wiser_connection_info.host} for url {url}.  Error is {ex}"
             ) from ex
 
     def _process_nok_response(
@@ -140,21 +158,26 @@ class _WiserRestController(object):
         data: dict,
         raise_for_endpoint_error: bool = True,
     ):
-        if response.status_code == 401:
+        if response.status == 401:
             raise WiserHubAuthenticationError(
-                f"Error authenticating to Wiser Hub {self._wiser_connection_info.host}.  Check your secret key"
+                f"Error authenticating to Wiser Hub "
+                f"{self._wiser_connection_info.host}. Check your secret key"
             )
-        elif response.status_code == 404 and raise_for_endpoint_error:
+        elif response.status == 404 and raise_for_endpoint_error:
             raise WiserHubRESTError(
-                f"Rest endpoint not found on Wiser Hub {self._wiser_connection_info.host} for url {url}"
+                f"Rest endpoint not found on Wiser Hub "
+                f"{self._wiser_connection_info.host} for url {url}"
             )
-        elif response.status_code == 408:
+        elif response.status == 408:
             raise WiserHubConnectionError(
-                f"Connection timed out trying to communicate with Wiser Hub {self._wiser_connection_info.host} for url {url}"
+                f"Connection timed out trying to communicate with Wiser Hub "
+                f"{self._wiser_connection_info.host} for url {url}"
             )
         elif raise_for_endpoint_error:
             raise WiserHubRESTError(
-                f"Unknown error communicating with Wiser Hub {self._wiser_connection_info.host} for url {url} with data {data}.  Error code is: {response.status_code}"
+                f"Unknown error communicating with Wiser Hub "
+                f"{self._wiser_connection_info.host} for url {url} with data {data}. "
+                f"Error code is: {response.status}"
             )
 
     async def _get_hub_data(
@@ -176,9 +199,10 @@ class _WiserRestController(object):
                     self._extra_config_file, self._hub_name.lower()
                 )
                 await self._extra_config.async_load_config()
-            except WiserExtraConfigError as ex:
+            except WiserExtraConfigError:
                 _LOGGER.error(
-                    "Your config file is corrupted and needs to be fixed to maintain all the functionality of this integration."
+                    "Your config file is corrupted and needs to be fixed "
+                    "to maintain all the functionality of this integration."
                 )
                 self._extra_config = None
 
@@ -196,9 +220,7 @@ class _WiserRestController(object):
         """
         url = WISERHUBDOMAIN + url
         _LOGGER.debug(
-            "Sending command to url: {} with parameters {}".format(
-                url, command_data
-            )
+            "Sending command to url: %s with parameters %s", url, command_data
         )
 
         return await self._do_hub_action(method, url, command_data)
@@ -214,17 +236,19 @@ class _WiserRestController(object):
         """
         url = WISERHUBSCHEDULES + url
         _LOGGER.debug(
-            "Actioning schedule to url: {} with action {} and data {}".format(
-                url, action.value, schedule_data
-            )
+            "Actioning schedule to url: %s with action %s and data %s",
+            url,
+            action.value,
+            schedule_data,
         )
+
         return await self._do_hub_action(action, url, schedule_data)
 
     async def _send_schedule_command(
         self,
         action: str,
         schedule_data: dict,
-        id: int = 0,
+        schedule_id: int = 0,
         schedule_type: str = None,
     ) -> bool:
         """
@@ -236,7 +260,7 @@ class _WiserRestController(object):
         if action == "UPDATE":
             result = await self._do_schedule_action(
                 WiserRestActionEnum.PATCH,
-                "{}/{}".format(schedule_type, id),
+                f"{schedule_type}/{schedule_id}",
                 schedule_data,
             )
 
@@ -257,7 +281,7 @@ class _WiserRestController(object):
         elif action == "DELETE":
             result = await self._do_schedule_action(
                 WiserRestActionEnum.DELETE,
-                "{}/{}".format(schedule_type, id),
+                f"{schedule_type}/{schedule_id}",
                 schedule_data,
             )
         return result

{aioWiserHeatAPI-1.5.1 → aioWiserHeatAPI-1.5.3}/aioWiserHeatAPI/wiserhub.py

@@ -66,13 +66,11 @@ class WiserAPI(object):
         host: str,
         secret: str,
         port: Optional[int] = 80,
-        session: Optional[aiohttp.ClientSession] = None,
         units: Optional[WiserUnitsEnum] = WiserUnitsEnum.metric,
         extra_config_file: Optional[str] = None,
         enable_automations: Optional[bool] = True,
     ):
         # Connection variables
-        self._session = session
         self._wiser_api_connection = _WiserConnectionInfo()
         self._wiser_rest_controller = None
 
@@ -115,7 +113,7 @@ class WiserAPI(object):
         ):
             # Create an instance of the rest controller
             self._wiser_rest_controller = _WiserRestController(
-                self._session, wiser_connection_info=self._wiser_api_connection
+                wiser_connection_info=self._wiser_api_connection
             )
         else:
             raise WiserHubConnectionError(
@@ -147,8 +145,8 @@ class WiserAPI(object):
             WISERHUBSCHEDULES
         )
         try:
-            self._status_data = await self._wiser_rest_controller._get_hub_data(
-                WISERHUBSTATUS
+            self._status_data = (
+                await self._wiser_rest_controller._get_hub_data(WISERHUBSTATUS)
             )
         except WiserHubRESTError:
             self._status_data = {}
@@ -161,16 +159,22 @@ class WiserAPI(object):
         )
 
         # load extra data
-        self._wiser_rest_controller._extra_config_file = self._extra_config_file
+        self._wiser_rest_controller._extra_config_file = (
+            self._extra_config_file
+        )
         await self._wiser_rest_controller._get_extra_config_data()
 
         # Only get opentherm data if connected
         if (
-            self._domain_data.get("System", {}).get("OpenThermConnectionStatus", "")
+            self._domain_data.get("System", {}).get(
+                "OpenThermConnectionStatus", ""
+            )
             == "Connected"
         ):
-            self._opentherm_data = await self._wiser_rest_controller._get_hub_data(
-                WISERHUBOPENTHERM, False
+            self._opentherm_data = (
+                await self._wiser_rest_controller._get_hub_data(
+                    WISERHUBOPENTHERM, False
+                )
             )
 
         if self._domain_data != {} and self._network_data != {}:
@@ -228,7 +232,8 @@ class WiserAPI(object):
             # Moments
             if self._domain_data.get("Moment"):
                 self._moments = _WiserMomentCollection(
-                    self._wiser_rest_controller, self._domain_data.get("Moment")
+                    self._wiser_rest_controller,
+                    self._domain_data.get("Moment"),
                 )
 
             # If gets here with no exceptions then success and return true
@@ -236,9 +241,6 @@ class WiserAPI(object):
 
         return False
 
-    async def close_session(self):
-        await self._wiser_rest_controller._session.close()
-
     # API properties
     @property
     def api_parameters(self):
@@ -326,7 +328,9 @@ class WiserAPI(object):
             try:
                 if data:
                     # Write out to file
-                    log_response_to_file(data, filename, False, pathlib.Path(file_path))
+                    log_response_to_file(
+                        data, filename, False, pathlib.Path(file_path)
+                    )
                     return True
             except Exception as ex:
                 _LOGGER.error(ex)

{aioWiserHeatAPI-1.5.1 → aioWiserHeatAPI-1.5.3}/aioWiserHeatAPI.egg-info/PKG-INFO

@@ -1,25 +1,24 @@
 Metadata-Version: 2.1
 Name: aioWiserHeatAPI
-Version: 1.5.1
+Version: 1.5.3
 Summary: An AsyncIO API for controlling the Drayton Wiser Heating system
 Home-page: https://github.com/msp1974/aioWiserHeatAPI
 Author: Mark Parker
 Author-email: msparker@sky.com
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: zeroconf>=0.47.1
-Requires-Dist: aiohttp>=3.8.1
-Requires-Dist: aiofiles>=0.8.0
-Requires-Dist: pyyaml>=6.0
-Requires-Dist: httpx>=0.25.0
+Requires-Dist: zeroconf>=0.127.0
+Requires-Dist: aiohttp>=3.9.1
+Requires-Dist: aiofiles>=23.2.1
+Requires-Dist: pyyaml>=6.0.1
 
-# Drayton Wiser Hub API Async v1.5.1
+# Drayton Wiser Hub API Async v1.5.3
 
 This repository contains a simple API which queries the Drayton Wiser Heating sysystem used in the UK.
 
@@ -73,6 +72,14 @@ Documentation available in [info.md](https://github.com/msp1974/wiserHeatAPIv2/b
 
 ## Changelog
 
+### v1.5.3
+
+* Fixed issue whereby json conversion errors due to control characters in string
+
+### v1.5.2
+
+* Revert to aiohttp and fix errors with v3.9.x that caused move to httpx
+
 ### v1.5.1
 
 * Fix nuances with httpx

aioWiserHeatAPI-1.5.3/aioWiserHeatAPI.egg-info/requires.txt

@@ -0,0 +1,4 @@
+zeroconf>=0.127.0
+aiohttp>=3.9.1
+aiofiles>=23.2.1
+pyyaml>=6.0.1

{aioWiserHeatAPI-1.5.1 → aioWiserHeatAPI-1.5.3}/setup.py

@@ -35,18 +35,17 @@ setuptools.setup(
     classifiers=[
         "Development Status :: 5 - Production/Stable",
         "Intended Audience :: Developers",
-        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
     ],
     install_requires=[
-        "zeroconf>=0.47.1",
-        "aiohttp>=3.8.1",
-        "aiofiles>=0.8.0",
-        "pyyaml>=6.0",
-        "httpx>=0.25.0",
+        "zeroconf>=0.127.0",
+        "aiohttp>=3.9.1",
+        "aiofiles>=23.2.1",
+        "pyyaml>=6.0.1",
     ],
-    python_requires=">=3.10",
+    python_requires=">=3.11",
     entry_points={
         "console_scripts": ["wiser = aioWiserHeatAPI.cli:main"],
     },

aioWiserHeatAPI-1.5.1/aioWiserHeatAPI.egg-info/requires.txt

@@ -1,5 +0,0 @@
-zeroconf>=0.47.1
-aiohttp>=3.8.1
-aiofiles>=0.8.0
-pyyaml>=6.0
-httpx>=0.25.0