Skip to content

gh-138577: Mention limitations of getpass.getpass(echo_char=...) #138677

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

Merged
merged 5 commits into from
Sep 9, 2025
Merged

gh-138577: Mention limitations of getpass.getpass(echo_char=...) #138677

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fffc644
Mention unexpected behavior of getpass.getpass() in document
yagggi Sep 8, 2025
cd7dc2c
Merge branch 'main' into getpass-doc
yagggi Sep 8, 2025
d8fe91b
Improve wording
yagggi Sep 8, 2025
40470ab
Remove trailing whitespace
yagggi Sep 8, 2025
942016c
Revise formatting: use :manpage: to generate link; remove github issu…
yagggi Sep 8, 2025
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
8 changes: 8 additions & 0 deletions Doc/library/getpass.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,14 @@ The :mod:`getpass` module provides two functions:
If you call getpass from within IDLE, the input may be done in the
terminal you launched IDLE from rather than the idle window itself.

.. note::
On Unix systems, when *echo_char* is set, the terminal will be
configured to operate in `noncanonical mode
<https://manpages.debian.org/termios(3)#Canonical_and_noncanonical_mode>`__.
In particular, this means that line editing shortcuts such as
:kbd:`Ctrl+U` will not work and may insert unexpected characters into
the input. (See :gh:`138577`)

.. versionchanged:: 3.14
Added the *echo_char* parameter for keyboard feedback.

Expand Down
Loading