diff options
Diffstat (limited to 'Doc/library/getpass.rst')
| -rw-r--r-- | Doc/library/getpass.rst | 20 |
1 files changed, 18 insertions, 2 deletions
diff --git a/Doc/library/getpass.rst b/Doc/library/getpass.rst index bd384b4..91c811b 100644 --- a/Doc/library/getpass.rst +++ b/Doc/library/getpass.rst @@ -14,11 +14,27 @@ The :mod:`getpass` module provides two functions: Prompt the user for a password without echoing. The user is prompted using the string *prompt*, which defaults to ``'Password: '``. On Unix, the prompt is - written to the file-like object *stream*, which defaults to ``sys.stdout`` (this - argument is ignored on Windows). + written to the file-like object *stream*. *stream* defaults to the + controlling terminal (/dev/tty) or if that is unavailable to ``sys.stderr`` + (this argument is ignored on Windows). + + If echo free input is unavailable getpass() falls back to printing + a warning message to *stream* and reading from ``sys.stdin`` and + issuing a :exc:`GetPassWarning`. Availability: Macintosh, Unix, Windows. + .. versionchanged:: 2.6 + On Unix it defaults to using /dev/tty before falling back + to ``sys.stdin`` and ``sys.stderr``. + .. note:: + If you call getpass from within IDLE, the input may be done in the + terminal you launched IDLE from rather than the idle window itself. + +.. exception:: GetPassWarning + + A :exc:`UserWarning` subclass issued when password input may be echoed. + .. function:: getuser() |