Rename CommandMode to ExecutionMode and update references throughout the codebase

Author: iMicknl

README.md

@@ -68,7 +68,7 @@ async def main() -> None:
                 )
             ],
             label="Execution via Python",
-            # mode=CommandMode.HIGH_PRIORITY
+            # mode=ExecutionMode.HIGH_PRIORITY
         )
 
         while True:

pyoverkiz/action_queue.py

@@ -11,7 +11,7 @@
 from pyoverkiz.models import Action
 
 if TYPE_CHECKING:
-    from pyoverkiz.enums import CommandMode
+    from pyoverkiz.enums import ExecutionMode
 
 
 @dataclass(frozen=True, slots=True)
@@ -78,15 +78,15 @@ class ActionQueue:
     The batch is flushed when:
     - The delay timer expires
     - The max actions limit is reached
-    - The command mode changes
+    - The execution mode changes
     - The label changes
     - Manual flush is requested
     """
 
     def __init__(
         self,
         executor: Callable[
-            [list[Action], CommandMode | None, str | None], Coroutine[None, None, str]
+            [list[Action], ExecutionMode | None, str | None], Coroutine[None, None, str]
         ],
         delay: float = 0.5,
         max_actions: int = 20,
@@ -102,7 +102,7 @@ def __init__(
         self._max_actions = max_actions
 
         self._pending_actions: list[Action] = []
-        self._pending_mode: CommandMode | None = None
+        self._pending_mode: ExecutionMode | None = None
         self._pending_label: str | None = None
         self._pending_waiters: list[QueuedExecution] = []
 
@@ -121,7 +121,7 @@ def _copy_action(action: Action) -> Action:
     async def add(
         self,
         actions: list[Action],
-        mode: CommandMode | None = None,
+        mode: ExecutionMode | None = None,
         label: str | None = None,
     ) -> QueuedExecution:
         """Add actions to the queue.
@@ -132,7 +132,7 @@ async def add(
 
         Args:
             actions: Actions to queue.
-            mode: Command mode, which triggers a flush if it differs from the
+            mode: Execution mode, which triggers a flush if it differs from the
                 pending mode.
             label: Label for the action group.
 
@@ -141,7 +141,7 @@ async def add(
             executes.
         """
         batches_to_execute: list[
-            tuple[list[Action], CommandMode | None, str | None, list[QueuedExecution]]
+            tuple[list[Action], ExecutionMode | None, str | None, list[QueuedExecution]]
         ] = []
 
         if not actions:
@@ -235,7 +235,7 @@ async def _delayed_flush(self) -> None:
 
     def _prepare_flush(
         self,
-    ) -> tuple[list[Action], CommandMode | None, str | None, list[QueuedExecution]]:
+    ) -> tuple[list[Action], ExecutionMode | None, str | None, list[QueuedExecution]]:
         """Prepare a flush by taking snapshot and clearing state (must be called with lock held).
 
         Returns a tuple of (actions, mode, label, waiters) that should be executed
@@ -266,7 +266,7 @@ def _prepare_flush(
     async def _execute_batch(
         self,
         actions: list[Action],
-        mode: CommandMode | None,
+        mode: ExecutionMode | None,
         label: str | None,
         waiters: list[QueuedExecution],
     ) -> None:

pyoverkiz/client.py

@@ -22,7 +22,7 @@
 from pyoverkiz.action_queue import ActionQueue, ActionQueueSettings
 from pyoverkiz.auth import AuthStrategy, Credentials, build_auth_strategy
 from pyoverkiz.const import SUPPORTED_SERVERS
-from pyoverkiz.enums import APIType, CommandMode, Server
+from pyoverkiz.enums import APIType, ExecutionMode, Server
 from pyoverkiz.exceptions import (
     ExecutionQueueFullError,
     InvalidEventListenerIdError,
@@ -471,7 +471,7 @@ async def get_api_version(self) -> str:
     async def _execute_action_group_direct(
         self,
         actions: list[Action],
-        mode: CommandMode | None = None,
+        mode: ExecutionMode | None = None,
         label: str | None = "python-overkiz-api",
     ) -> str:
         """Execute a non-persistent action group directly (internal method).
@@ -489,7 +489,7 @@ async def _execute_action_group_direct(
     async def execute_action_group(
         self,
         actions: list[Action],
-        mode: CommandMode | None = None,
+        mode: ExecutionMode | None = None,
         label: str | None = "python-overkiz-api",
     ) -> str:
         """Execute a non-persistent action group.
@@ -509,7 +509,7 @@ async def execute_action_group(
 
         Args:
             actions: List of actions to execute.
-            mode: Command mode (`GEOLOCATED`, `INTERNAL`, `HIGH_PRIORITY`,
+            mode: Execution mode (`GEOLOCATED`, `INTERNAL`, `HIGH_PRIORITY`,
                 or `None`).
             label: Label for the action group.
 
@@ -547,13 +547,13 @@ def get_pending_actions_count(self) -> int:
         return 0
 
     @retry_on_auth_error
-    async def cancel_command(self, exec_id: str) -> None:
+    async def cancel_execution(self, exec_id: str) -> None:
         """Cancel a running setup-level execution."""
         await self._delete(f"exec/current/setup/{exec_id}")
 
     @retry_on_auth_error
     async def get_action_groups(self) -> list[ActionGroup]:
-        """List the action groups (scenarios)."""
+        """List the persisted action groups (scenarios)."""
         response = await self._get("actionGroups")
         return [ActionGroup(**action_group) for action_group in decamelize(response)]
 

pyoverkiz/enums/__init__.py

@@ -1,7 +1,7 @@
 """Convenience re-exports for the enums package."""
 
 # Explicitly re-export all Enum subclasses to avoid wildcard import issues
-from pyoverkiz.enums.command import CommandMode, OverkizCommand, OverkizCommandParam
+from pyoverkiz.enums.command import ExecutionMode, OverkizCommand, OverkizCommandParam
 from pyoverkiz.enums.execution import (
     ExecutionState,
     ExecutionSubType,
@@ -18,9 +18,9 @@
 
 __all__ = [
     "APIType",
-    "CommandMode",
     "DataType",
     "EventName",
+    "ExecutionMode",
     "ExecutionState",
     "ExecutionSubType",
     "ExecutionType",

pyoverkiz/enums/command.py

@@ -766,8 +766,8 @@ class OverkizCommandParam(StrEnum):
 
 
 @unique
-class CommandMode(StrEnum):
-    """Execution mode flags for commands (e.g., high priority or geolocated)."""
+class ExecutionMode(StrEnum):
+    """Execution mode flags (e.g., high priority or geolocated)."""
 
     HIGH_PRIORITY = "highPriority"
     GEOLOCATED = "geolocated"

tests/test_action_queue.py

@@ -6,7 +6,7 @@
 import pytest
 
 from pyoverkiz.action_queue import ActionQueue, QueuedExecution
-from pyoverkiz.enums import CommandMode, OverkizCommand
+from pyoverkiz.enums import ExecutionMode, OverkizCommand
 from pyoverkiz.models import Action, Command
 
 
@@ -112,7 +112,7 @@ async def test_action_queue_max_actions_flush(mock_executor):
 
 @pytest.mark.asyncio
 async def test_action_queue_mode_change_flush(mock_executor):
-    """Test that queue flushes when command mode changes."""
+    """Test that queue flushes when execution mode changes."""
     queue = ActionQueue(executor=mock_executor, delay=0.5)
 
     action = Action(
@@ -124,7 +124,7 @@ async def test_action_queue_mode_change_flush(mock_executor):
     queued1 = await queue.add([action], mode=None)
 
     # Add action with high priority - should flush previous batch
-    queued2 = await queue.add([action], mode=CommandMode.HIGH_PRIORITY)
+    queued2 = await queue.add([action], mode=ExecutionMode.HIGH_PRIORITY)
 
     # Wait for both batches
     exec_id1 = await queued1

utils/generate_enums.py

@@ -569,7 +569,7 @@ async def generate_command_enums() -> None:
     command_file = Path(__file__).parent.parent / "pyoverkiz" / "enums" / "command.py"
     content = command_file.read_text()
 
-    find_class_start(content, "CommandMode")
+    find_class_start(content, "ExecutionMode")
 
     existing_commands = extract_enum_members(content, "OverkizCommand")
     existing_params = extract_enum_members(content, "OverkizCommandParam")
@@ -656,8 +656,8 @@ async def generate_command_enums() -> None:
     lines.append("")
     lines.append("")
 
-    # Append CommandMode class
-    command_mode_start = content.find("@unique\nclass CommandMode")
+    # Append ExecutionMode class
+    command_mode_start = content.find("@unique\nclass ExecutionMode")
     if command_mode_start != -1:
         lines.append(content[command_mode_start:].rstrip())
     lines.append("")