Fix show_default string not shown in prompt (#2836)#3280
Closed
r266-tech wants to merge 2 commits intopallets:mainfrom
Closed
Fix show_default string not shown in prompt (#2836)#3280r266-tech wants to merge 2 commits intopallets:mainfrom
r266-tech wants to merge 2 commits intopallets:mainfrom
Conversation
When show_default is a string and prompt=True, the custom string was ignored and the actual default value was shown in the prompt instead. This change: - Passes show_default to prompt() regardless of its type (bool or str) - Updates _build_prompt() and prompt() to accept str for show_default - When show_default is a string, it is displayed in the prompt bracket instead of the formatted default value Fixes pallets#2836
Collaborator
Collaborator
|
A PR is ready to be merged at: #3165 |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
Description
Fixes #2836
When
show_defaultis a string andprompt=True, the custom string was ignored and the actual default value was shown in the prompt instead.Before:
After:
Changes
src/click/core.py: Passshow_defaulttoprompt()regardless of its type (bool or str), not just for bool valuessrc/click/termui.py: Updated_build_prompt()andprompt()signature to acceptstrforshow_default. When it is a string, it is displayed in the prompt bracket instead of the formatted default valuetests/test_options.py: Added testtest_show_default_string_in_promptAll existing tests pass (1320 passed, 22 skipped).