Support Force & Confirm #1783
Merged
Support Force & Confirm #1783
Conversation
This file contains 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
|
Only added it for these commands: Are there any other critical ones we should add it for @tjprescott & @johanste? |
|
I believe the port does this for all delete operations, so I would lean toward that. |
tjprescott
reviewed
Jan 19, 2017
| ``` | ||
| You will generally only specify `name`, `operation` and possibly `table_transformer`. | ||
| - `module_name` - The name of the module that is registering the command (e.g. `azure.cli.command_modules.vm.commands`). Typically this will be `__name__`. | ||
| - `name` - String uniquely naming your command and placing it within the command hierachy. It will be the string that you would type at the command line, omitting `az` (ex: access your command at `az mypackage mycommand` using a name of `mypackage mycommand`). | ||
| - `operation` - The handler that will be executed. Format is `<module_to_import>#<attribute_list>` | ||
| - For example if `operation='azure.mgmt.compute.operations.virtual_machines_operations#VirtualMachinesOperations.get'`, the CLI will import `azure.mgmt.compute.operations.virtual_machines_operations`, get the `VirtualMachinesOperations` attribute and then the `get` attribute of `VirtualMachinesOperations`. | ||
| - `table_transformer` (optional) - Supply a callable that takes, transforms and returns a result for table output. | ||
| - `confirmation` (optional) - Supply True to enable default confirmation. Alternatively, supply a callable that takes the command arguments as a dict and returning a boolean. Alternatively, supply a string for the prompt. |
There was a problem hiding this comment.
I'm not entirely sure I understand this. There are three cases:
- True => default prompt enabled
- callable => you have access to the command namespace (?) and return true or false? Do we use this?
- string => enables the prompt with a custom message.
Does using #2 mean you essentially are using your own handler and throwing away the default one?
There was a problem hiding this comment.
Your understanding of 1 & 3 is correct.
For 2, you can specify your own confirmation prompt handler. You get the command namespace so you can use it if required. e.g. Print a custom prompt based on the name of one of the parameters.
And no we do not currently use 2 or 3 but there are use-cases where they'll be useful.
tjprescott
approved these changes
Jan 19, 2017
- When registering a command, add `confirmation=True` to enable user confirmation. Also supports a string message or callable. - Add a —force flag for commands that support this feature. - Integrated with configuration system so it can be enabled/disabled by setting AZURE_CORE_DISABLE_CONFIRM_PROMPT Added for the following commands: az group delete az vm delete az network dns zone delete
derekbekoe
force-pushed
the
force-confirm
branch
from
394d676 to
4f44d99
Compare
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.
Closes #1355
confirmation=Trueto enable user confirmation. Also supports a string message or callable.Added for the following commands:
az group delete
az vm delete
az network dns zone delete
EXAMPLES:
Only accepts appropriate values.
No TTY: