Fix Python model for Local API (id = None) (#1974)

Fixes #1183

Author: iMicknl

docs/getting-started.md

@@ -72,7 +72,7 @@ Use a cloud server when you want to connect through the vendor’s public API. U
 
     async def main() -> None:
         async with OverkizClient(
-            server=create_local_server_config(host="gateway-xxxx-xxxx-xxxx.local"),
+            server=create_local_server_config(host="gateway-xxxx-xxxx-xxxx.local:8443"),
             credentials=LocalTokenCredentials("token-from-your-mobile-app"),
             verify_ssl=True, # disable if you connect via IP
         ) as client:

pyoverkiz/models.py

@@ -46,7 +46,7 @@ class Setup:
 
     creation_time: int | None = None
     last_update_time: int | None = None
-    id: str = field(repr=obfuscate_id, default=None)
+    id: str | None = field(repr=obfuscate_id, default=None)
     location: Location | None = None
     gateways: list[Gateway]
     devices: list[Device]
@@ -61,7 +61,7 @@ def __init__(
         *,
         creation_time: int | None = None,
         last_update_time: int | None = None,
-        id: str = field(repr=obfuscate_id, default=None),
+        id: str | None = None,
         location: dict[str, Any] | None = None,
         gateways: list[dict[str, Any]],
         devices: list[dict[str, Any]],

tests/test_client.py

@@ -275,6 +275,9 @@ async def test_get_setup(
             assert len(setup.devices) == device_count
             assert len(setup.gateways) == gateway_count
 
+            if fixture_name.startswith("setup_local"):
+                assert setup.id is None
+
             for device in setup.devices:
                 assert device.identifier.gateway_id
                 assert device.identifier.device_address

tests/test_models.py

@@ -2,6 +2,9 @@
 
 from __future__ import annotations
 
+import json
+from pathlib import Path
+
 import humps
 import pytest
 
@@ -11,10 +14,12 @@
     Definition,
     Device,
     EventState,
+    Setup,
     State,
     StateDefinition,
     States,
 )
+from pyoverkiz.obfuscate import obfuscate_id
 
 RAW_STATES = [
     {"name": "core:NameState", "type": 3, "value": "alarm name"},
@@ -71,6 +76,39 @@
 }
 
 STATE = "core:NameState"
+FIXTURES_DIR = Path(__file__).resolve().parent / "fixtures" / "setup"
+
+
+class TestSetup:
+    """Tests for setup-level ID parsing and redaction behavior."""
+
+    def test_id_is_raw_but_repr_is_redacted_when_present(self):
+        """When API provides `id`, keep raw value but redact it in repr output."""
+        raw_setup = json.loads(
+            (FIXTURES_DIR / "setup_tahoma_1.json").read_text(encoding="utf-8")
+        )
+        setup = Setup(**humps.decamelize(raw_setup))
+        raw_id = "SETUP-1234-1234-8044"
+        redacted_id = obfuscate_id(raw_id)
+
+        assert setup.id == raw_id
+        assert redacted_id in repr(setup)
+        assert raw_id not in repr(setup)
+
+    def test_id_is_none_when_missing(self):
+        """When API omits `id`, setup.id should stay None."""
+        raw_setup = json.loads(
+            (FIXTURES_DIR / "setup_local.json").read_text(encoding="utf-8")
+        )
+        setup = Setup(**humps.decamelize(raw_setup))
+
+        assert setup.id is None
+
+    def test_id_is_none_without_input_id(self):
+        """Constructing setup without an id keeps setup.id as None."""
+        setup = Setup(gateways=[], devices=[])
+
+        assert setup.id is None
 
 
 class TestDevice: