Hide default value when show_default is False #2509
Conversation
src/click/core.py
Outdated
| @@ -2865,6 +2865,7 @@ def prompt_for_value(self, ctx: Context) -> t.Any: | |||
| show_choices=self.show_choices, | |||
| confirmation_prompt=self.confirmation_prompt, | |||
| value_proc=lambda x: self.process_value(ctx, x), | |||
| show_default=(False if self.show_default is False else True), | |||
There was a problem hiding this comment.
Why not simply: show_default=self.show_default?
There was a problem hiding this comment.
In this class, self.show_default is a Union[bool, str, None], but termui.prompt accepts only bool. Passing through show_default directly gives a type error, and also appears to do the wrong things for values of type filenam
There was a problem hiding this comment.
Got it. Thanks for the explanation.
Would you mind writing it down as a comment in the code? I think it would help others who read this line of code for the first time.
tests/test_termui.py
Outdated
| @@ -446,3 +446,13 @@ def cli(password): | |||
|
|
|||
| if prompt == "Confirm Password": | |||
| assert "Confirm Password: " in result.output | |||
|
|
|||
|
|
|||
| def test_show_default_false_hides_prompt(runner): | |||
There was a problem hiding this comment.
This test name can be clearer in order to explain what does this test check.
Mybe something like "test_false_show_default_cause_no_default_display_in_prompt".
src/click/core.py
Outdated
| @@ -2865,6 +2865,7 @@ def prompt_for_value(self, ctx: Context) -> t.Any: | |||
| show_choices=self.show_choices, | |||
| confirmation_prompt=self.confirmation_prompt, | |||
| value_proc=lambda x: self.process_value(ctx, x), | |||
| show_default=(False if self.show_default is False else True), | |||
There was a problem hiding this comment.
Got it. Thanks for the explanation.
Would you mind writing it down as a comment in the code? I think it would help others who read this line of code for the first time.
CHANGES.rst
Outdated
| @@ -7,6 +7,7 @@ Unreleased | |||
|
|
|||
| - Use modern packaging metadata with ``pyproject.toml`` instead of ``setup.cfg``. | |||
| :pr:`326` | |||
| - Do not display values in prompts when `show_default=False` on Options | |||
There was a problem hiding this comment.
| - Do not display values in prompts when `show_default=False` on Options | |
| - Do not display default values in prompts when `show_default=False` on options |
|
Also, this PR doesn't pass pre-commit at the moment. You might want to run |
|
Issues fixed. Added comment and also restructured code to make behavior of |
Previously, when
show_defaultwas False on anOption, the value could still appear in the prompt. Remove this so that sensitive values can be hidden from prompts.Checklist:
CHANGES.rstsummarizing the change and linking to the issue... versionchanged::entries in any relevant code docs.pre-commithooks and fix any issues.pytestandtox, no tests failed.