Fix metavar for Choice options when show_choices=False #2365
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.
The
show_choices
parameter is intended to suppress choices from being displayed inline whenclick.prompt()
is used. It's available toclick.option()
because an option can act like a prompt if theprompt=True
parameter is used. However, this parameter does not prevent the choices from being used to create theChoice
metavar displayed within the--help
message.This change addresses this issue by creating the metavar string using the ParamTypes of the choices instead of the values themselves.
Example script:
Output when
show_choices=True
:$ demoecho --help Usage: demoecho [OPTIONS] Options: -s, --string [hello|world] This value echoed back to stdout. --help Show this message and exit.
Output when
show_choices=False
:show_choices=False
seems to have no effect #2356Checklist:
CHANGES.rst
summarizing the change and linking to the issue... versionchanged::
entries in any relevant code docs.pre-commit
hooks and fix any issues.pytest
andtox
, no tests failed.