Fixed Compatiblity Issues with Python 3.9 (#18)

According to #17, the code does not work with Python 3.9. I have updated tox to include 3.9 and also 3.12. I dropped 3.8 because it never worked and support for python will end in October 2024.

This PR contains code changes to make it compatible with 3.9. Most of the changes fix the new typing syntax. In api.py, the decorator for re-login needs to be moved to a function instead of a static method.

- Updated testing environment (tox and github).
- Fixed compatibility issues with Python 3.9.
- Added tox path to gitignore.
- Updated README with tox information.

.github/workflows/ci.yaml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
 
     steps:
       - uses: actions/checkout@v2
@@ -36,7 +36,7 @@ jobs:
         run: |
           pipenv run build
       - name: Upload packages to github
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: dist
           path: dist/*

.gitignore

@@ -4,6 +4,7 @@ __pycache__
 *.egg-info
 build/
 dist/
+.tox/
 pip-wheel-metadata/
 .env.local
 coverage.xml

doc/developer.md

@@ -25,8 +25,17 @@ tox
 
 Available environments:
 
+* `py39-pydantic1` - Python 3.9 with Pydantic 1.x
+* `py39-pydantic2` - Python 3.9 with Pydantic 2.x
 * `py310-pydantic1` - Python 3.10 with Pydantic 1.x
 * `py310-pydantic2` - Python 3.10 with Pydantic 2.x
+* `py311-pydantic1` - Python 3.11 with Pydantic 1.x
+* `py311-pydantic2` - Python 3.11 with Pydantic 2.x
+* `py312-pydantic1` - Python 3.12 with Pydantic 1.x
+* `py312-pydantic2` - Python 3.12 with Pydantic 2.x
+
+If `tox` should use `pyenv`, the package `tox-pyenv-redux` must be installed manually.
+It cannot be installed in pipenv dev, because it is incompatible with github actions.
 
 ## Running smoke tests
 

pykoplenti/api.py

@@ -85,6 +85,20 @@ def __init__(self, status_code: int, error: str):
         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.
 
@@ -369,20 +383,6 @@ async def _check_response(self, resp: ClientResponse):
         # we got an undocumented status code
         raise ApiException(f"Unknown API response [{resp.status}] - {error}")
 
-    @staticmethod
-    def _relogin(fn):
-        """Decorator for automatic re-login if session was expired."""
-
-        @functools.wraps(fn)
-        async def _wrapper(self, *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
-
     async def logout(self):
         """Logs the current user out."""
         self._key = None

pykoplenti/model.py

@@ -1,5 +1,5 @@
 from datetime import datetime
-from typing import Final, Iterator, Mapping
+from typing import Final, Iterator, Mapping, Optional
 
 import pydantic
 from pydantic import BaseModel, Field
@@ -78,11 +78,11 @@ def __repr__(self):
 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
 

setup.cfg

@@ -17,8 +17,10 @@ classifiers =
     Intended Audience :: Developers
     License :: OSI Approved :: Apache Software License
     Programming Language :: Python :: 3
-    Programming Language :: Python :: 3.7
-    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
+    Programming Language :: Python :: 3.11
+    Programming Language :: Python :: 3.12
     Topic :: Software Development :: Libraries
 
 [options]

tests/conftest.py

@@ -1,4 +1,4 @@
-from typing import Any, Callable
+from typing import Any, Callable, Union
 from unittest.mock import AsyncMock, MagicMock
 
 from aiohttp import ClientResponse, ClientSession
@@ -30,7 +30,7 @@ def client_response_factory(
 ) -> Callable[[int, Any], MagicMock]:
     """Provides a factory to add responses to a ClientSession."""
 
-    def factory(status: int = 200, json: list[Any] | dict[Any, Any] | None = None):
+    def factory(status: int = 200, json: Union[list[Any], dict[Any, Any], None] = None):
         response = MagicMock(spec_set=ClientResponse, name="request Mock")
         response.status = status
         if json is not None:

tests/test_extendedapiclient.py

@@ -1,4 +1,4 @@
-from typing import Any, Callable, Iterable
+from typing import Any, Callable, Iterable, Union
 from unittest.mock import ANY, MagicMock, call
 
 import pytest
@@ -40,7 +40,9 @@ class TestVirtualProcessDataValuesDcSum:
     async def test_virtual_process_data(
         self,
         pykoplenti_extended_client: pykoplenti.ExtendedApiClient,
-        client_response_factory: Callable[[int, list[Any] | dict[Any, Any]], MagicMock],
+        client_response_factory: Callable[
+            [int, Union[list[Any], dict[Any, Any]]], MagicMock
+        ],
         websession: MagicMock,
     ):
         """Test virtual process data for PV power if depencies are present."""
@@ -70,7 +72,9 @@ async def test_virtual_process_data(
     async def test_virtual_process_data_value(
         self,
         pykoplenti_extended_client: pykoplenti.ExtendedApiClient,
-        client_response_factory: Callable[[int, list[Any] | dict[Any, Any]], MagicMock],
+        client_response_factory: Callable[
+            [int, Union[list[Any], dict[Any, Any]]], MagicMock
+        ],
         websession: MagicMock,
     ):
         """Test virtual process data for PV power."""
@@ -142,7 +146,9 @@ class TestVirtualProcessDataValuesEnergyToGrid:
     async def test_virtual_process_data(
         self,
         pykoplenti_extended_client: pykoplenti.ExtendedApiClient,
-        client_response_factory: Callable[[int, list[Any] | dict[Any, Any]], MagicMock],
+        client_response_factory: Callable[
+            [int, Union[list[Any], dict[Any, Any]]], MagicMock
+        ],
         websession: MagicMock,
         scope: str,
     ):
@@ -183,7 +189,9 @@ async def test_virtual_process_data(
     async def test_virtual_process_data_value(
         self,
         pykoplenti_extended_client: pykoplenti.ExtendedApiClient,
-        client_response_factory: Callable[[int, list[Any] | dict[Any, Any]], MagicMock],
+        client_response_factory: Callable[
+            [int, Union[list[Any], dict[Any, Any]]], MagicMock
+        ],
         websession: MagicMock,
         scope: str,
     ):
@@ -269,10 +277,12 @@ async def test_virtual_process_data_value(
 @pytest.mark.asyncio
 async def test_virtual_process_data_no_dc_sum(
     pykoplenti_extended_client: pykoplenti.ExtendedApiClient,
-    client_response_factory: Callable[[int, list[Any] | dict[Any, Any]], MagicMock],
+    client_response_factory: Callable[
+        [int, Union[list[Any], dict[Any, Any]]], MagicMock
+    ],
     websession: MagicMock,
 ):
-    """Test if no virtual process data is present if dependecies are missing."""
+    """Test if no virtual process data is present if dependencies are missing."""
     client_response_factory(
         200,
         [
@@ -297,7 +307,9 @@ async def test_virtual_process_data_no_dc_sum(
 @pytest.mark.asyncio
 async def test_virtual_process_data_and_normal_process_data(
     pykoplenti_extended_client: pykoplenti.ExtendedApiClient,
-    client_response_factory: Callable[[int, list[Any] | dict[Any, Any]], MagicMock],
+    client_response_factory: Callable[
+        [int, Union[list[Any], dict[Any, Any]]], MagicMock
+    ],
     websession: MagicMock,
 ):
     """Test if virtual and non-virtual process values can be requested."""
@@ -362,7 +374,9 @@ async def test_virtual_process_data_and_normal_process_data(
 @pytest.mark.asyncio
 async def test_virtual_process_data_not_all_requested(
     pykoplenti_extended_client: pykoplenti.ExtendedApiClient,
-    client_response_factory: Callable[[int, list[Any] | dict[Any, Any]], MagicMock],
+    client_response_factory: Callable[
+        [int, Union[list[Any], dict[Any, Any]]], MagicMock
+    ],
     websession: MagicMock,
 ):
     """Test if not all available virtual process data are requested."""
@@ -429,7 +443,9 @@ async def test_virtual_process_data_not_all_requested(
 @pytest.mark.asyncio
 async def test_virtual_process_data_multiple_requested(
     pykoplenti_extended_client: pykoplenti.ExtendedApiClient,
-    client_response_factory: Callable[[int, list[Any] | dict[Any, Any]], MagicMock],
+    client_response_factory: Callable[
+        [int, Union[list[Any], dict[Any, Any]]], MagicMock
+    ],
     websession: MagicMock,
 ):
     """Test if multiple virtual process data are requested."""

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py3{10,11}-pydantic{1,2}
+envlist = py3{9,10,11,12}-pydantic{1,2}
 
 [testenv]
 description = Executes pytest