Rename CommandMode, cancel_command, and scenario methods#1997
Merged
Rename CommandMode, cancel_command, and scenario methods#1997
Conversation
…and execution details and improve method docstrings
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces breaking API renames to clarify Overkiz “execution” concepts (modes, cancellation, and persisted action groups) and updates docs/tests accordingly.
Changes:
- Rename
CommandMode→ExecutionModeand update call sites (client, action queue, tests, enum generator). - Rename scenario APIs to persisted action-group terminology (
execute_persisted_action_group,schedule_persisted_action_group) and renamecancel_command→cancel_execution. - Expand and refine documentation around commands/actions/action groups, executions, and execution modes.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| utils/generate_enums.py | Updates enum generation logic to preserve the renamed ExecutionMode class. |
| tests/test_action_queue.py | Updates imports/usages and test wording for ExecutionMode. |
| pyoverkiz/enums/command.py | Renames the enum class to ExecutionMode. |
| pyoverkiz/enums/init.py | Re-exports ExecutionMode and updates __all__. |
| pyoverkiz/client.py | Renames public APIs (cancel_execution, persisted action group methods) and updates typing/docstrings. |
| pyoverkiz/action_queue.py | Updates type hints/docs from command mode to execution mode. |
| docs/device-control.md | Reworks device-control docs and updates examples to new names/modes. |
| docs/core-concepts.md | Adds clearer conceptual documentation aligned with renamed APIs. |
| README.md | Updates the usage snippet comment to reference ExecutionMode. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CommandMode→ExecutionModeandcancel_command→cancel_executionexecute_scenario→execute_persisted_action_groupandexecute_scheduled_scenario→schedule_persisted_action_groupBreaking
CommandModerenamed toExecutionMode,cancel_command()renamed tocancel_execution(),execute_scenario()renamed toexecute_persisted_action_group(),execute_scheduled_scenario()renamed toschedule_persisted_action_group()