python-oa3-client 0.1.0__tar.gz → 0.2.0__tar.gz

python_oa3_client-0.2.0/.github/workflows/lint.yml

@@ -0,0 +1,18 @@
+name: Lint
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        with:
+          python-version: "3.12"
+      - run: pip install "ruff>=0.15.0"
+      - run: ruff check src tests
+      - run: ruff format --check src tests

python_oa3_client-0.2.0/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.6
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

{python_oa3_client-0.1.0 → python_oa3_client-0.2.0}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: python-oa3-client
-Version: 0.1.0
+Version: 0.2.0
 Summary: OpenADR 3 companion client with VEN registration, MQTT notifications, and lifecycle management
-Project-URL: Homepage, https://github.com/grid-coordination/python-oa3-client
+Project-URL: Homepage, https://grid-coordination.energy
 Project-URL: Repository, https://github.com/grid-coordination/python-oa3-client
 Project-URL: Issues, https://github.com/grid-coordination/python-oa3-client/issues
 Author: Grid-Coordination Contributors
@@ -28,6 +28,7 @@ Provides-Extra: dev
 Requires-Dist: ebus-mqtt-client>=0.1.0; extra == 'dev'
 Requires-Dist: flask>=3.0.0; extra == 'dev'
 Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff>=0.15.0; extra == 'dev'
 Requires-Dist: zeroconf>=0.131.0; extra == 'dev'
 Provides-Extra: mdns
 Requires-Dist: zeroconf>=0.131.0; extra == 'mdns'

{python_oa3_client-0.1.0 → python_oa3_client-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "python-oa3-client"
-version = "0.1.0"
+version = "0.2.0"
 description = "OpenADR 3 companion client with VEN registration, MQTT notifications, and lifecycle management"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -33,10 +33,10 @@ mqtt = ["ebus-mqtt-client>=0.1.0"]
 webhooks = ["flask>=3.0.0"]
 mdns = ["zeroconf>=0.131.0"]
 all = ["ebus-mqtt-client>=0.1.0", "flask>=3.0.0", "zeroconf>=0.131.0"]
-dev = ["pytest", "ebus-mqtt-client>=0.1.0", "flask>=3.0.0", "zeroconf>=0.131.0"]
+dev = ["pytest", "ruff>=0.15.0", "ebus-mqtt-client>=0.1.0", "flask>=3.0.0", "zeroconf>=0.131.0"]
 
 [project.urls]
-Homepage = "https://github.com/grid-coordination/python-oa3-client"
+Homepage = "https://grid-coordination.energy"
 Repository = "https://github.com/grid-coordination/python-oa3-client"
 Issues = "https://github.com/grid-coordination/python-oa3-client/issues"
 
@@ -51,3 +51,26 @@ exclude = [
     ".beads/",
     "examples/",
 ]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+extend-exclude = [".beads", "examples"]
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "B",   # flake8-bugbear
+    "UP",  # pyupgrade
+    "SIM", # flake8-simplify
+]
+ignore = [
+    "E501", # line-too-long (handled by formatter)
+    "B008", # do not perform function calls in argument defaults
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["B011"]  # allow assert False in tests

{python_oa3_client-0.1.0 → python_oa3_client-0.2.0}/src/openadr3_client/__init__.py

@@ -1,19 +1,19 @@
 from openadr3_client.base import BaseClient
-from openadr3_client.ven import VenClient, extract_topics
 from openadr3_client.bl import BlClient
-from openadr3_client.notifications import (
-    MqttChannel,
-    NotificationChannel,
-    WebhookChannel,
-)
-from openadr3_client.mqtt import MQTTConnection, MQTTMessage, normalize_broker_uri
-from openadr3_client.webhook import WebhookReceiver, WebhookMessage, detect_lan_ip
 from openadr3_client.discovery import (
     DiscoveredVTN,
     DiscoveryMode,
     advertise_vtn,
     discover_vtns,
 )
+from openadr3_client.mqtt import MQTTConnection, MQTTMessage, normalize_broker_uri
+from openadr3_client.notifications import (
+    MqttChannel,
+    NotificationChannel,
+    WebhookChannel,
+)
+from openadr3_client.ven import VenClient, extract_topics
+from openadr3_client.webhook import WebhookMessage, WebhookReceiver, detect_lan_ip
 
 __all__ = [
     # Clients

{python_oa3_client-0.1.0 → python_oa3_client-0.2.0}/src/openadr3_client/base.py

@@ -73,12 +73,15 @@ class BaseClient:
         if self._api:
             log.info(
                 "%s already started: url=%s",
-                type(self).__name__, self._resolved_url,
+                type(self).__name__,
+                self._resolved_url,
             )
             return self
 
         self._resolved_url = resolve_url(
-            self.discovery_mode, self.url, self.discovery_timeout,
+            self.discovery_mode,
+            self.url,
+            self.discovery_timeout,
         )
 
         if not self.token:
@@ -98,7 +101,9 @@ class BaseClient:
         )
         log.info(
             "%s started: type=%s url=%s",
-            type(self).__name__, self._client_type, self._resolved_url,
+            type(self).__name__,
+            self._client_type,
+            self._resolved_url,
         )
         return self
 
@@ -120,9 +125,7 @@ class BaseClient:
     def api(self) -> OpenADRClient:
         """The underlying OpenADRClient. Raises if not started."""
         if not self._api:
-            raise RuntimeError(
-                f"{type(self).__name__} not started. Call start() first."
-            )
+            raise RuntimeError(f"{type(self).__name__} not started. Call start() first.")
         return self._api
 
     # -- __getattr__ delegation --
@@ -136,6 +139,4 @@ class BaseClient:
                 return getattr(api, name)
             except AttributeError:
                 pass
-        raise AttributeError(
-            f"'{type(self).__name__}' object has no attribute '{name}'"
-        )
+        raise AttributeError(f"'{type(self).__name__}' object has no attribute '{name}'")

{python_oa3_client-0.1.0 → python_oa3_client-0.2.0}/src/openadr3_client/discovery.py

@@ -11,7 +11,7 @@ from __future__ import annotations
 
 import logging
 import threading
-from dataclasses import dataclass, field
+from dataclasses import dataclass
 from enum import Enum
 from typing import Any
 
@@ -71,8 +71,10 @@ class DiscoveredVTN:
         """Build from a ``zeroconf.ServiceInfo`` object."""
         props = _parse_txt_properties(info.properties or {})
         # Prefer .server (the .local hostname) over parsed addresses
-        host = info.server.rstrip(".") if info.server else (
-            info.parsed_addresses()[0] if info.parsed_addresses() else "localhost"
+        host = (
+            info.server.rstrip(".")
+            if info.server
+            else (info.parsed_addresses()[0] if info.parsed_addresses() else "localhost")
         )
         return cls(
             name=info.name,
@@ -91,6 +93,7 @@ def _import_zeroconf():
     """Lazy-import zeroconf with a helpful error message."""
     try:
         import zeroconf  # noqa: F811
+
         return zeroconf
     except ImportError:
         raise ImportError(
@@ -157,9 +160,7 @@ def resolve_url(
 
     if mode == DiscoveryMode.REQUIRE_LOCAL:
         if not discovered_url:
-            raise RuntimeError(
-                "discovery='require_local' but no VTN found via mDNS"
-            )
+            raise RuntimeError("discovery='require_local' but no VTN found via mDNS")
         return discovered_url
 
     if mode == DiscoveryMode.PREFER_LOCAL:
@@ -167,9 +168,7 @@ def resolve_url(
             return discovered_url
         if configured_url:
             return configured_url
-        raise RuntimeError(
-            "discovery='prefer_local': no VTN found via mDNS and no url configured"
-        )
+        raise RuntimeError("discovery='prefer_local': no VTN found via mDNS and no url configured")
 
     # LOCAL_WITH_FALLBACK
     if discovered_url:
@@ -241,9 +240,7 @@ def advertise_vtn(
         server=f"{host}.",
         port=port,
         properties=properties,
-        addresses=[socket.inet_aton(
-            "127.0.0.1" if host in ("localhost", "127.0.0.1") else host
-        )],
+        addresses=[socket.inet_aton("127.0.0.1" if host in ("localhost", "127.0.0.1") else host)],
     )
 
     zc = Zeroconf()

{python_oa3_client-0.1.0 → python_oa3_client-0.2.0}/src/openadr3_client/mqtt.py

@@ -9,15 +9,18 @@ from __future__ import annotations
 
 import json
 import logging
-import re
 import threading
 import time
-from dataclasses import dataclass, field
-from typing import Any, Callable
+from collections.abc import Callable
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, Any
 from urllib.parse import urlparse
 
 from openadr3.entities import coerce_notification, is_notification
 
+if TYPE_CHECKING:
+    from ebus_mqtt_client import MqttClient
+
 log = logging.getLogger(__name__)
 
 
@@ -54,9 +57,7 @@ def _parse_payload(raw: bytes, topic: str) -> Any:
         return s
 
     if isinstance(parsed, dict) and is_notification(parsed):
-        return coerce_notification(
-            parsed, {"openadr/channel": "mqtt", "openadr/topic": topic}
-        )
+        return coerce_notification(parsed, {"openadr/channel": "mqtt", "openadr/topic": topic})
     return parsed
 
 
@@ -96,11 +97,11 @@ class MQTTConnection:
         """Connect to the MQTT broker."""
         try:
             from ebus_mqtt_client import MqttClient
-        except ImportError:
+        except ImportError as err:
             raise ImportError(
                 "ebus-mqtt-client is required for MQTT support. "
                 "Install it with: pip install python-oa3-client[mqtt]"
-            )
+            ) from err
 
         host, port, use_tls = normalize_broker_uri(self.broker_url)
         self._client = MqttClient(

{python_oa3_client-0.1.0 → python_oa3_client-0.2.0}/src/openadr3_client/notifications.py

@@ -7,10 +7,11 @@ the lower-level MQTTConnection and WebhookReceiver.
 from __future__ import annotations
 
 import logging
-from typing import Any, Callable, Protocol, runtime_checkable
+from collections.abc import Callable
+from typing import Any, Protocol, runtime_checkable
 
 from openadr3_client.mqtt import MQTTConnection, MQTTMessage
-from openadr3_client.webhook import WebhookReceiver, WebhookMessage
+from openadr3_client.webhook import WebhookMessage, WebhookReceiver
 
 log = logging.getLogger(__name__)
 

{python_oa3_client-0.1.0 → python_oa3_client-0.2.0}/src/openadr3_client/ven.py

@@ -3,11 +3,13 @@
 from __future__ import annotations
 
 import logging
-from typing import Any, Callable
+from collections.abc import Callable
+from typing import Any
 
 import httpx
-
-from openadr3.api import success, body
+from openadr3.api import success
+from openadr3.entities import coerce
+from openadr3.entities.models import Event, Program
 
 from openadr3_client.base import BaseClient
 from openadr3_client.notifications import (
@@ -83,16 +85,16 @@ class VenClient(BaseClient):
                 vid = existing["id"]
                 log.info("VEN found, reusing: name=%s id=%s", ven_name, vid)
             else:
-                resp = self.api.create_ven({
-                    "objectType": "VEN_VEN_REQUEST",
-                    "venName": ven_name,
-                })
+                resp = self.api.create_ven(
+                    {
+                        "objectType": "VEN_VEN_REQUEST",
+                        "venName": ven_name,
+                    }
+                )
                 resp.raise_for_status()
                 vid = resp.json().get("id")
                 if not vid:
-                    raise RuntimeError(
-                        f"VEN registration failed: {resp.status_code} {resp.text}"
-                    )
+                    raise RuntimeError(f"VEN registration failed: {resp.status_code} {resp.text}")
                 log.info("VEN registered: name=%s id=%s", ven_name, vid)
             self._ven_id = vid
             self._ven_name = ven_name
@@ -100,12 +102,23 @@ class VenClient(BaseClient):
 
     # -- Program lookup --
 
-    def find_program_by_name(self, name: str) -> dict[str, Any] | None:
-        """Query VTN for a program by programName. Caches the ID on success."""
-        result = self.api.find_program_by_name(name)
-        if result and "id" in result:
-            self._program_cache[name] = result["id"]
-        return result
+    def find_program_by_name(self, name: str) -> Program | None:
+        """Query VTN for a program by programName. Caches the ID on success.
+
+        Returns a coerced Program model (or None), matching the shape of
+        programs() and poll_events() which also return coerced models.
+        """
+        raw = self.api.find_program_by_name(name)
+        if not raw:
+            return None
+        program = coerce(raw)
+        if not isinstance(program, Program):
+            raise TypeError(
+                f"Expected Program from find_program_by_name, got {type(program).__name__}"
+            )
+        if program.id:
+            self._program_cache[name] = program.id
+        return program
 
     def resolve_program_id(self, name: str) -> str:
         """Cached name→ID lookup. Queries VTN if not cached.
@@ -135,9 +148,7 @@ class VenClient(BaseClient):
             return False
         # VTN-RI returns a list of notifier dicts with "transport" field
         if isinstance(notifiers, list):
-            return any(
-                n.get("transport", "").upper() == "MQTT" for n in notifiers
-            )
+            return any(n.get("transport", "").upper() == "MQTT" for n in notifiers)
         # Or it might be a dict with transport info
         return "mqtt" in str(notifiers).lower()
 
@@ -213,23 +224,27 @@ class VenClient(BaseClient):
                     all_topics.extend(topics)
             elif isinstance(channel, WebhookChannel):
                 # Create a VTN subscription pointing to the webhook
-                self.api.create_subscription({
-                    "clientName": self._ven_name or "ven-client",
-                    "programID": program_id,
-                    "objectOperations": [{
-                        "objects": objects,
-                        "operations": operations,
-                        "callbackUrl": channel.callback_url,
-                        "bearerToken": channel._receiver.bearer_token,
-                    }],
-                })
+                self.api.create_subscription(
+                    {
+                        "clientName": self._ven_name or "ven-client",
+                        "programID": program_id,
+                        "objectOperations": [
+                            {
+                                "objects": objects,
+                                "operations": operations,
+                                "callbackUrl": channel.callback_url,
+                                "bearerToken": channel._receiver.bearer_token,
+                            }
+                        ],
+                    }
+                )
 
         return all_topics
 
     # -- Poll events --
 
-    def poll_events(self, program_name: str) -> list:
-        """GET events filtered by program name."""
+    def poll_events(self, program_name: str) -> list[Event]:
+        """GET events filtered by program name. Returns coerced Event models."""
         program_id = self.resolve_program_id(program_name)
         return self.api.events(programID=program_id)
 

{python_oa3_client-0.1.0 → python_oa3_client-0.2.0}/src/openadr3_client/webhook.py

@@ -11,12 +11,12 @@ from __future__ import annotations
 
 import json
 import logging
+import socket
 import threading
 import time
+from collections.abc import Callable
 from dataclasses import dataclass
-from typing import Any, Callable
-
-import socket
+from typing import Any
 
 from openadr3.entities import coerce_notification, is_notification
 
@@ -66,9 +66,7 @@ def _parse_webhook_payload(raw: bytes, path: str) -> Any:
         return s
 
     if isinstance(parsed, dict) and is_notification(parsed):
-        return coerce_notification(
-            parsed, {"openadr/channel": "webhook", "openadr/path": path}
-        )
+        return coerce_notification(parsed, {"openadr/channel": "webhook", "openadr/path": path})
     return parsed
 
 
@@ -120,12 +118,12 @@ class WebhookReceiver:
     def start(self) -> None:
         """Start the webhook server in a background thread."""
         try:
-            from flask import Flask, request, abort
-        except ImportError:
+            from flask import Flask, abort, request
+        except ImportError as err:
             raise ImportError(
                 "Flask is required for webhook support. "
                 "Install it with: pip install python-oa3-client[webhooks]"
-            )
+            ) from err
 
         app = Flask(__name__)
         # Suppress Flask/werkzeug request logging
@@ -177,7 +175,9 @@ class WebhookReceiver:
         self._server_thread.start()
         log.info(
             "Webhook server started: %s (bind=%s:%d)",
-            self.callback_url, self.host, self.port,
+            self.callback_url,
+            self.host,
+            self.port,
         )
 
     def stop(self) -> None:

{python_oa3_client-0.1.0 → python_oa3_client-0.2.0}/tests/test_base.py

@@ -1,6 +1,6 @@
 """Tests for openadr3_client.base — lifecycle, __getattr__, auth."""
 
-from unittest.mock import patch, MagicMock
+from unittest.mock import MagicMock, patch
 
 import pytest
 

{python_oa3_client-0.1.0 → python_oa3_client-0.2.0}/tests/test_bl.py

@@ -1,6 +1,6 @@
 """Tests for openadr3_client.bl — BlClient."""
 
-from unittest.mock import patch, MagicMock
+from unittest.mock import MagicMock, patch
 
 from openadr3_client.bl import BlClient
 

{python_oa3_client-0.1.0 → python_oa3_client-0.2.0}/tests/test_discovery.py

@@ -1,20 +1,19 @@
 """Tests for openadr3_client.discovery — mDNS/DNS-SD VTN discovery."""
 
-from unittest.mock import patch, MagicMock, PropertyMock
+from unittest.mock import MagicMock, patch
 
 import pytest
 
 from openadr3_client.discovery import (
+    SERVICE_TYPE,
     DiscoveredVTN,
     DiscoveryMode,
-    SERVICE_TYPE,
     _parse_txt_properties,
+    advertise_vtn,
     discover_vtns,
     resolve_url,
-    advertise_vtn,
 )
 
-
 # -- _parse_txt_properties --
 
 
@@ -50,14 +49,18 @@ class TestParseTxtProperties:
 class TestDiscoveredVTN:
     def test_url_from_local_url(self):
         vtn = DiscoveredVTN(
-            name="test", host="vtn.local", port=8080,
+            name="test",
+            host="vtn.local",
+            port=8080,
             local_url="http://vtn.local:8080/openadr3",
         )
         assert vtn.url == "http://vtn.local:8080/openadr3"
 
     def test_url_strips_trailing_slash(self):
         vtn = DiscoveredVTN(
-            name="test", host="vtn.local", port=8080,
+            name="test",
+            host="vtn.local",
+            port=8080,
             local_url="http://vtn.local:8080/openadr3/",
         )
         assert vtn.url == "http://vtn.local:8080/openadr3"
@@ -68,7 +71,9 @@ class TestDiscoveredVTN:
 
     def test_url_constructed_with_base_path(self):
         vtn = DiscoveredVTN(
-            name="test", host="vtn.local", port=8080,
+            name="test",
+            host="vtn.local",
+            port=8080,
             base_path="/openadr3",
         )
         assert vtn.url == "http://vtn.local:8080/openadr3"
@@ -197,8 +202,9 @@ class TestResolveUrl:
 
     @patch("openadr3_client.discovery.discover_vtns")
     def test_require_local_found(self, mock_discover):
-        vtn = DiscoveredVTN(name="v", host="vtn.local", port=8080,
-                            local_url="http://vtn.local:8080")
+        vtn = DiscoveredVTN(
+            name="v", host="vtn.local", port=8080, local_url="http://vtn.local:8080"
+        )
         mock_discover.return_value = [vtn]
         assert resolve_url("require_local", None) == "http://vtn.local:8080"
 
@@ -210,8 +216,9 @@ class TestResolveUrl:
 
     @patch("openadr3_client.discovery.discover_vtns")
     def test_prefer_local_found(self, mock_discover):
-        vtn = DiscoveredVTN(name="v", host="vtn.local", port=8080,
-                            local_url="http://vtn.local:8080")
+        vtn = DiscoveredVTN(
+            name="v", host="vtn.local", port=8080, local_url="http://vtn.local:8080"
+        )
         mock_discover.return_value = [vtn]
         assert resolve_url("prefer_local", "http://cloud.vtn.com") == "http://vtn.local:8080"
 
@@ -228,8 +235,9 @@ class TestResolveUrl:
 
     @patch("openadr3_client.discovery.discover_vtns")
     def test_local_with_fallback_found(self, mock_discover):
-        vtn = DiscoveredVTN(name="v", host="vtn.local", port=8080,
-                            local_url="http://vtn.local:8080")
+        vtn = DiscoveredVTN(
+            name="v", host="vtn.local", port=8080, local_url="http://vtn.local:8080"
+        )
         mock_discover.return_value = [vtn]
         assert resolve_url("local_with_fallback", "http://cloud.vtn.com") == "http://vtn.local:8080"
 
@@ -269,7 +277,7 @@ class TestAdvertiseVtn:
         mock_zc_instance = MagicMock()
         mock_zc_mod.Zeroconf.return_value = mock_zc_instance
 
-        with advertise_vtn("127.0.0.1", 8080) as adv:
+        with advertise_vtn("127.0.0.1", 8080):
             mock_zc_instance.register_service.assert_called_once()
         mock_zc_instance.unregister_service.assert_called_once()
         mock_zc_instance.close.assert_called_once()
@@ -282,7 +290,8 @@ class TestAdvertiseVtn:
         mock_zc_mod.Zeroconf.return_value = mock_zc_instance
 
         advertise_vtn(
-            "127.0.0.1", 8080,
+            "127.0.0.1",
+            8080,
             base_path="/openadr3",
             version="3.1.0",
             program_names="prog1,prog2",
@@ -302,22 +311,26 @@ class TestAdvertiseVtn:
 class TestBaseClientDiscovery:
     def test_default_discovery_never_requires_url(self):
         from openadr3_client.base import BaseClient
+
         with pytest.raises(ValueError, match="url is required"):
             BaseClient(token="tok")
 
     def test_local_with_fallback_requires_url(self):
         from openadr3_client.base import BaseClient
+
         with pytest.raises(ValueError, match="url is required.*local_with_fallback"):
             BaseClient(token="tok", discovery="local_with_fallback")
 
     def test_require_local_no_url_ok(self):
         from openadr3_client.base import BaseClient
+
         c = BaseClient(token="tok", discovery="require_local")
         assert c.url is None
         assert c.discovery_mode == DiscoveryMode.REQUIRE_LOCAL
 
     def test_prefer_local_no_url_ok(self):
         from openadr3_client.base import BaseClient
+
         c = BaseClient(token="tok", discovery="prefer_local")
         assert c.url is None
 
@@ -325,13 +338,16 @@ class TestBaseClientDiscovery:
     @patch("openadr3_client.base.create_ven_client")
     def test_start_uses_resolved_url(self, mock_create, mock_resolve):
         from openadr3_client.base import BaseClient
+
         mock_create.return_value = MagicMock()
 
         c = BaseClient(token="tok", discovery="require_local")
         c.start()
 
         mock_resolve.assert_called_once_with(
-            DiscoveryMode.REQUIRE_LOCAL, None, 3.0,
+            DiscoveryMode.REQUIRE_LOCAL,
+            None,
+            3.0,
         )
         mock_create.assert_called_once()
         assert mock_create.call_args[1]["base_url"] == "http://discovered:8080"
@@ -341,11 +357,14 @@ class TestBaseClientDiscovery:
     @patch("openadr3_client.base.create_ven_client")
     def test_start_never_mode_passes_url(self, mock_create, mock_resolve):
         from openadr3_client.base import BaseClient
+
         mock_create.return_value = MagicMock()
 
         c = BaseClient(url="http://test", token="tok")
         c.start()
 
         mock_resolve.assert_called_once_with(
-            DiscoveryMode.NEVER, "http://test", 3.0,
+            DiscoveryMode.NEVER,
+            "http://test",
+            3.0,
         )

{python_oa3_client-0.1.0 → python_oa3_client-0.2.0}/tests/test_mqtt.py

@@ -1,17 +1,14 @@
 """Tests for openadr3_client.mqtt."""
 
 import json
-import time
-import threading
-from unittest.mock import patch, MagicMock
+from unittest.mock import MagicMock, patch
 
 import pytest
 
 from openadr3_client.mqtt import (
     MQTTConnection,
-    MQTTMessage,
-    normalize_broker_uri,
     _parse_payload,
+    normalize_broker_uri,
 )
 
 

{python_oa3_client-0.1.0 → python_oa3_client-0.2.0}/tests/test_notifications.py

@@ -4,7 +4,6 @@ from unittest.mock import MagicMock, patch
 
 from openadr3_client.notifications import (
     MqttChannel,
-    NotificationChannel,
     WebhookChannel,
 )
 
@@ -12,12 +11,26 @@ from openadr3_client.notifications import (
 class TestNotificationChannelProtocol:
     def test_mqtt_channel_has_protocol_methods(self):
         """MqttChannel has all NotificationChannel methods."""
-        for name in ("start", "stop", "subscribe_topics", "messages", "await_messages", "clear_messages"):
+        for name in (
+            "start",
+            "stop",
+            "subscribe_topics",
+            "messages",
+            "await_messages",
+            "clear_messages",
+        ):
             assert hasattr(MqttChannel, name), f"MqttChannel missing {name}"
 
     def test_webhook_channel_has_protocol_methods(self):
         """WebhookChannel has all NotificationChannel methods."""
-        for name in ("start", "stop", "subscribe_topics", "messages", "await_messages", "clear_messages"):
+        for name in (
+            "start",
+            "stop",
+            "subscribe_topics",
+            "messages",
+            "await_messages",
+            "clear_messages",
+        ):
             assert hasattr(WebhookChannel, name), f"WebhookChannel missing {name}"
 
 

{python_oa3_client-0.1.0 → python_oa3_client-0.2.0}/tests/test_ven.py

@@ -1,9 +1,10 @@
 """Tests for openadr3_client.ven — VenClient registration, program lookup, subscribe."""
 
-from unittest.mock import patch, MagicMock
+from unittest.mock import MagicMock, patch
 
 import httpx
 import pytest
+from openadr3.entities.models import Program
 
 from openadr3_client.ven import VenClient, extract_topics
 
@@ -54,16 +55,20 @@ class TestVenClientRegistration:
     def test_register_new_ven(self, mock_create):
         mock_api = MagicMock()
         mock_api.find_ven_by_name.return_value = None
-        mock_api.create_ven.return_value = _make_response(201, {"id": "new-ven-456", "venName": "my-ven"})
+        mock_api.create_ven.return_value = _make_response(
+            201, {"id": "new-ven-456", "venName": "my-ven"}
+        )
         mock_create.return_value = mock_api
 
         with VenClient(url="http://test", token="tok") as ven:
             ven.register("my-ven")
             assert ven.ven_id == "new-ven-456"
-            mock_api.create_ven.assert_called_once_with({
-                "objectType": "VEN_VEN_REQUEST",
-                "venName": "my-ven",
-            })
+            mock_api.create_ven.assert_called_once_with(
+                {
+                    "objectType": "VEN_VEN_REQUEST",
+                    "venName": "my-ven",
+                }
+            )
 
     def test_require_ven_id_not_registered(self):
         ven = VenClient(url="http://test", token="tok")
@@ -76,13 +81,17 @@ class TestVenClientProgramLookup:
     def test_find_program_by_name(self, mock_create):
         mock_api = MagicMock()
         mock_api.find_program_by_name.return_value = {
-            "id": "prog-1", "programName": "pricing"
+            "objectType": "PROGRAM",
+            "id": "prog-1",
+            "programName": "pricing",
         }
         mock_create.return_value = mock_api
 
         with VenClient(url="http://test", token="tok") as ven:
             result = ven.find_program_by_name("pricing")
-            assert result["id"] == "prog-1"
+            assert isinstance(result, Program)
+            assert result.id == "prog-1"
+            assert result.program_name == "pricing"
             assert ven._program_cache["pricing"] == "prog-1"
 
     @patch("openadr3_client.base.create_ven_client")
@@ -111,7 +120,9 @@ class TestVenClientProgramLookup:
     def test_resolve_program_id_queries(self, mock_create):
         mock_api = MagicMock()
         mock_api.find_program_by_name.return_value = {
-            "id": "prog-2", "programName": "dr-program"
+            "objectType": "PROGRAM",
+            "id": "prog-2",
+            "programName": "dr-program",
         }
         mock_create.return_value = mock_api
 
@@ -125,18 +136,23 @@ class TestVenClientProgramLookup:
         mock_api.find_program_by_name.return_value = None
         mock_create.return_value = mock_api
 
-        with VenClient(url="http://test", token="tok") as ven:
-            with pytest.raises(KeyError, match="Program not found"):
-                ven.resolve_program_id("missing")
+        with (
+            VenClient(url="http://test", token="tok") as ven,
+            pytest.raises(KeyError, match="Program not found"),
+        ):
+            ven.resolve_program_id("missing")
 
 
 class TestVenClientNotifiers:
     @patch("openadr3_client.base.create_ven_client")
     def test_discover_notifiers(self, mock_create):
         mock_api = MagicMock()
-        mock_api.get_notifiers.return_value = _make_response(200, [
-            {"transport": "MQTT", "url": "mqtt://broker:1883"},
-        ])
+        mock_api.get_notifiers.return_value = _make_response(
+            200,
+            [
+                {"transport": "MQTT", "url": "mqtt://broker:1883"},
+            ],
+        )
         mock_create.return_value = mock_api
 
         with VenClient(url="http://test", token="tok") as ven:
@@ -147,9 +163,12 @@ class TestVenClientNotifiers:
     @patch("openadr3_client.base.create_ven_client")
     def test_vtn_supports_mqtt_true(self, mock_create):
         mock_api = MagicMock()
-        mock_api.get_notifiers.return_value = _make_response(200, [
-            {"transport": "MQTT", "url": "mqtt://broker:1883"},
-        ])
+        mock_api.get_notifiers.return_value = _make_response(
+            200,
+            [
+                {"transport": "MQTT", "url": "mqtt://broker:1883"},
+            ],
+        )
         mock_create.return_value = mock_api
 
         with VenClient(url="http://test", token="tok") as ven:
@@ -158,9 +177,12 @@ class TestVenClientNotifiers:
     @patch("openadr3_client.base.create_ven_client")
     def test_vtn_supports_mqtt_false(self, mock_create):
         mock_api = MagicMock()
-        mock_api.get_notifiers.return_value = _make_response(200, [
-            {"transport": "HTTP", "url": "http://example.com"},
-        ])
+        mock_api.get_notifiers.return_value = _make_response(
+            200,
+            [
+                {"transport": "HTTP", "url": "http://example.com"},
+            ],
+        )
         mock_create.return_value = mock_api
 
         with VenClient(url="http://test", token="tok") as ven:
@@ -200,9 +222,11 @@ class TestVenClientMqttTopics:
     @patch("openadr3_client.base.create_ven_client")
     def test_ven_scoped_not_registered(self, mock_create):
         mock_create.return_value = MagicMock()
-        with VenClient(url="http://test", token="tok") as ven:
-            with pytest.raises(RuntimeError, match="VEN not registered"):
-                ven.get_mqtt_topics_ven()
+        with (
+            VenClient(url="http://test", token="tok") as ven,
+            pytest.raises(RuntimeError, match="VEN not registered"),
+        ):
+            ven.get_mqtt_topics_ven()
 
 
 class TestVenClientGetattr:
@@ -228,7 +252,9 @@ class TestVenClientSubscribe:
     def test_subscribe_mqtt(self, mock_create):
         mock_api = MagicMock()
         mock_api.find_program_by_name.return_value = {
-            "id": "prog-1", "programName": "pricing"
+            "objectType": "PROGRAM",
+            "id": "prog-1",
+            "programName": "pricing",
         }
         mock_api.get_mqtt_topics_program_events.return_value = _make_response(
             200, {"topics": {"a": "openadr3/programs/prog-1/events"}}
@@ -236,9 +262,10 @@ class TestVenClientSubscribe:
         mock_create.return_value = mock_api
 
         with VenClient(url="http://test", token="tok") as ven:
-            from openadr3_client.notifications import MqttChannel
             from unittest.mock import patch as p
 
+            from openadr3_client.notifications import MqttChannel
+
             with p.object(MqttChannel, "subscribe_topics") as mock_sub:
                 ch = MqttChannel.__new__(MqttChannel)
                 ch._conn = MagicMock()

{python_oa3_client-0.1.0 → python_oa3_client-0.2.0}/tests/test_webhook.py

@@ -1,15 +1,14 @@
 """Tests for openadr3_client.webhook."""
 
 import json
-import time
 import threading
+import time
 
-import pytest
 import httpx
+import pytest
 
 from openadr3_client.webhook import (
     WebhookReceiver,
-    WebhookMessage,
     _parse_webhook_payload,
     detect_lan_ip,
 )