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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-bsblan
-Version: 0.5.17
+Version: 0.5.19
 Summary: Asynchronous Python client for BSBLAN
 Home-page: https://github.com/liudger/python-bsblan
 License: MIT
@@ -23,8 +23,8 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: aiohttp (>=3.8.1)
 Requires-Dist: async-timeout (>=4.0.3,<5.0.0)
 Requires-Dist: backoff (>=2.2.1,<3.0.0)
+Requires-Dist: mashumaro (>=3.13.1,<4.0.0)
 Requires-Dist: packaging (>=21.3)
-Requires-Dist: pydantic (>=1.9.0)
 Requires-Dist: yarl (>=1.7.2)
 Project-URL: Bug Tracker, https://github.com/liudger/python-bsblan/issues
 Project-URL: Changelog, https://github.com/liudger/python-bsblan/releases

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-bsblan"
-version = "0.5.17"
+version = "0.5.19"
 description = "Asynchronous Python client for BSBLAN"
 authors = ["Willem-Jan van Rootselaar <liudgervr@gmail.com>"]
 maintainers = ["Willem-Jan van Rootselaar <liudgervr@gmail.com>"]
@@ -28,25 +28,25 @@ packages = [
 python = "^3.10"
 aiohttp = ">=3.8.1"
 yarl = ">=1.7.2"
-pydantic = ">=1.9.0"
 packaging = ">=21.3"
 backoff = "^2.2.1"
 async-timeout = "^4.0.3"
+mashumaro = "^3.13.1"
 
 [tool.poetry.dev-dependencies]
 covdefaults = "^2.3.0"
-ruff = "^0.1.0"
-aresponses = "^2.1.6"
-black = "^23.0.0"
+ruff = "^0.5.0"
+aresponses = "^3.0.0"
+black = "^24.0.0"
 blacken-docs = "^1.13.0"
 coverage = "^7.0.5"
-flake8 = "^6.0.0"
+flake8 = "^7.0.0"
 isort = "^5.11.4"
 mypy = "^1.0.0"
 pre-commit = "^3.0.0"
 pre-commit-hooks = "^4.3.0"
 pylint = "^3.0.0"
-pytest = "^7.2.1"
+pytest = "^8.0.0"
 pytest-asyncio = "^0.23.0"
 pytest-cov = "^4.0.0"
 yamllint = "^1.29.0"
@@ -54,7 +54,7 @@ pyupgrade = "^3.3.1"
 flake8-simplify = "^0.21.0"
 vulture = "^2.7"
 darglint = "^1.8.1"
-safety = "^2.3.4"
+safety = "^3.0.0"
 codespell = "^2.2.2"
 bandit = "^1.7.4"
 pytest-mock = "^3.10.0"
@@ -150,7 +150,7 @@ max-line-length=88
 addopts = "--cov"
 asyncio_mode = "auto"
 
-[tool.ruff]
+[tool.ruff.lint]
 select = ["ALL"]
 ignore = [
   "ANN101", # Self... explanatory
@@ -161,14 +161,14 @@ ignore = [
   "PLR2004", # Just annoying, not really useful
 ]
 
-[tool.ruff.flake8-pytest-style]
+[tool.ruff.lint.flake8-pytest-style]
 mark-parentheses = false
 fixture-parentheses = false
 
-[tool.ruff.isort]
-known-first-party = ["wled"]
+[tool.ruff.lint.isort]
+known-first-party = ["bsblan"]
 
-[tool.ruff.mccabe]
+[tool.ruff.lint.mccabe]
 max-complexity = 25
 
 [build-system]

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

@@ -33,7 +33,12 @@ from .constants import (
     STATIC_VALUES_API_V3,
     VERSION_ERROR_MSG,
 )
-from .exceptions import BSBLANConnectionError, BSBLANError
+from .exceptions import (
+    BSBLANConnectionError,
+    BSBLANError,
+    BSBLANInvalidParameterError,
+    BSBLANVersionError,
+)
 from .models import Device, Info, Sensor, State, StaticState
 
 logging.basicConfig(level=logging.DEBUG)
@@ -97,6 +102,7 @@ class BSBLAN:
                 fails.
             BSBLANError: If receiving from the BSBLAN device an unexpected
                 response.
+
         """
         try:
             version = metadata.version(__package__ or __name__)
@@ -159,6 +165,7 @@ class BSBLAN:
         Returns
         -------
             A BSBLAN state object.
+
         """
         if not self._string_circuit1 or not self._heating_params:
             # retrieve heating circuit 1
@@ -174,7 +181,7 @@ class BSBLAN:
 
         # set hvac_mode with correct value
         data["hvac_mode"]["value"] = HVAC_MODE_DICT[int(data["hvac_mode"]["value"])]
-        return State.model_validate(data)
+        return State.from_dict(data)
 
     async def sensor(self) -> Sensor:
         """Get the sensor information from BSBLAN device.
@@ -182,6 +189,7 @@ class BSBLAN:
         Returns
         -------
             A BSBLAN sensor object.
+
         """
         if not self._sensor_params:
             data = await self._get_dict_version()
@@ -192,7 +200,7 @@ class BSBLAN:
         # retrieve sensor params so we can build the data structure
         data = await self._request(params={"Parameter": f"{self._sensor_list}"})
         data = dict(zip(self._sensor_params, list(data.values()), strict=True))
-        return Sensor.model_validate(data)
+        return Sensor.from_dict(data)
 
     async def static_values(self) -> StaticState:
         """Get the static information from BSBLAN device.
@@ -200,6 +208,7 @@ class BSBLAN:
         Returns
         -------
             A BSBLAN staticState object.
+
         """
         if not self._static_params:
             data = await self._get_dict_version()
@@ -212,7 +221,7 @@ class BSBLAN:
         data = dict(zip(self._static_params, list(data.values()), strict=True))
         self._min_temp = data["min_temp"]["value"]
         self._max_temp = data["max_temp"]["value"]
-        return StaticState.model_validate(data)
+        return StaticState.from_dict(data)
 
     async def _get_dict_version(self) -> dict[Any, Any]:
         """Get the version from device.
@@ -240,7 +249,7 @@ class BSBLAN:
                 "device": DEVICE_INFO_API_V3,
                 "sensor": SENSORS_API_V3,
             }
-        raise BSBLANError(VERSION_ERROR_MSG)
+        raise BSBLANVersionError(VERSION_ERROR_MSG)
 
     async def device(self) -> Device:
         """Get BSBLAN device info.
@@ -251,7 +260,7 @@ class BSBLAN:
 
         """
         device_info = await self._request(base_path="/JI")
-        return Device.model_validate(device_info)
+        return Device.from_dict(device_info)
 
     async def info(self) -> Info:
         """Get information about the current heating system config.
@@ -259,6 +268,7 @@ class BSBLAN:
         Returns
         -------
             A BSBLAN info object about the heating system.
+
         """
         if not self._info or not self._device_params:
             device_dict = await self._get_dict_version()
@@ -268,7 +278,7 @@ class BSBLAN:
 
         data = await self._request(params={"Parameter": f"{self._info}"})
         data = dict(zip(self._device_params, list(data.values()), strict=True))
-        return Info.model_validate(data)
+        return Info.from_dict(data)
 
     async def _get_parameters(self, params: dict[Any, Any]) -> dict[Any, Any]:
         """Get the parameters info from BSBLAN device.
@@ -280,6 +290,7 @@ class BSBLAN:
         Returns:
         -------
             A dict of 2 objects [str, list].
+
         """
         _string_params = [*params]
         list_params = list(params.values())
@@ -303,6 +314,7 @@ class BSBLAN:
         Raises:
         ------
             BSBLANError: The provided values are invalid.
+
         """
 
         class ThermostatState(  # lgtm [py/unused-local-variable]
@@ -326,14 +338,18 @@ class BSBLAN:
                 <= float(target_temperature)
                 <= float(self._max_temp)
             ):
-                raise BSBLANError(INVALID_VALUES_ERROR_MSG)
+                raise BSBLANInvalidParameterError(
+                    INVALID_VALUES_ERROR_MSG + ": " + str(target_temperature),
+                )
             state["Parameter"] = "710"
             state["Value"] = target_temperature
             state["Type"] = "1"
 
         if hvac_mode is not None:
             if hvac_mode not in HVAC_MODE_DICT_REVERSE:
-                raise BSBLANError(INVALID_VALUES_ERROR_MSG)
+                raise BSBLANInvalidParameterError(
+                    INVALID_VALUES_ERROR_MSG + ": " + str(hvac_mode),
+                )
             state["Parameter"] = "700"
             state["EnumValue"] = HVAC_MODE_DICT_REVERSE[hvac_mode]
             state["Type"] = "1"
@@ -357,6 +373,7 @@ class BSBLAN:
         Returns
         -------
             The BSBLAN object.
+
         """
         logger.debug("BSBLAN: %s", self)
         return self
@@ -367,5 +384,6 @@ class BSBLAN:
         Args:
         ----
             *_exc_info: Exec type.
+
         """
         await self.close()

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

@@ -17,6 +17,7 @@ class BSBLANError(Exception):
         Returns:
         -------
             None.
+
         """
         if message is not None:
             self.message = message
@@ -29,6 +30,7 @@ class BSBLANConnectionError(BSBLANError):
     Attributes
     ----------
         response: The response received from the BSBLAN device.
+
     """
 
     message = "Error occurred while connecting to BSBLAN device."
@@ -43,6 +45,32 @@ class BSBLANConnectionError(BSBLANError):
         Returns:
         -------
             None.
+
         """
         self.response = response
         super().__init__(self.message)
+
+
+class BSBLANVersionError(BSBLANError):
+    """Raised when the BSBLAN device has an unsupported version."""
+
+    message = "The BSBLAN device has an unsupported version."
+
+
+class BSBLANInvalidParameterError(BSBLANError):
+    """Raised when an invalid parameter is provided."""
+
+    def __init__(self, parameter: str) -> None:
+        """Initialize a new instance of the BSBLANInvalidParameterError class.
+
+        Args:
+        ----
+            parameter: The invalid parameter.
+
+        Returns:
+        -------
+            None.
+
+        """
+        self.message = f"Invalid parameter: {parameter}"
+        super().__init__(self.message)

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

@@ -1,8 +1,11 @@
 """Models for BSB-Lan."""
-from pydantic import BaseModel, Field
+from dataclasses import dataclass, field
 
+from mashumaro.mixins.json import DataClassJSONMixin
 
-class EntityInfo(BaseModel):
+
+@dataclass
+class EntityInfo(DataClassJSONMixin):
     """Convert Data to valid keys and convert to object attributes.
 
     This object holds info about specific objects.
@@ -11,13 +14,14 @@ class EntityInfo(BaseModel):
     ----------
         name: Name attribute.
         value: value of attribute.
+
     """
 
-    name: str = Field(..., alias="name")
-    unit: str = Field(..., alias="unit")
-    desc: str = Field(..., alias="desc")
-    value: str = Field(..., alias="value")
-    data_type: int = Field(..., alias="dataType")
+    name: str = field(metadata={"alias": "name"})
+    unit: str = field(metadata={"alias": "unit"})
+    desc: str = field(metadata={"alias": "desc"})
+    value: str = field(metadata={"alias": "value"})
+    data_type: int = field(metadata={"alias": "dataType"})
 
     """
     "DataType" (
@@ -34,7 +38,8 @@ class EntityInfo(BaseModel):
     """
 
 
-class State(BaseModel):
+@dataclass
+class State(DataClassJSONMixin):
     """Object that holds information about the state of a climate system.
 
     Attributes
@@ -51,6 +56,7 @@ class State(BaseModel):
         The current temperature of the climate system.
     room1_thermostat_mode : EntityInfo
         The thermostat mode of the climate system.
+
     """
 
     hvac_mode: EntityInfo
@@ -61,21 +67,24 @@ class State(BaseModel):
     room1_thermostat_mode: EntityInfo
 
 
-class StaticState(BaseModel):
+@dataclass
+class StaticState(DataClassJSONMixin):
     """Class for entities that are not changing."""
 
     min_temp: EntityInfo
     max_temp: EntityInfo
 
 
-class Sensor(BaseModel):
+@dataclass
+class Sensor(DataClassJSONMixin):
     """Object holds info about object for sensor climate."""
 
     current_temperature: EntityInfo
     outside_temperature: EntityInfo
 
 
-class Device(BaseModel):
+@dataclass
+class Device(DataClassJSONMixin):
     """Object holds bsblan device information.
 
     Attributes
@@ -83,21 +92,24 @@ class Device(BaseModel):
         name: Name of the device.
         version: Firmware version of the device.
         MAC: MAC address of the device.
+
     """
 
-    name: str = Field(..., alias="name")
-    version: str = Field(..., alias="version")
-    MAC: str = Field(..., alias="MAC")
-    uptime: int = Field(..., alias="uptime")
+    name: str
+    version: str
+    MAC: str  # pylint: disable=invalid-name
+    uptime: int
 
 
-class Info(BaseModel):
+@dataclass
+class Info(DataClassJSONMixin):
     """Object holding the heatingSystem info.
 
     Attributes
     ----------
         name: Name of the sub-device.
         value: type of device.
+
     """
 
     device_identification: EntityInfo