aioWiserHeatAPI 1.5.2__tar.gz → 1.5.3__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aioWiserHeatAPI
-Version: 1.5.2
+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
@@ -18,7 +18,7 @@ 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.2
+# 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.
 
@@ -72,6 +72,10 @@ 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

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

@@ -1,4 +1,4 @@
-# Drayton Wiser Hub API Async v1.5.2
+# 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,10 @@ 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

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

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

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

@@ -1,6 +1,8 @@
+"""Module to manage rest commands of Wiser hub"""
 import asyncio
 import enum
 import json
+import re
 from dataclasses import dataclass
 from typing import Optional
 
@@ -25,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"
 
@@ -42,6 +46,8 @@ class _WiserConnectionInfo(object):
 
 # Enums
 class WiserRestActionEnum(enum.Enum):
+    """Enumeration of http methods"""
+
     GET = "get"
     POST = "post"
     PATCH = "patch"
@@ -65,6 +71,10 @@ class _WiserRestController(object):
         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,
@@ -112,26 +122,34 @@ class _WiserRestController(object):
                     else:
                         content = await response.read()
                         if len(content) > 0:
-                            response = content.decode(
-                                "utf-8", "ignore"
-                            ).encode("utf-8")
-                            return json.loads(response)
+                            response = content.decode("utf-8", "ignore")
+                            return json.loads(
+                                self.remove_control_characters(response),
+                            )
                         else:
                             return {}
                     return {}
 
         except asyncio.TimeoutError as ex:
             raise WiserHubConnectionError(
-                f"Connection timeout trying to communicate with Wiser Hub {self._wiser_connection_info.host} for url {url}"
-            )
+                f"Connection timeout trying to communicate with Wiser Hub "
+                f"{self._wiser_connection_info.host} for url {url}"
+            ) from ex
+        except ConnectionResetError as ex:
+            raise WiserHubConnectionError(
+                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 {self._wiser_connection_info.host} for url {url}.  Error is {ex}"
-            )
+                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 {self._wiser_connection_info.host} for url {url}.  Error is {ex}"
-            )
+                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(
         self,
@@ -142,19 +160,24 @@ class _WiserRestController(object):
     ):
         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 == 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 == 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}"
+                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.2 → 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
 
@@ -243,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):

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aioWiserHeatAPI
-Version: 1.5.2
+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
@@ -18,7 +18,7 @@ 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.2
+# 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.
 
@@ -72,6 +72,10 @@ 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