Document getpass.getpass behavior on ^C

[untitaker]

BPO	24711
Nosy	@terryjreedy, @untitaker, @davidism, @iritkatriel

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2015-07-24.23:12:11.819>
labels = ['3.9', '3.10', 'docs']
title = 'Document getpass.getpass behavior on ^C'
updated_at = <Date 2022-01-21.20:31:24.753>
user = 'https://github.com/untitaker'

bugs.python.org fields:

activity = <Date 2022-01-21.20:31:24.753>
actor = 'terry.reedy'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2015-07-24.23:12:11.819>
creator = 'untitaker'
dependencies = []
files = []
hgrepos = []
issue_num = 24711
keywords = []
message_count = 6.0
messages = ['247302', '382520', '384858', '410824', '410825', '411181']
nosy_count = 5.0
nosy_names = ['terry.reedy', 'docs@python', 'untitaker', 'davidism', 'iritkatriel']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'resolved'
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue24711'
versions = ['Python 3.9', 'Python 3.10']

[untitaker]

getpass.getpass doesn't enter a newline when the user aborts input with ^C, while input/raw_input does.

This behavior is surprising and can lead to mis-formatting of subsequent output. However, since this behavior exists since 2.7 and applications may have started to rely on it, I'd add a note to the documentation.

[iritkatriel]

I don't see a difference between getpass and input in this respect:

----------------

import getpass

try:
getpass.getpass('getpass: ')
except:
pass
print('goodbye getpass')

try:
input('input: ')
except:
pass
print('goodbye input')

------------------

If I run that script and ^C after each prompt, I get this:

python.bat x.py
Running Release|x64 interpreter...
getpass: goodbye getpass
input: goodbye input

[iritkatriel]

Works for me on both linux and windows.

[davidism]

I can reproduce this on Python 3.10.
Actually, input and getpass both seem to have this behavior now. Please reopen it.

import getpass

try:
    getpass.getpass("in: ")
except:
    pass

print("done")

$ python example.py
getpass: ^D done
$

Run this and press Ctrl+D or Ctrl+C. The shell prompt appears on the same line rather than the next line.

[davidism]

Meant to say that "done" shows up on the same line, not the shell prompt. An earlier version of my example was in the REPL, where its prompt *does* show up on the same line.

[terryjreedy]

In IDLE Shell, with either ^C or ^D,

> try:
... input('??')
... except:
... 'done'
...
...
??
'done'

'getpass.getpass('??') does same after printing warning from line 100 that fallback_getpass is being used. The newline may be supplied by IDLE, not sure.

[ofek]

Is there a path toward fixing this rather than merely documenting the behavior?