Rename Scenario to ActionGroup (and relevant methods), reuse ActionGroup for Execution typing (#1864)

* Rename scenario to action group

* Rename test

* Fix docstring formatting in ActionGroup class

* Remove unnecessary assertions in ActionGroup initialization

Author: iMicknl

pyoverkiz/client.py

@@ -71,6 +71,7 @@
     UnknownUserException,
 )
 from pyoverkiz.models import (
+    ActionGroup,
     Command,
     Device,
     Event,
@@ -82,7 +83,6 @@
     OptionParameter,
     OverkizServer,
     Place,
-    Scenario,
     Setup,
     State,
 )
@@ -665,10 +665,12 @@ async def execute_commands(
         return cast(str, response["execId"])
 
     @retry_on_auth_error
-    async def get_scenarios(self) -> list[Scenario]:
-        """List the scenarios."""
+    async def get_action_groups(self) -> list[ActionGroup]:
+        """List the action groups (scenarios)."""
         response = await self.__get("actionGroups")
-        return [Scenario(**scenario) for scenario in humps.decamelize(response)]
+        return [
+            ActionGroup(**action_group) for action_group in humps.decamelize(response)
+        ]
 
     @retry_on_auth_error
     async def get_places(self) -> Place:

pyoverkiz/models.py

@@ -574,23 +574,23 @@ class Execution:
     description: str
     owner: str = field(repr=obfuscate_email)
     state: str
-    action_group: list[dict[str, Any]]
+    action_group: ActionGroup
 
     def __init__(
         self,
         id: str,
         description: str,
         owner: str,
         state: str,
-        action_group: list[dict[str, Any]],
+        action_group: dict[str, Any],
         **_: Any,
     ):
         """Initialize Execution object from API fields."""
         self.id = id
         self.description = description
         self.owner = owner
         self.state = state
-        self.action_group = action_group
+        self.action_group = ActionGroup(**action_group)
 
 
 @define(init=False, kw_only=True)
@@ -607,15 +607,15 @@ def __init__(self, device_url: str, commands: list[dict[str, Any]]):
 
 
 @define(init=False, kw_only=True)
-class Scenario:
+class ActionGroup:
     """An action group is composed of one or more actions.
 
     Each action is related to a single setup device (designated by its device URL) and
     is composed of one or more commands to be executed on that device.
     """
 
     id: str = field(repr=obfuscate_id)
-    creation_time: int
+    creation_time: int | None = None
     last_update_time: int | None = None
     label: str = field(repr=obfuscate_string)
     metadata: str | None = None
@@ -629,10 +629,11 @@ class Scenario:
 
     def __init__(
         self,
-        creation_time: int,
         actions: list[dict[str, Any]],
-        oid: str,
+        creation_time: int | None = None,
         metadata: str | None = None,
+        oid: str | None = None,
+        id: str | None = None,
         last_update_time: int | None = None,
         label: str | None = None,
         shortcut: bool | None = None,
@@ -642,8 +643,11 @@ def __init__(
         notification_title: str | None = None,
         **_: Any,
     ) -> None:
-        """Initialize Scenario (action group) from API data."""
-        self.id = oid
+        """Initialize ActionGroup from API data and convert nested actions."""
+        if oid is None and id is None:
+            raise ValueError("Either 'oid' or 'id' must be provided")
+
+        self.id = cast(str, oid or id)
         self.creation_time = creation_time
         self.last_update_time = last_update_time
         self.label = (
@@ -656,7 +660,7 @@ def __init__(
         self.notification_text = notification_text
         self.notification_title = notification_title
         self.actions = [Action(**action) for action in actions]
-        self.oid = oid
+        self.oid = cast(str, oid or id)
 
 
 @define(init=False, kw_only=True)

tests/fixtures/exec/current-tahoma-switch.json

@@ -0,0 +1,37 @@
+[
+    {
+        "startTime": 1767003511145,
+        "owner": "[email protected]",
+        "actionGroup": {
+            "label": "Execution via Home Assistant",
+            "shortcut": false,
+            "notificationTypeMask": 0,
+            "notificationCondition": "NEVER",
+            "actions": [
+                {
+                    "deviceURL": "rts://2025-8464-6867/16756006",
+                    "commands": [
+                        {
+                            "type": 1,
+                            "name": "close"
+                        }
+                    ]
+                },
+                {
+                    "deviceURL": "rts://2025-8464-6867/16719623",
+                    "commands": [
+                        {
+                            "type": 1,
+                            "name": "identify"
+                        }
+                    ]
+                }
+            ]
+        },
+        "description": "Execution : Execution via Home Assistant",
+        "id": "699dd967-0a19-0481-7a62-99b990a2feb8",
+        "state": "TRANSMITTED",
+        "executionType": "Immediate execution",
+        "executionSubType": "MANUAL_CONTROL"
+    }
+]

tests/test_client.py

@@ -423,7 +423,7 @@ async def test_get_setup_option(
         ],
     )
     @pytest.mark.asyncio
-    async def test_get_scenarios(
+    async def test_get_action_groups(
         self,
         client: OverkizClient,
         fixture_name: str,
@@ -437,16 +437,16 @@ async def test_get_scenarios(
             resp = MockResponse(action_group_mock.read())
 
         with patch.object(aiohttp.ClientSession, "get", return_value=resp):
-            scenarios = await client.get_scenarios()
+            action_groups = await client.get_action_groups()
 
-            assert len(scenarios) == scenario_count
+            assert len(action_groups) == scenario_count
 
-            for scenario in scenarios:
-                assert scenario.oid
-                assert scenario.label is not None
-                assert scenario.actions
+            for action_group in action_groups:
+                assert action_group.oid
+                assert action_group.label is not None
+                assert action_group.actions
 
-                for action in scenario.actions:
+                for action in action_group.actions:
                     assert action.device_url
                     assert action.commands