getpass — Portable password input¶

Source code:Lib/getpass.py

Thegetpass module provides two functions:

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

Prompt the user for a password without echoing. The user is prompted usingthe stringprompt, which defaults to'Password:'. On Unix, theprompt is written to the file-like objectstream using the replace errorhandler if needed.stream defaults to the controlling terminal(/dev/tty) or if that is unavailable tosys.stderr (thisargument is ignored on Windows).

If echo free input is unavailable getpass() falls back to printinga warning message tostream and reading fromsys.stdin andissuing aGetPassWarning.

Note

If you call getpass from within IDLE, the input may be done in theterminal you launched IDLE from rather than the idle window itself.

exceptiongetpass.GetPassWarning¶

AUserWarning subclass issued when password input may be echoed.

getpass.getuser()¶

Return the “login name” of the user.

This function checks the environment variablesLOGNAME,USER,LNAME andUSERNAME, in order, andreturns the value of the first one which is set to a non-empty string. Ifnone are set, the login name from the password database is returned onsystems which support thepwd module, otherwise, an exception israised.

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