Skip to content

fix: show string show_default value in prompt, not just in help text #3295

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

Closed
juliosuas wants to merge 1 commit into from
Closed

fix: show string show_default value in prompt, not just in help text #3295

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 12 additions & 4 deletions src/click/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3145,17 +3145,25 @@ def prompt_for_value(self, ctx: Context) -> t.Any:
default = bool(default)
return confirm(self.prompt, default)

# If show_default is set to True/False, provide this to `prompt` as well. For
# non-bool values of `show_default`, we use `prompt`'s default behavior
# If show_default is set to True/False, provide this to `prompt` as well.
# If show_default is a string, display that string as the default label
# in the prompt (e.g. "Name [show_default]: ") instead of the raw default
# value. This matches the behaviour already implemented for the help text.
prompt_kwargs: t.Any = {}
if isinstance(self.show_default, bool):
prompt_default = None if default is UNSET else default

if isinstance(self.show_default, str):
# Use the custom string as the displayed default in the prompt.
prompt_kwargs["show_default"] = True
prompt_default = self.show_default
elif isinstance(self.show_default, bool):
prompt_kwargs["show_default"] = self.show_default

return prompt(
self.prompt,
# Use ``None`` to inform the prompt() function to reiterate until a valid
# value is provided by the user if we have no default.
default=None if default is UNSET else default,
default=prompt_default,
type=self.type,
hide_input=self.hide_input,
show_choices=self.show_choices,
Expand Down
Loading