Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 2 additions & 3 deletions src/click/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -3145,10 +3145,9 @@ 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/string, provide this to `prompt` as well.
prompt_kwargs: t.Any = {}
if isinstance(self.show_default, bool):
if self.show_default is not None:
prompt_kwargs["show_default"] = self.show_default

return prompt(
Expand Down
14 changes: 10 additions & 4 deletions src/click/termui.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,16 +60,20 @@ def hidden_prompt_func(prompt: str) -> str:
def _build_prompt(
text: str,
suffix: str,
show_default: bool = False,
show_default: bool | str = False,
default: t.Any | None = None,
show_choices: bool = True,
type: ParamType | None = None,
) -> str:
prompt = text
if type is not None and show_choices and isinstance(type, Choice):
prompt += f" ({', '.join(map(str, type.choices))})"
if default is not None and show_default:
prompt = f"{prompt} [{_format_default(default)}]"
if show_default:
if isinstance(show_default, str):
# Use the custom string for display
prompt = f"{prompt} [({show_default})]"
elif default is not None:
prompt = f"{prompt} [{_format_default(default)}]"
return f"{prompt}{suffix}"


Expand All @@ -88,7 +92,7 @@ def prompt(
type: ParamType | t.Any | None = None,
value_proc: t.Callable[[str], t.Any] | None = None,
prompt_suffix: str = ": ",
show_default: bool = True,
show_default: bool | str = True,
err: bool = False,
show_choices: bool = True,
) -> t.Any:
Expand All @@ -112,6 +116,8 @@ def prompt(
convert a value.
:param prompt_suffix: a suffix that should be added to the prompt.
:param show_default: shows or hides the default value in the prompt.
Can also be a string to show a custom value instead of the actual
default.
:param err: if set to true the file defaults to ``stderr`` instead of
``stdout``, the same as with echo.
:param show_choices: Show or hide choices if the passed type is a Choice.
Expand Down