python-bsblan 0.5.19__tar.gz → 0.6.0__tar.gz

{python_bsblan-0.5.19 → python_bsblan-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-bsblan
-Version: 0.5.19
+Version: 0.6.0
 Summary: Asynchronous Python client for BSBLAN
 Home-page: https://github.com/liudger/python-bsblan
 License: MIT
@@ -9,16 +9,15 @@ Author: Willem-Jan van Rootselaar
 Author-email: liudgervr@gmail.com
 Maintainer: Willem-Jan van Rootselaar
 Maintainer-email: liudgervr@gmail.com
-Requires-Python: >=3.10,<4.0
+Requires-Python: >=3.12,<4.0
 Classifier: Development Status :: 3 - Alpha
 Classifier: Framework :: AsyncIO
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: aiohttp (>=3.8.1)
 Requires-Dist: async-timeout (>=4.0.3,<5.0.0)

{python_bsblan-0.5.19 → python_bsblan-0.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-bsblan"
-version = "0.5.19"
+version = "0.6.00"
 description = "Asynchronous Python client for BSBLAN"
 authors = ["Willem-Jan van Rootselaar <liudgervr@gmail.com>"]
 maintainers = ["Willem-Jan van Rootselaar <liudgervr@gmail.com>"]
@@ -15,8 +15,8 @@ classifiers = [
   "Framework :: AsyncIO",
   "Intended Audience :: Developers",
   "Natural Language :: English",
-  "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3",
   "Topic :: Software Development :: Libraries :: Python Modules",
 ]
@@ -25,7 +25,7 @@ packages = [
 ]
 
 [tool.poetry.dependencies]
-python = "^3.10"
+python = "^3.12"
 aiohttp = ">=3.8.1"
 yarl = ">=1.7.2"
 packaging = ">=21.3"
@@ -57,7 +57,6 @@ darglint = "^1.8.1"
 safety = "^3.0.0"
 codespell = "^2.2.2"
 bandit = "^1.7.4"
-pytest-mock = "^3.10.0"
 
 [tool.poetry.urls]
 "Bug Tracker" = "https://github.com/liudger/python-bsblan/issues"
@@ -80,7 +79,6 @@ multi_line_output = 3
 # free to run mypy on Windows, Linux, or macOS and get consistent
 # results.
 platform = "linux"
-python_version = "3.10"
 
 # show error messages from unrelated files
 follow_imports = "normal"

{python_bsblan-0.5.19 → python_bsblan-0.6.0}/src/bsblan/__init__.py

@@ -1,11 +1,12 @@
 """Asynchronous Python client for BSBLAN."""
 
-from .bsblan import BSBLAN
+from .bsblan import BSBLAN, BSBLANConfig
 from .exceptions import BSBLANConnectionError, BSBLANError
 from .models import Device, Info, Sensor, State, StaticState
 
 __all__ = [
     "BSBLAN",
+    "BSBLANConfig",
     "BSBLANConnectionError",
     "BSBLANError",
     "Info",

{python_bsblan-0.5.19 → python_bsblan-0.6.0}/src/bsblan/bsblan.py

@@ -1,19 +1,17 @@
 """Asynchronous Python client for BSB-Lan."""
+
 from __future__ import annotations
 
 import asyncio
 import logging
-import socket
 from asyncio.log import logger
 from dataclasses import dataclass, field
 from importlib import metadata
-from typing import Any, TypedDict, cast
+from typing import TYPE_CHECKING, Any, Mapping, TypedDict, cast
 
-import async_timeout
-import backoff
-from aiohttp.client import ClientError, ClientResponseError, ClientSession
+import aiohttp
+from aiohttp.client import ClientSession
 from aiohttp.hdrs import METH_POST
-from aiohttp.helpers import BasicAuth
 from packaging import version as pkg_version
 from typing_extensions import Self
 from yarl import URL
@@ -41,12 +39,15 @@ from .exceptions import (
 )
 from .models import Device, Info, Sensor, State, StaticState
 
+if TYPE_CHECKING:
+    from aiohttp.helpers import BasicAuth
+
 logging.basicConfig(level=logging.DEBUG)
 
 
 @dataclass
-class BSBLAN:
-    """Main class for handling connections with BSBLAN."""
+class BSBLANConfig:
+    """Configuration for BSBLAN."""
 
     host: str
     username: str | None = None
@@ -54,7 +55,12 @@ class BSBLAN:
     passkey: str | None = None
     port: int = 80
     request_timeout: int = 10
-    session: ClientSession | None = None
+
+
+@dataclass
+class BSBLAN:
+    """Main class for handling connections with BSBLAN."""
+
     _version: str = ""
     _heating_params: list[str] | None = None
     _string_circuit1: str | None = None
@@ -69,14 +75,49 @@ class BSBLAN:
     _auth: BasicAuth | None = None
     _close_session: bool = False
 
+    def __init__(self, config: BSBLANConfig) -> None:
+        """Initialize the BSBLAN object.
+
+        Args:
+        ----
+            config: Configuration for the BSBLAN object.
+
+        """
+        self.config = config
+        self.session: ClientSession | None = None
+        self._close_session = False
+
+    async def __aenter__(self) -> Self:
+        """Enter method for the context manager.
+
+        Returns
+        -------
+            Self: The current instance of the context manager.
+
+        """
+        if self.session is None:
+            self.session = aiohttp.ClientSession()
+            self._close_session = True
+        return self
+
+    async def __aexit__(self, *args: object) -> None:
+        """Exit method for the context manager.
+
+        Args:
+        ----
+            *args: Arguments passed to the exit method.
+
+        """
+        if self._close_session and self.session:
+            await self.session.close()
+
     # cSpell:ignore BSBLAN
-    @backoff.on_exception(backoff.expo, BSBLANConnectionError, max_tries=3, logger=None)
     async def _request(
         self,
         method: str = METH_POST,
         base_path: str = "/JQ",
         data: dict[str, object] | None = None,
-        params: dict[str, object] | None = None,
+        params: Mapping[str, str | int] | str | None = None,
     ) -> dict[str, Any]:
         """Handle a request to a BSBLAN device.
 
@@ -110,18 +151,19 @@ class BSBLAN:
             version = "0.0.0"
 
         # retrieve passkey for custom url
-        if self.passkey is not None:
-            base_path = f"/{self.passkey}{base_path}"
+        if self.config.passkey:
+            base_path = f"/{self.config.passkey}{base_path}"
 
         url = URL.build(
             scheme="http",
-            host=self.host,
-            port=self.port,
+            host=self.config.host,
+            port=self.config.port,
             path=base_path,
-        ).join(URL())
+        )
 
-        if self._auth is None and self.username and self.password:
-            self._auth = BasicAuth(self.username, self.password)
+        auth = None
+        if self.config.username and self.config.password:
+            auth = aiohttp.BasicAuth(self.config.username, self.config.password)
 
         headers = {
             "User-Agent": f"PythonBSBLAN/{version}",
@@ -133,31 +175,23 @@ class BSBLAN:
             self._close_session = True
 
         try:
-            async with async_timeout.timeout(self.request_timeout):
-                response = await self.session.request(
+            async with asyncio.timeout(self.config.request_timeout):
+                async with self.session.request(
                     method,
                     url,
-                    auth=self._auth,
+                    auth=auth,
                     params=params,
                     json=data,
                     headers=headers,
-                )
-                response.raise_for_status()
-        except asyncio.TimeoutError as exception:
-            raise BSBLANConnectionError(BSBLANConnectionError.message) from exception
-        except (
-            ClientError,
-            ClientResponseError,
-            socket.gaierror,
-        ) as exception:
-            raise BSBLANConnectionError(BSBLANConnectionError.message) from exception
-
-        content_type = response.headers.get("Content-Type", "")
-        if "application/json" not in content_type:
-            text = await response.text()
-            raise BSBLANError(BSBLANError.message + f" ({text})")
-
-        return cast(dict[str, Any], await response.json())
+                ) as response:
+                    response.raise_for_status()
+                    return cast(dict[str, Any], await response.json())
+        except asyncio.TimeoutError as e:
+            raise BSBLANConnectionError(BSBLANConnectionError.message_timeout) from e
+        except aiohttp.ClientError as e:
+            raise BSBLANConnectionError(BSBLANConnectionError.message_error) from e
+        except ValueError as e:
+            raise BSBLANError(str(e)) from e
 
     async def state(self) -> State:
         """Get the current state from BSBLAN device.
@@ -361,29 +395,3 @@ class BSBLAN:
         # Now it only checks if it could set value.
         response = await self._request(base_path="/JS", data=dict(state))
         logger.debug("response for setting: %s", response)
-
-    async def close(self) -> None:
-        """Close open client session."""
-        if self.session and self._close_session:
-            await self.session.close()
-
-    async def __aenter__(self) -> Self:
-        """Async enter.
-
-        Returns
-        -------
-            The BSBLAN object.
-
-        """
-        logger.debug("BSBLAN: %s", self)
-        return self
-
-    async def __aexit__(self, *_exc_info: object) -> None:
-        """Async exit.
-
-        Args:
-        ----
-            *_exc_info: Exec type.
-
-        """
-        await self.close()

{python_bsblan-0.5.19 → python_bsblan-0.6.0}/src/bsblan/exceptions.py

@@ -1,4 +1,5 @@
 """Exceptions for for BSB-Lan."""
+
 from __future__ import annotations
 
 
@@ -33,7 +34,8 @@ class BSBLANConnectionError(BSBLANError):
 
     """
 
-    message = "Error occurred while connecting to BSBLAN device."
+    message_timeout = "Timeout occurred while connecting to BSBLAN device."
+    message_error = "Error occurred while connecting to BSBLAN device."
 
     def __init__(self, response: str | None = None) -> None:
         """Initialize a new instance of the BSBLANConnectionError class.

{python_bsblan-0.5.19 → python_bsblan-0.6.0}/src/bsblan/models.py

@@ -1,4 +1,5 @@
 """Models for BSB-Lan."""
+
 from dataclasses import dataclass, field
 
 from mashumaro.mixins.json import DataClassJSONMixin