Ensure '--ids' validation failure prints usage string #1271
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
tjprescott
changed the title
derekbekoe
approved these changes
Nov 8, 2016
| @@ -144,7 +144,7 @@ def required_values_validator(namespace): | |||
|
|
|||
| if errors: | |||
| missing_required = ' '.join((arg.options_list[0] for arg in errors)) | |||
| raise CLIError('({} | {}) are required'.format(missing_required, '--ids')) | |||
| raise ValueError('({} | {}) are required'.format(missing_required, '--ids')) | |||
There was a problem hiding this comment.
Is the message '({} | {}) are required' shown in the usage statement?
There was a problem hiding this comment.
It looks exactly like it did before #1037:
usage: az vm show [-h] [--output {json,tsv,list,table,jsonc}] [--verbose]
[--debug] [--query JMESPATH]
[--resource-group RESOURCE_GROUP_NAME]
[--ids RESOURCE_ID [RESOURCE_ID ...]] [--name NAME]
[--expand EXPAND]
az vm show: error: (--resource-group --name | --ids) are required
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.
Fixes #1254.
The validator for the
--idsparameter raised a CLIError if it failed. After change #1037, CLIErrors thrown from a validator no longer cause the usage string to be printed. Thus, to ensure that a usage string is thrown when--idsusage is incorrect, this error was changed to a ValueError, which is the most common approach used by existing validators.