pykoplenti 1.2.2__tar.gz → 1.4.0__tar.gz

{pykoplenti-1.2.2 → pykoplenti-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: pykoplenti
-Version: 1.2.2
+Version: 1.4.0
 Summary: Python REST-Client for Kostal Plenticore Solar Inverters
 Home-page: https://github.com/stegm/pyclient_koplenti
 Author: @stegm
@@ -13,17 +13,20 @@ 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
 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"
+Requires-Dist: click>=8.0; extra == "cli"
+Dynamic: license-file
 
 # Python Library for Accessing Kostal Plenticore Inverters
 
@@ -75,22 +78,28 @@ Installing the libray with `CLI` provides a new command.
 
 ```shell
 $ pykoplenti --help
-Usage: pykoplenti [OPTIONS] COMMAND [ARGS]...
+Usage: python -m pykoplenti.cli [OPTIONS] COMMAND [ARGS]...
 
   Handling of global arguments with click
 
 Options:
-  --host TEXT           hostname or ip of the inverter
-  --port INTEGER        port of the inverter (default 80)
-  --password TEXT       the password
-  --password-file TEXT  password file (default "secrets" in the current
-                        working directory)
-
+  --host TEXT           Hostname or IP of the inverter
+  --port INTEGER        Port of the inverter  [default: 80]
+  --password TEXT       Password or master key (also device id)
+  --service-code TEXT   service code for installer access
+  --password-file FILE  Path to password file - deprecated, use --credentials
+                        [default: secrets]
+  --credentials FILE    Path to the credentials file. This has a simple ini-
+                        format without sections. For user access, use the
+                        'password'. For installer access, use the 'master-key'
+                        and 'service-key'.
   --help                Show this message and exit.
 
 Commands:
   all-processdata   Returns a list of all available process data.
   all-settings      Returns the ids of all settings.
+  download-log      Download the log data from the inverter to a file.
+  read-events       Returns the last events
   read-processdata  Returns the values of the given process data.
   read-settings     Read the value of the given settings.
   repl              Provides a simple REPL for executing API requests to...
@@ -155,9 +164,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.2.2 → pykoplenti-1.4.0}/README.md

@@ -48,22 +48,28 @@ Installing the libray with `CLI` provides a new command.
 
 ```shell
 $ pykoplenti --help
-Usage: pykoplenti [OPTIONS] COMMAND [ARGS]...
+Usage: python -m pykoplenti.cli [OPTIONS] COMMAND [ARGS]...
 
   Handling of global arguments with click
 
 Options:
-  --host TEXT           hostname or ip of the inverter
-  --port INTEGER        port of the inverter (default 80)
-  --password TEXT       the password
-  --password-file TEXT  password file (default "secrets" in the current
-                        working directory)
-
+  --host TEXT           Hostname or IP of the inverter
+  --port INTEGER        Port of the inverter  [default: 80]
+  --password TEXT       Password or master key (also device id)
+  --service-code TEXT   service code for installer access
+  --password-file FILE  Path to password file - deprecated, use --credentials
+                        [default: secrets]
+  --credentials FILE    Path to the credentials file. This has a simple ini-
+                        format without sections. For user access, use the
+                        'password'. For installer access, use the 'master-key'
+                        and 'service-key'.
   --help                Show this message and exit.
 
 Commands:
   all-processdata   Returns a list of all available process data.
   all-settings      Returns the ids of all settings.
+  download-log      Download the log data from the inverter to a file.
+  read-events       Returns the last events
   read-processdata  Returns the values of the given process data.
   read-settings     Read the value of the given settings.
   repl              Provides a simple REPL for executing API requests to...
@@ -128,9 +134,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.2.2 → pykoplenti-1.4.0}/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(