Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
bb60653
gh-138577: Fix keyboard shortcuts in getpass with echo_char
CuriousLearner Nov 15, 2025
31e35e4
Address reviews on dispatcher pattern + handle other ctrl chars
CuriousLearner Nov 16, 2025
b8609bd
Address reviews
CuriousLearner Nov 30, 2025
2691ad9
Merge remote-tracking branch 'upstream/main' into fix-gh-138577
CuriousLearner Mar 21, 2026
6a59f3b
Address reviews
CuriousLearner Mar 22, 2026
d280ce9
fix: prevent prompt corruption during getpass echo_char line editing
CuriousLearner Mar 23, 2026
3f1a861
fix: disable IEXTEN in non-canonical mode to allow Ctrl+V (LNEXT) han…
CuriousLearner Mar 23, 2026
537392c
refactor: address review on getpass echo_char line editing
CuriousLearner Mar 23, 2026
e1e4aa3
fix: Add comments about ICANON and IEXTEN
CuriousLearner Mar 23, 2026
3e05fa3
Merge branch 'main' of github.com:python/cpython into fix-gh-138577
CuriousLearner Mar 23, 2026
90da605
Address reviews
CuriousLearner Mar 24, 2026
ef1efcb
Merge branch 'main' into fix-gh-138577
CuriousLearner Mar 24, 2026
a7c1de3
Remove prefix from private class methods
CuriousLearner Mar 24, 2026
78b2c6a
Merge branch 'fix-gh-138577' of github.com:CuriousLearner/cpython int…
CuriousLearner Mar 24, 2026
e1461a7
Merge branch 'main' of github.com:python/cpython into fix-gh-138577
CuriousLearner Mar 24, 2026
741a817
Apply suggestions from code review
vstinner Mar 24, 2026
cc5dc99
chore! update some documentation
picnixz Mar 29, 2026
0f5f5c8
fix! refresh screen on Ctrl+A/Ctrl-E
picnixz Mar 29, 2026
9d90dfa
refactor! use more handlers
picnixz Mar 29, 2026
3b2ae38
chore! reduce diff against `main`
picnixz Mar 29, 2026
919af5c
test: add cursor position tests for Ctrl+A/Ctrl+E in getpass echo_char
CuriousLearner Mar 30, 2026
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
Prev Previous commit
Next Next commit
Address reviews
  • Loading branch information
CuriousLearner committed Nov 30, 2025
commit b8609bd4c3863f3cbf5ccf34cb33b350a94deca8
156 changes: 64 additions & 92 deletions Lib/getpass.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,48 +28,36 @@ class GetPassWarning(UserWarning): pass

# Default POSIX control character mappings
_POSIX_CTRL_CHARS = {
Comment thread
vstinner marked this conversation as resolved.
Outdated
'ERASE': b'\x7f', # DEL/Backspace
'KILL': b'\x15', # Ctrl+U - kill line
'WERASE': b'\x17', # Ctrl+W - erase word
'LNEXT': b'\x16', # Ctrl+V - literal next
'EOF': b'\x04', # Ctrl+D - EOF
'INTR': b'\x03', # Ctrl+C - interrupt
'SOH': b'\x01', # Ctrl+A - start of heading (beginning of line)
'ENQ': b'\x05', # Ctrl+E - enquiry (end of line)
'VT': b'\x0b', # Ctrl+K - vertical tab (kill forward)
'ERASE': '\x7f', # DEL/Backspace
'KILL': '\x15', # Ctrl+U - kill line
'WERASE': '\x17', # Ctrl+W - erase word
'LNEXT': '\x16', # Ctrl+V - literal next
'EOF': '\x04', # Ctrl+D - EOF
'INTR': '\x03', # Ctrl+C - interrupt
'SOH': '\x01', # Ctrl+A - start of heading (beginning of line)
'ENQ': '\x05', # Ctrl+E - enquiry (end of line)
'VT': '\x0b', # Ctrl+K - vertical tab (kill forward)
}


def _get_terminal_ctrl_chars(fd):
"""Extract control characters from terminal settings.

Returns a dict mapping control char names to their byte values.
Returns a dict mapping control char names to their str values.
Falls back to POSIX defaults if termios isn't available.
"""
res = _POSIX_CTRL_CHARS.copy()
Comment thread
vstinner marked this conversation as resolved.
Outdated
try:
old = termios.tcgetattr(fd)
cc = old[6] # Index 6 is the control characters array
return {
'ERASE': cc[termios.VERASE] if termios.VERASE < len(cc) else _POSIX_CTRL_CHARS['ERASE'],
'KILL': cc[termios.VKILL] if termios.VKILL < len(cc) else _POSIX_CTRL_CHARS['KILL'],
'WERASE': cc[termios.VWERASE] if termios.VWERASE < len(cc) else _POSIX_CTRL_CHARS['WERASE'],
'LNEXT': cc[termios.VLNEXT] if termios.VLNEXT < len(cc) else _POSIX_CTRL_CHARS['LNEXT'],
'EOF': cc[termios.VEOF] if termios.VEOF < len(cc) else _POSIX_CTRL_CHARS['EOF'],
'INTR': cc[termios.VINTR] if termios.VINTR < len(cc) else _POSIX_CTRL_CHARS['INTR'],
# Ctrl+A/E/K are not in termios, use POSIX defaults
'SOH': _POSIX_CTRL_CHARS['SOH'],
'ENQ': _POSIX_CTRL_CHARS['ENQ'],
'VT': _POSIX_CTRL_CHARS['VT'],
}
except (termios.error, OSError):
return _POSIX_CTRL_CHARS.copy()


def _decode_ctrl_char(char_value):
"""Convert a control character from bytes to str."""
if isinstance(char_value, bytes):
return char_value.decode('latin-1')
return char_value
return res
# Ctrl+A/E/K are not in termios, use POSIX defaults
Comment thread
vstinner marked this conversation as resolved.
Outdated
Comment thread
vstinner marked this conversation as resolved.
Outdated
for name in ('ERASE', 'KILL', 'WERASE', 'LNEXT', 'EOF', 'INTR'):
cap = getattr(termios, f'V{name}')
if cap < len(cc):
res[name] = cc[cap].decode('latin-1')
return res


def unix_getpass(prompt='Password: ', stream=None, *, echo_char=None):
Expand Down Expand Up @@ -248,78 +236,75 @@ def __init__(self, stream, echo_char, ctrl_chars):
self.cursor_pos = 0
self.eof_pressed = False
self.literal_next = False
self.ctrl = {name: _decode_ctrl_char(value)
for name, value in ctrl_chars.items()}
self.ctrl = ctrl_chars
self._dispatch = {
ctrl_chars['SOH']: self._handle_move_start, # Ctrl+A
ctrl_chars['ENQ']: self._handle_move_end, # Ctrl+E
ctrl_chars['VT']: self._handle_kill_forward, # Ctrl+K
ctrl_chars['KILL']: self._handle_kill_line, # Ctrl+U
ctrl_chars['WERASE']: self._handle_erase_word, # Ctrl+W
ctrl_chars['ERASE']: self._handle_erase, # DEL
'\b': self._handle_erase, # Backspace
}

def refresh_display(self):
"""Redraw the entire password line with asterisks."""
self.stream.write('\r' + ' ' * (len(self.passwd) + 20) + '\r')
def _refresh_display(self):
"""Redraw the entire password line with *echo_char*."""
self.stream.write('\r' + ' ' * len(self.passwd) + '\r')
self.stream.write(self.echo_char * len(self.passwd))
if self.cursor_pos < len(self.passwd):
self.stream.write('\b' * (len(self.passwd) - self.cursor_pos))
self.stream.flush()

def erase_chars(self, count):
"""Erase count asterisks from display."""
def _erase_chars(self, count):
"""Erase count echo characters from display."""
Comment thread
vstinner marked this conversation as resolved.
Outdated
self.stream.write("\b \b" * count)

def insert_char(self, char):
def _insert_char(self, char):
"""Insert character at cursor position."""
Comment thread
vstinner marked this conversation as resolved.
Outdated
self.passwd = self.passwd[:self.cursor_pos] + char + self.passwd[self.cursor_pos:]
self.cursor_pos += 1
# Only refresh if inserting in middle
if self.cursor_pos < len(self.passwd):
self.refresh_display()
self._refresh_display()
else:
self.stream.write(self.echo_char)
self.stream.flush()

def handle_literal_next(self, char):
"""Insert next character literally (Ctrl+V)."""
self.insert_char(char)
self.literal_next = False
self.eof_pressed = False

def handle_move_start(self):
def _handle_move_start(self):
"""Move cursor to beginning (Ctrl+A)."""
self.cursor_pos = 0
self.eof_pressed = False

def handle_move_end(self):
def _handle_move_end(self):
"""Move cursor to end (Ctrl+E)."""
self.cursor_pos = len(self.passwd)
self.eof_pressed = False

def handle_erase(self):
def _handle_erase(self):
"""Delete character before cursor (Backspace/DEL)."""
if self.cursor_pos > 0:
Comment thread
vstinner marked this conversation as resolved.
Outdated
self.passwd = self.passwd[:self.cursor_pos-1] + self.passwd[self.cursor_pos:]
Comment thread
vstinner marked this conversation as resolved.
Outdated
self.cursor_pos -= 1
# Only refresh if deleting from middle
if self.cursor_pos < len(self.passwd):
self.refresh_display()
self._refresh_display()
else:
self.stream.write("\b \b")
self.stream.flush()
self.eof_pressed = False

def handle_kill_line(self):
def _handle_kill_line(self):
"""Erase entire line (Ctrl+U)."""
self.erase_chars(len(self.passwd))
self._erase_chars(len(self.passwd))
self.passwd = ""
self.cursor_pos = 0
self.stream.flush()
self.eof_pressed = False

def handle_kill_forward(self):
def _handle_kill_forward(self):
"""Kill from cursor to end (Ctrl+K)."""
chars_to_delete = len(self.passwd) - self.cursor_pos
self.passwd = self.passwd[:self.cursor_pos]
self.erase_chars(chars_to_delete)
self._erase_chars(chars_to_delete)
self.stream.flush()
self.eof_pressed = False

def handle_erase_word(self):
def _handle_erase_word(self):
"""Erase previous word (Ctrl+W)."""
old_cursor = self.cursor_pos
# Skip trailing spaces
Expand All @@ -330,20 +315,16 @@ def handle_erase_word(self):
self.cursor_pos -= 1
# Remove the deleted portion
self.passwd = self.passwd[:self.cursor_pos] + self.passwd[old_cursor:]
self.refresh_display()
self.eof_pressed = False
self._refresh_display()

def build_dispatch_table(self):
"""Build dispatch table mapping control chars to handlers."""
return {
self.ctrl['SOH']: self.handle_move_start, # Ctrl+A
self.ctrl['ENQ']: self.handle_move_end, # Ctrl+E
self.ctrl['VT']: self.handle_kill_forward, # Ctrl+K
self.ctrl['KILL']: self.handle_kill_line, # Ctrl+U
self.ctrl['WERASE']: self.handle_erase_word, # Ctrl+W
self.ctrl['ERASE']: self.handle_erase, # DEL
'\b': self.handle_erase, # Backspace
}
def handle(self, char):
"""Handle a single character input. Returns True if handled."""
self.eof_pressed = False
handler = self._dispatch.get(char)
if handler:
handler()
return True
return False


def _readline_with_echo_char(stream, input, echo_char, term_ctrl_chars=None):
Expand All @@ -352,43 +333,34 @@ def _readline_with_echo_char(stream, input, echo_char, term_ctrl_chars=None):
term_ctrl_chars = _POSIX_CTRL_CHARS.copy()
Comment thread
vstinner marked this conversation as resolved.
Outdated

editor = _PasswordLineEditor(stream, echo_char, term_ctrl_chars)
dispatch = editor.build_dispatch_table()

while True:
Comment thread
vstinner marked this conversation as resolved.
Outdated
char = input.read(1)

# Check for line terminators
if char in ('\n', '\r'):
break

# Handle literal next mode FIRST (Ctrl+V quotes next char)
if editor.literal_next:
editor.handle_literal_next(char)
continue

elif editor.literal_next:
editor._insert_char(char)
editor.literal_next = False
editor.eof_pressed = False
# Check if it's the LNEXT character
if char == editor.ctrl['LNEXT']:
elif char == editor.ctrl['LNEXT']:
editor.literal_next = True
editor.eof_pressed = False
continue

# Check for special control characters
if char == editor.ctrl['INTR']:
elif char == editor.ctrl['INTR']:
raise KeyboardInterrupt
if char == editor.ctrl['EOF']:
elif char == editor.ctrl['EOF']:
if editor.eof_pressed:
break
editor.eof_pressed = True
continue
if char == '\x00':
continue

elif char == '\x00':
pass
# Dispatch to handler or insert as normal character
handler = dispatch.get(char)
if handler:
handler()
else:
editor.insert_char(char)
elif not editor.handle(char):
editor._insert_char(char)
editor.eof_pressed = False

return editor.passwd
Expand Down
Loading