pykoplenti 1.2.1__py3-none-any.whl → 1.3.0__py3-none-any.whl

pykoplenti/api.py

@@ -13,17 +13,16 @@ import warnings
 
 from Crypto.Cipher import AES
 from aiohttp import ClientResponse, ClientSession, ClientTimeout
-from pydantic import parse_obj_as
 from yarl import URL
 
 from .model import (
     EventData,
     MeData,
     ModuleData,
-    ProcessData,
     ProcessDataCollection,
     SettingsData,
     VersionData,
+    process_data_list,
 )
 
 _logger: Final = logging.getLogger(__name__)
@@ -86,6 +85,20 @@ class ModuleNotFoundException(ApiException):
         self.error = error
 
 
+def _relogin(fn):
+    """Decorator for automatic re-login if session was expired."""
+
+    @functools.wraps(fn)
+    async def _wrapper(self: "ApiClient", *args, **kwargs):
+        with contextlib.suppress(AuthenticationException, NotAuthorizedException):
+            return await fn(self, *args, **kwargs)
+        _logger.debug("Request failed - try to re-login")
+        await self._login()
+        return await fn(self, *args, **kwargs)
+
+    return _wrapper
+
+
 class ApiClient(contextlib.AbstractAsyncContextManager):
     """Client for the REST-API of Kostal Plenticore inverters.
 
@@ -265,7 +278,7 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
         client_signature = hmac.new(
             stored_key, auth_msg.encode("utf-8"), hashlib.sha256
         ).digest()
-        client_proof = bytes([a ^ b for a, b in zip(client_key, client_signature)])
+        client_proof = bytes(a ^ b for a, b in zip(client_key, client_signature))
 
         server_key = hmac.new(
             salted_passwd, "Server Key".encode("utf-8"), hashlib.sha256
@@ -343,47 +356,32 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
         """Check if the given response contains an error and throws
         the appropriate exception."""
 
-        if resp.status != 200:
-            try:
-                response = await resp.json()
-                error = response["message"]
-            except Exception:
-                error = None
-
-            if resp.status == 400:
-                raise AuthenticationException(resp.status, error)
+        if resp.status == 200:
+            return
 
-            if resp.status == 401:
-                raise NotAuthorizedException(resp.status, error)
-
-            if resp.status == 403:
-                raise UserLockedException(resp.status, error)
+        try:
+            response = await resp.json()
+            error = response["message"]
+        except Exception:
+            error = None
 
-            if resp.status == 404:
-                raise ModuleNotFoundException(resp.status, error)
+        if resp.status == 400:
+            raise AuthenticationException(resp.status, error)
 
-            if resp.status == 503:
-                raise InternalCommunicationException(resp.status, error)
+        if resp.status == 401:
+            raise NotAuthorizedException(resp.status, error)
 
-            # we got an undocumented status code
-            raise ApiException(f"Unknown API response [{resp.status}] - {error}")
+        if resp.status == 403:
+            raise UserLockedException(resp.status, error)
 
-    @staticmethod
-    def _relogin(fn):
-        """Decorator for automatic re-login if session was expired."""
+        if resp.status == 404:
+            raise ModuleNotFoundException(resp.status, error)
 
-        @functools.wraps(fn)
-        async def _wrapper(self, *args, **kwargs):
-            try:
-                return await fn(self, *args, **kwargs)
-            except (AuthenticationException, NotAuthorizedException):
-                pass
+        if resp.status == 503:
+            raise InternalCommunicationException(resp.status, error)
 
-            _logger.debug("Request failed - try to re-login")
-            await self._login()
-            return await fn(self, *args, **kwargs)
-
-        return _wrapper
+        # we got an undocumented status code
+        raise ApiException(f"Unknown API response [{resp.status}] - {error}")
 
     async def logout(self):
         """Logs the current user out."""
@@ -422,7 +420,7 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
         if lang is None:
             lang = locale.getlocale()[0]
 
-        language = lang[0:2].lower()
+        language = lang[:2].lower()
         variant = lang[3:5].lower()
         if language not in ApiClient.SUPPORTED_LANGUAGES.keys():
             # Fallback to default
@@ -466,38 +464,33 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
         self,
         module_id: str,
         processdata_id: str,
-    ) -> Mapping[str, ProcessDataCollection]:
-        ...
+    ) -> Mapping[str, ProcessDataCollection]: ...
 
     @overload
     async def get_process_data_values(
         self,
         module_id: str,
         processdata_id: Iterable[str],
-    ) -> Mapping[str, ProcessDataCollection]:
-        ...
+    ) -> Mapping[str, ProcessDataCollection]: ...
 
     @overload
     async def get_process_data_values(
         self,
         module_id: str,
-    ) -> Mapping[str, ProcessDataCollection]:
-        ...
+    ) -> Mapping[str, ProcessDataCollection]: ...
 
     @overload
     async def get_process_data_values(
         self,
         module_id: Mapping[str, Iterable[str]],
-    ) -> Mapping[str, ProcessDataCollection]:
-        ...
+    ) -> Mapping[str, ProcessDataCollection]: ...
 
     @overload
     async def get_process_data_values(
         self,
         module_id: Union[str, Mapping[str, Iterable[str]]],
         processdata_id: Union[str, Iterable[str], None] = None,
-    ) -> Mapping[str, ProcessDataCollection]:
-        ...
+    ) -> Mapping[str, ProcessDataCollection]: ...
 
     @_relogin
     async def get_process_data_values(
@@ -523,7 +516,7 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
                 data_response = await resp.json()
                 return {
                     data_response[0]["moduleid"]: ProcessDataCollection(
-                        parse_obj_as(list[ProcessData], data_response[0]["processdata"])
+                        process_data_list(data_response[0]["processdata"])
                     )
                 }
 
@@ -536,7 +529,7 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
                 data_response = await resp.json()
                 return {
                     data_response[0]["moduleid"]: ProcessDataCollection(
-                        parse_obj_as(list[ProcessData], data_response[0]["processdata"])
+                        process_data_list(data_response[0]["processdata"])
                     )
                 }
 
@@ -552,7 +545,7 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
                 data_response = await resp.json()
                 return {
                     data_response[0]["moduleid"]: ProcessDataCollection(
-                        parse_obj_as(list[ProcessData], data_response[0]["processdata"])
+                        process_data_list(data_response[0]["processdata"])
                     )
                 }
 
@@ -562,7 +555,7 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
             for mid, pids in module_id.items():
                 # the json encoder expects that iterables are either list or tuples,
                 # other types has to be converted
-                if isinstance(pids, list) or isinstance(pids, tuple):
+                if isinstance(pids, (list, tuple)):
                     request.append(dict(moduleid=mid, processdataids=pids))
                 else:
                     request.append(dict(moduleid=mid, processdataids=list(pids)))
@@ -574,7 +567,7 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
                 data_response = await resp.json()
                 return {
                     x["moduleid"]: ProcessDataCollection(
-                        parse_obj_as(List[ProcessData], x["processdata"])
+                        process_data_list(x["processdata"])
                     )
                     for x in data_response
                 }
@@ -588,9 +581,9 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
             response = await resp.json()
             result: Dict[str, List[SettingsData]] = {}
             for module in response:
-                id = module["moduleid"]
-                data = list([SettingsData(**x) for x in module["settings"]])
-                result[id] = data
+                mid = module["moduleid"]
+                data = [SettingsData(**x) for x in module["settings"]]
+                result[mid] = data
 
             return result
 
@@ -599,30 +592,26 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
         self,
         module_id: str,
         setting_id: str,
-    ) -> Mapping[str, Mapping[str, str]]:
-        ...
+    ) -> Mapping[str, Mapping[str, str]]: ...
 
     @overload
     async def get_setting_values(
         self,
         module_id: str,
         setting_id: Iterable[str],
-    ) -> Mapping[str, Mapping[str, str]]:
-        ...
+    ) -> Mapping[str, Mapping[str, str]]: ...
 
     @overload
     async def get_setting_values(
         self,
         module_id: str,
-    ) -> Mapping[str, Mapping[str, str]]:
-        ...
+    ) -> Mapping[str, Mapping[str, str]]: ...
 
     @overload
     async def get_setting_values(
         self,
         module_id: Mapping[str, Iterable[str]],
-    ) -> Mapping[str, Mapping[str, str]]:
-        ...
+    ) -> Mapping[str, Mapping[str, str]]: ...
 
     @_relogin
     async def get_setting_values(
@@ -672,12 +661,11 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
             for mid, pids in module_id.items():
                 # the json encoder expects that iterables are either list or tuples,
                 # other types has to be converted
-                if isinstance(pids, list) or isinstance(pids, tuple):
+                if isinstance(pids, (list, tuple)):
                     request.append(dict(moduleid=mid, settingids=pids))
                 else:
                     request.append(dict(moduleid=mid, settingids=list(pids)))
 
-
             async with self._session_request(
                 "settings", method="POST", json=request
             ) as resp:
@@ -696,7 +684,7 @@ class ApiClient(contextlib.AbstractAsyncContextManager):
         request = [
             {
                 "moduleid": module_id,
-                "settings": list([dict(value=v, id=k) for k, v in values.items()]),
+                "settings": [dict(value=v, id=k) for k, v in values.items()],
             }
         ]
         async with self._session_request(

pykoplenti/cli.py

@@ -236,7 +236,7 @@ def read_events(global_args, lang, count):
         for event in data:
             print(
                 f"{event.is_active < 5} {event.start_time} {event.end_time} "
-                "{event.description}"
+                f"{event.description}"
             )
 
     asyncio.run(

pykoplenti/model.py

@@ -1,6 +1,7 @@
 from datetime import datetime
-from typing import Iterator, Mapping
+from typing import Final, Iterator, Mapping, Optional
 
+import pydantic
 from pydantic import BaseModel, Field
 
 
@@ -55,7 +56,7 @@ class ProcessDataCollection(Mapping):
         try:
             return next(x for x in self._process_data if x.id == item)
         except StopIteration:
-            raise KeyError(item)
+            raise KeyError(item) from None
 
     def __eq__(self, __other: object) -> bool:
         if not isinstance(__other, ProcessDataCollection):
@@ -77,11 +78,11 @@ class ProcessDataCollection(Mapping):
 class SettingsData(BaseModel):
     """Represents a single settings data."""
 
-    min: str | None
-    max: str | None
-    default: str | None
+    min: Optional[str]
+    max: Optional[str]
+    default: Optional[str]
     access: str
-    unit: str | None
+    unit: Optional[str]
     id: str
     type: str
 
@@ -97,3 +98,24 @@ class EventData(BaseModel):
     description: str
     group: str
     is_active: bool
+
+
+# pydantic version specific code
+# In pydantic 2.x `parse_obj_as` is no longer supported. To stay compatible to
+# both version a small wrapper function is used.
+
+if pydantic.VERSION.startswith("2."):
+    from pydantic import TypeAdapter
+
+    _process_list_adapter: Final = TypeAdapter(list[ProcessData])
+
+    def process_data_list(json) -> list[ProcessData]:
+        """Process json as a list of ProcessData objects."""
+        return _process_list_adapter.validate_python(json)
+
+else:
+    from pydantic import parse_obj_as
+
+    def process_data_list(json) -> list[ProcessData]:
+        """Process json as a list of ProcessData objects."""
+        return parse_obj_as(list[ProcessData], json)

{pykoplenti-1.2.1.dist-info → pykoplenti-1.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pykoplenti
-Version: 1.2.1
+Version: 1.3.0
 Summary: Python REST-Client for Kostal Plenticore Solar Inverters
 Home-page: https://github.com/stegm/pyclient_koplenti
 Author: @stegm
@@ -13,14 +13,16 @@ Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aiohttp ~=3.8.5
+Requires-Dist: aiohttp ~=3.8
 Requires-Dist: pycryptodome ~=3.19
-Requires-Dist: pydantic ~=1.10
+Requires-Dist: pydantic >=1.10
 Provides-Extra: cli
 Requires-Dist: prompt-toolkit >=3.0 ; extra == 'cli'
 Requires-Dist: click >=7.1 ; extra == 'cli'
@@ -147,6 +149,7 @@ await client.login(my_master_key, service_code=my_service_code)
 - [Command Line Interface](doc/command_line.md)
 - [Examples](examples/)
 - [Virtual Process Data](doc/virtual_process_data.md)
+- [Notes about Process Data](doc/process_data.md)
 
 ## Built With
 
@@ -154,9 +157,11 @@ await client.login(my_master_key, service_code=my_service_code)
 - [click](https://click.palletsprojects.com/) - command line interface framework
 - [black](https://github.com/psf/black) - Python code formatter
 - [ruff](https://github.com/astral-sh/ruff) - Python linter
+- [pydantic](https://docs.pydantic.dev/latest/) - Data validation library
 - [pytest](https://docs.pytest.org/) - Python test framework
 - [mypy](https://mypy-lang.org/) - Python type checker
 - [setuptools](https://github.com/pypa/setuptools) - Python packager
+- [tox](https://tox.wiki) - Automate testing
 
 ## License
 

pykoplenti-1.3.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+pykoplenti/__init__.py,sha256=w9ooy6_JaT9lGvMDAaBHyvYu1uTFTkb1g21WRxp3Kzw,756
+pykoplenti/api.py,sha256=ViT25KQt3caH78fO30G014IawcWQ1lMvy28M9QLBypg,26111
+pykoplenti/cli.py,sha256=KIgpQ1QdM9_nz7S-oQpfpU6ov3o8N8tobw9_R4X0_Nw,12973
+pykoplenti/extended.py,sha256=_MCDtP-6BaAiTFqJ44CLK_Ihkh6nCC0vWWv1lsQfEFs,9311
+pykoplenti/model.py,sha256=lFOHDJvWyhOdQrcoun6HeT-4XaGY5I2gy1j6M5u3u6A,3016
+pykoplenti/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pykoplenti-1.3.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pykoplenti-1.3.0.dist-info/METADATA,sha256=llPxFNe-fpRJN5cIrWt-T2EOT3PpCt1T_BqQUZw4kI8,5847
+pykoplenti-1.3.0.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
+pykoplenti-1.3.0.dist-info/entry_points.txt,sha256=Ix-p1uzKNyOMTK0TOlAC0nsfWS6ATXVuaNDJ5-TwBJw,56
+pykoplenti-1.3.0.dist-info/top_level.txt,sha256=Bi915FGIFYzCujwn5Kwhu3B-sxElgc7gX3gNaYjl4j8,11
+pykoplenti-1.3.0.dist-info/RECORD,,

{pykoplenti-1.2.1.dist-info → pykoplenti-1.3.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.41.3)
+Generator: setuptools (75.5.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

pykoplenti-1.2.1.dist-info/RECORD

@@ -1,12 +0,0 @@
-pykoplenti/__init__.py,sha256=w9ooy6_JaT9lGvMDAaBHyvYu1uTFTkb1g21WRxp3Kzw,756
-pykoplenti/api.py,sha256=gYWWd8yZ9winj7qPt1-rzx4stX_DLPfy5nOduuamtH4,26431
-pykoplenti/cli.py,sha256=LAiQHlSgoJz07kTtFh0bNyahyYz7gCenhRfradex5wE,12972
-pykoplenti/extended.py,sha256=_MCDtP-6BaAiTFqJ44CLK_Ihkh6nCC0vWWv1lsQfEFs,9311
-pykoplenti/model.py,sha256=g-KyYTF1M1p6OAebyA74OAP_-561u6Hylhgy_jnpMto,2266
-pykoplenti/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pykoplenti-1.2.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-pykoplenti-1.2.1.dist-info/METADATA,sha256=ztvYvxRUUOWJYIbUJ4icUf1X14C_55BJMoA6GiN3ABI,5577
-pykoplenti-1.2.1.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
-pykoplenti-1.2.1.dist-info/entry_points.txt,sha256=Ix-p1uzKNyOMTK0TOlAC0nsfWS6ATXVuaNDJ5-TwBJw,56
-pykoplenti-1.2.1.dist-info/top_level.txt,sha256=Bi915FGIFYzCujwn5Kwhu3B-sxElgc7gX3gNaYjl4j8,11
-pykoplenti-1.2.1.dist-info/RECORD,,