prompt-toolkit / prompt-toolkit/python-prompt-toolkit

prompt_toolkit.shortcuts.confirm doesn't always return bool

Open
#2,046 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
10.6k
Forks
815
PR merge metrics
No merged PRs in 30d

Description

prompt_toolkit.shortcuts.confirm doesn't always return bool. When pressing just enter it returns a str.

For example:

from prompt_toolkit.shortcuts import confirm

result = confirm()

print(f"Result|{result}|")
print(type(result))

Produces:

Confirm? (y/n)  ### I press `Enter` here ###
Result||
<class 'str'>

This is on Windows, using prompt_toolkit 3.0.52 if it matters.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the prompt_toolkit.shortcuts.confirm entry point and reproduce the reported behavior on Windows with prompt_toolkit 3.0.52. Trace the Enter-key path and add or update coverage if the repository provides a relevant test location; done means confirm() returns a bool when Enter is pressed while retaining normal y/n behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.