Add USER_AGENT constant and update OverkizClient to use it in headers; implement tests for User-Agent functionality

Author: iMicknl

pyoverkiz/client.py

@@ -24,7 +24,7 @@
 from pyoverkiz._case import decamelize
 from pyoverkiz.action_queue import ActionQueue, ActionQueueSettings
 from pyoverkiz.auth import AuthStrategy, Credentials, build_auth_strategy
-from pyoverkiz.const import SUPPORTED_SERVERS
+from pyoverkiz.const import SUPPORTED_SERVERS, USER_AGENT
 from pyoverkiz.converter import converter
 from pyoverkiz.enums import APIType, ExecutionMode, Protocol, Server
 from pyoverkiz.exceptions import (
@@ -211,9 +211,7 @@ def __init__(
         self.gateways: list[Gateway] = []
         self.event_listener_id: str | None = None
 
-        self.session = session or ClientSession(
-            headers={"User-Agent": "python-overkiz-api"}
-        )
+        self.session = session or ClientSession(headers={"User-Agent": USER_AGENT})
         self._ssl = verify_ssl
 
         if self.server_config.api_type == APIType.LOCAL and verify_ssl:

pyoverkiz/const.py

@@ -2,10 +2,14 @@
 
 from __future__ import annotations
 
+from importlib.metadata import version
+
 from pyoverkiz.enums import Server
 from pyoverkiz.enums.server import APIType
 from pyoverkiz.models import ServerConfig
 
+USER_AGENT = f"pyoverkiz/{version('pyoverkiz')}"
+
 COZYTOUCH_ATLANTIC_API = "https://apis.groupe-atlantic.com"
 COZYTOUCH_CLIENT_ID = (
     "Q3RfMUpWeVRtSUxYOEllZkE3YVVOQmpGblpVYToyRWNORHpfZHkzNDJVSnFvMlo3cFNKTnZVdjBh"

pyproject.toml

@@ -25,9 +25,9 @@ dependencies = [
 [project.optional-dependencies]
 docs = [
     "mkdocs>=1.5.0,<2.0",
-    "mkdocs-material>=9.5.0,<10.0",
-    "mkdocstrings[python]>=0.24.0,<1.0",
-    "mkdocs-autorefs>=1.0.0,<2.0",
+    "mkdocs-material>=9.5.0",
+    "mkdocstrings[python]>=0.24.0",
+    "mkdocs-autorefs>=1.0.0",
     "pymdown-extensions>=10.0",
 ]
 

tests/test_client.py

@@ -13,6 +13,7 @@
 from pyoverkiz.action_queue import ActionQueueSettings
 from pyoverkiz.auth import UsernamePasswordCredentials
 from pyoverkiz.client import OverkizClient, OverkizClientSettings
+from pyoverkiz.const import USER_AGENT
 from pyoverkiz.enums import (
     APIType,
     DataType,
@@ -1208,6 +1209,26 @@ async def test_local_schedule_persisted_action_group_unknown_object(
             )
 
 
+class TestUserAgent:
+    """Tests for the User-Agent header sent by OverkizClient."""
+
+    def test_user_agent_contains_version(self):
+        """Verify the USER_AGENT constant follows the pyoverkiz/{version} format."""
+        assert USER_AGENT.startswith("pyoverkiz/")
+        version_part = USER_AGENT.split("/", 1)[1]
+        assert version_part  # not empty
+        assert all(c.isdigit() or c == "." for c in version_part)
+
+    @pytest.mark.asyncio
+    async def test_client_session_uses_user_agent(self):
+        """Verify that a client-created session includes the correct User-Agent header."""
+        client = OverkizClient(
+            server=Server.SOMFY_EUROPE,
+            credentials=UsernamePasswordCredentials("user", "pass"),
+        )
+        assert client.session.headers["User-Agent"] == USER_AGENT
+
+
 class TestOverkizClientSettings:
     """Tests for the OverkizClientSettings integration with OverkizClient."""