getpass — Portable password input

Вихідний код: Lib/getpass.py

Availability: not WASI.

This module does not work or is not available on WebAssembly. See WebAssembly platforms for more information.

The getpass module provides two functions:

getpass.getpass(prompt='Password: ', stream=None, *, echo_char=None)

Запитувати в користувача пароль без луни. Користувач отримує запит за допомогою рядка prompt, який за замовчуванням має значення 'Пароль:'. В Unix підказка записується у файлоподібний об’єкт stream за допомогою обробника помилок заміни, якщо потрібно. stream за замовчуванням використовується для керуючого терміналу (/dev/tty) або, якщо він недоступний, для sys.stderr (цей аргумент ігнорується в Windows).

The echo_char argument controls how user input is displayed while typing. If echo_char is None (default), input remains hidden. Otherwise, echo_char must be a single printable ASCII character and each typed character is replaced by it. For example, echo_char='*' will display asterisks instead of the actual input.

Якщо введення без відлуння недоступне, getpass() повертається до друку повідомлення попередження в stream і читання з sys.stdin і видачі GetPassWarning.

Примітка

Якщо ви викликаєте getpass із IDLE, введення може здійснюватися в терміналі, з якого ви запустили IDLE, а не в самому вікні очікування.

Примітка

On Unix systems, when echo_char is set, the terminal will be configured to operate in noncanonical mode. Common terminal control characters are supported:

  • Ctrl+A - Move cursor to beginning of line

  • Ctrl+E - Move cursor to end of line

  • Ctrl+K - Kill (delete) from cursor to end of line

  • Ctrl+U - Kill (delete) entire line

  • Ctrl+W - Erase previous word

  • Ctrl+V - Insert next character literally (quote)

  • Backspace/DEL - Delete character before cursor

These shortcuts work by reading the terminal’s configured control character mappings from termios settings.

Змінено в версії 3.14: Added the echo_char parameter for keyboard feedback.

Змінено в версії 3.15.0a7 (unreleased): When using non-empty echo_char on Unix, keyboard shortcuts (including cursor movement and line editing) are now properly handled using the terminal’s control character configuration.

exception getpass.GetPassWarning

Підклас UserWarning видається, коли введення пароля може повторюватися.

getpass.getuser()

Повернути «ім’я для входу» користувача.

This function checks the environment variables LOGNAME, USER, LNAME and USERNAME, in order, and returns the value of the first one which is set to a non-empty string. If none are set, the login name from the password database is returned on systems which support the pwd module, otherwise, an OSError is raised.

In general, this function should be preferred over os.getlogin().

Змінено в версії 3.13: Previously, various exceptions beyond just OSError were raised.