Fix linting, type errors, use asyncio.gather, and improve test assertions

Agent-Logs-Url: https://github.com/iMicknl/python-overkiz-api/sessions/780a5262-1b4d-44e0-86b6-7720038d3cb7

Co-authored-by: iMicknl <1424596+iMicknl@users.noreply.github.com>

Author: Copilot

docs/superpowers/plans/2026-04-24-diagnostics.md

@@ -4,7 +4,7 @@
 
 **Goal:** Expand `get_diagnostic_data()` to return a structured dict containing both setup and action group data, with per-section obfuscation.
 
-**Architecture:** The method fetches two API endpoints (`setup` and `actionGroups`) concurrently, wraps them in a `{"setup": ..., "action_groups": [...]}` dict, and applies `obfuscate_sensitive_data` to each section individually. The obfuscation function is extended to accept lists of dicts in addition to plain dicts.
+**Architecture:** The method fetches two API endpoints (`setup` and `actionGroups`) concurrently using `asyncio.gather`, wraps them in a `{"setup": ..., "action_groups": [...]}` dict, and applies `obfuscate_sensitive_data` to each section individually. The obfuscation function is extended to accept lists of dicts in addition to plain dicts.
 
 **Tech Stack:** Python 3.12+, aiohttp, pytest, pytest-asyncio
 

pyoverkiz/client.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+import asyncio
 import logging
 import ssl
 import urllib.parse
@@ -329,7 +330,9 @@ async def get_setup(self, refresh: bool = False) -> Setup:
         return setup
 
     @retry_on_auth_error
-    async def get_diagnostic_data(self, mask_sensitive_data: bool = True) -> dict[str, Any]:
+    async def get_diagnostic_data(
+        self, mask_sensitive_data: bool = True
+    ) -> dict[str, Any]:
         """Get diagnostic data for the connected user setup.
 
             -> gateways data (serial number, activation state, ...): <gateways/gateway>
@@ -341,8 +344,10 @@ async def get_diagnostic_data(self, mask_sensitive_data: bool = True) -> dict[st
         By default, this data is masked to not return confidential or PII data.
         Set `mask_sensitive_data` to `False` to return the raw payloads.
         """
-        setup = await self._get("setup")
-        action_groups = await self._get("actionGroups")
+        setup, action_groups = await asyncio.gather(
+            self._get("setup"),
+            self._get("actionGroups"),
+        )
 
         if mask_sensitive_data:
             setup = obfuscate_sensitive_data(setup)

pyoverkiz/obfuscate.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 import re
-from typing import Any
+from typing import Any, cast
 
 
 def obfuscate_id(id: str | None) -> str:
@@ -27,7 +27,9 @@ def obfuscate_sensitive_data(
 ) -> dict[str, Any] | list[dict[str, Any]]:
     """Mask Overkiz JSON data to remove sensitive data."""
     if isinstance(data, list):
-        return [obfuscate_sensitive_data(item) for item in data]
+        return cast(
+            list[dict[str, Any]], [obfuscate_sensitive_data(item) for item in data]
+        )
 
     mask_next_value = False
 

tests/test_client.py

@@ -305,14 +305,21 @@ async def test_get_diagnostic_data(self, client: OverkizClient, fixture_name: st
         ) as setup_mock:
             setup_resp = MockResponse(setup_mock.read())
 
-        with (CURRENT_DIR / "fixtures" / "action_groups" / "action-group-tahoma-switch.json").open(
+        with (
+            CURRENT_DIR
+            / "fixtures"
+            / "action_groups"
+            / "action-group-tahoma-switch.json"
+        ).open(
             encoding="utf-8",
         ) as ag_mock:
             ag_resp = MockResponse(ag_mock.read())
 
         responses = iter([setup_resp, ag_resp])
 
-        with patch.object(aiohttp.ClientSession, "get", side_effect=lambda *a, **kw: next(responses)):
+        with patch.object(
+            aiohttp.ClientSession, "get", side_effect=lambda *a, **kw: next(responses)
+        ):
             diagnostics = await client.get_diagnostic_data()
             assert diagnostics
             assert "setup" in diagnostics
@@ -326,26 +333,36 @@ async def test_get_diagnostic_data_redacted_by_default(self, client: OverkizClie
         ) as setup_mock:
             setup_resp = MockResponse(setup_mock.read())
 
-        with (CURRENT_DIR / "fixtures" / "action_groups" / "action-group-tahoma-switch.json").open(
+        with (
+            CURRENT_DIR
+            / "fixtures"
+            / "action_groups"
+            / "action-group-tahoma-switch.json"
+        ).open(
             encoding="utf-8",
         ) as ag_mock:
             ag_resp = MockResponse(ag_mock.read())
 
         responses = iter([setup_resp, ag_resp])
 
         with (
-            patch.object(aiohttp.ClientSession, "get", side_effect=lambda *a, **kw: next(responses)),
+            patch.object(
+                aiohttp.ClientSession,
+                "get",
+                side_effect=lambda *a, **kw: next(responses),
+            ),
             patch(
                 "pyoverkiz.client.obfuscate_sensitive_data",
-                return_value={"masked": True},
+                side_effect=[{"masked": True}, [{"masked": True}]],
             ) as obfuscate,
         ):
             diagnostics = await client.get_diagnostic_data()
             assert diagnostics == {
                 "setup": {"masked": True},
-                "action_groups": {"masked": True},
+                "action_groups": [{"masked": True}],
             }
             assert obfuscate.call_count == 2
+            assert isinstance(diagnostics["action_groups"], list)
 
     @pytest.mark.asyncio
     async def test_get_diagnostic_data_without_masking(self, client: OverkizClient):
@@ -356,7 +373,12 @@ async def test_get_diagnostic_data_without_masking(self, client: OverkizClient):
             raw_setup = setup_mock.read()
             setup_resp = MockResponse(raw_setup)
 
-        with (CURRENT_DIR / "fixtures" / "action_groups" / "action-group-tahoma-switch.json").open(
+        with (
+            CURRENT_DIR
+            / "fixtures"
+            / "action_groups"
+            / "action-group-tahoma-switch.json"
+        ).open(
             encoding="utf-8",
         ) as ag_mock:
             raw_ag = ag_mock.read()
@@ -365,7 +387,11 @@ async def test_get_diagnostic_data_without_masking(self, client: OverkizClient):
         responses = iter([setup_resp, ag_resp])
 
         with (
-            patch.object(aiohttp.ClientSession, "get", side_effect=lambda *a, **kw: next(responses)),
+            patch.object(
+                aiohttp.ClientSession,
+                "get",
+                side_effect=lambda *a, **kw: next(responses),
+            ),
             patch("pyoverkiz.client.obfuscate_sensitive_data") as obfuscate,
         ):
             diagnostics = await client.get_diagnostic_data(mask_sensitive_data=False)
@@ -376,21 +402,30 @@ async def test_get_diagnostic_data_without_masking(self, client: OverkizClient):
             obfuscate.assert_not_called()
 
     @pytest.mark.asyncio
-    async def test_get_diagnostic_data_returns_structured_dict(self, client: OverkizClient):
+    async def test_get_diagnostic_data_returns_structured_dict(
+        self, client: OverkizClient
+    ):
         """Verify diagnostic data returns a dict with setup and action_groups sections."""
         with (CURRENT_DIR / "fixtures" / "setup" / "setup_tahoma_1.json").open(
             encoding="utf-8",
         ) as setup_mock:
             setup_resp = MockResponse(setup_mock.read())
 
-        with (CURRENT_DIR / "fixtures" / "action_groups" / "action-group-tahoma-switch.json").open(
+        with (
+            CURRENT_DIR
+            / "fixtures"
+            / "action_groups"
+            / "action-group-tahoma-switch.json"
+        ).open(
             encoding="utf-8",
         ) as ag_mock:
             ag_resp = MockResponse(ag_mock.read())
 
         responses = iter([setup_resp, ag_resp])
 
-        with patch.object(aiohttp.ClientSession, "get", side_effect=lambda *a, **kw: next(responses)):
+        with patch.object(
+            aiohttp.ClientSession, "get", side_effect=lambda *a, **kw: next(responses)
+        ):
             diagnostics = await client.get_diagnostic_data(mask_sensitive_data=False)
 
         assert "setup" in diagnostics