Skip to content

[Core] Display allowed values in error message when enum validation fails #17621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xfz11 merged 2 commits into from
Apr 9, 2021
Merged

[Core] Display allowed values in error message when enum validation fails #17621

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a42bc3
add allowed values information when enum validation fails
xfz11 Apr 9, 2021
89d5caf
lint
xfz11 Apr 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/azure-cli-core/azure/cli/core/parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -497,8 +497,8 @@ def _check_value(self, action, value): # pylint: disable=too-many-statements, t
else:
# `command_source` indicates command values have been parsed, value is an argument
parameter = action.option_strings[0] if action.option_strings else action.dest
error_msg = "{prog}: '{value}' is not a valid value for '{param}'.".format(
prog=self.prog, value=value, param=parameter)
error_msg = "{prog}: '{value}' is not a valid value for '{param}'. Allowed values: {choice}.".format(

@qwordy qwordy Apr 9, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
error_msg = "{prog}: '{value}' is not a valid value for '{param}'. Allowed values: {choice}.".format(
error_msg = "{prog}: '{value}' is not a valid value for '{param}'. Allowed values: {choices}.".format(

prog=self.prog, value=value, param=parameter, choice=', '.join(sorted([str(x) for x in action.choices])))

@qwordy qwordy Apr 9, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need sorted? Shall we respect the order in swagger definition?

@xfz11 xfz11 Apr 9, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The order in error message is better to be consistent with the order in help info

@jiasli jiasli Apr 9, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I personally prefer to keep the order because some choices may be more frequently used.

candidates = difflib.get_close_matches(value, action.choices, cutoff=0.7)
az_error = InvalidArgumentValueError(error_msg)

Expand Down