1 :mod:`getpass` --- Portable password input 2 ========================================== 3 4 .. module:: getpass 5 :synopsis: Portable reading of passwords and retrieval of the userid. 6 .. moduleauthor:: Piers Lauder <piers (a] cs.su.oz.au> 7 .. sectionauthor:: Fred L. Drake, Jr. <fdrake (a] acm.org> 8 .. Windows (& Mac?) support by Guido van Rossum. 9 10 The :mod:`getpass` module provides two functions: 11 12 13 .. function:: getpass([prompt[, stream]]) 14 15 Prompt the user for a password without echoing. The user is prompted using the 16 string *prompt*, which defaults to ``'Password: '``. On Unix, the prompt is 17 written to the file-like object *stream*. *stream* defaults to the 18 controlling terminal (/dev/tty) or if that is unavailable to ``sys.stderr`` 19 (this argument is ignored on Windows). 20 21 If echo free input is unavailable getpass() falls back to printing 22 a warning message to *stream* and reading from ``sys.stdin`` and 23 issuing a :exc:`GetPassWarning`. 24 25 .. versionchanged:: 2.5 26 The *stream* parameter was added. 27 .. versionchanged:: 2.6 28 On Unix it defaults to using /dev/tty before falling back 29 to ``sys.stdin`` and ``sys.stderr``. 30 .. note:: 31 If you call getpass from within IDLE, the input may be done in the 32 terminal you launched IDLE from rather than the idle window itself. 33 34 35 .. exception:: GetPassWarning 36 37 A :exc:`UserWarning` subclass issued when password input may be echoed. 38 39 40 .. function:: getuser() 41 42 Return the "login name" of the user. 43 44 This function checks the environment variables :envvar:`LOGNAME`, 45 :envvar:`USER`, :envvar:`LNAME` and :envvar:`USERNAME`, in order, and returns 46 the value of the first one which is set to a non-empty string. If none are set, 47 the login name from the password database is returned on systems which support 48 the :mod:`pwd` module, otherwise, an exception is raised. 49 50
