Fix show_default string not displayed in prompts#3262
Closed
oaksprout wants to merge 1 commit intopallets:mainfrom
Closed
Fix show_default string not displayed in prompts#3262oaksprout wants to merge 1 commit intopallets:mainfrom
oaksprout wants to merge 1 commit intopallets:mainfrom
Conversation
When show_default is set to a custom string on an option with prompt=True, the prompt now displays that string instead of the actual default value, matching the behavior already present in help text. Fixes pallets#2836
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Summary
When
show_defaultis set to a custom string on an option withprompt=True, the help text correctly displays the custom string (e.g.[default: (show_default)]), but the interactive prompt displays the actual default value instead.This PR fixes the inconsistency so the prompt also displays the custom
show_defaultstring:@click.option("--name", default="default", show_default="custom label", prompt=True)Before:
Name [default]:After:
Name [custom label]:Changes
_build_promptintermui.pyto acceptshow_defaultasbool | strand display the string when providedprompt()signature to acceptshow_default: bool | strOption.prompt_funcincore.pyto pass stringshow_defaultvalues through toprompt()Fixes #2836