cid d30071a357f608671d75dd0482a4f51dca464e90f0dd9c312d298aaf15df7305 · original · open access · via pydoc
Title: getpass — Portable password input — Python 3.13.18 documentation Authors: Venue: pydoc Year: 2001 Canonical: pydoc:getpass@3.13 URL: https://docs.python.org/3.13/library/getpass.html Collector: pydoc OA: true ABSTRACT getpass — Portable password input — Python 3.13.18 documentation Navigation index modules | next | previous | Python » 3.13.18 Documentation » The Python standard library » Command-line interface libraries » getpass — Portable password input | Theme Auto Light Dark | getpass — Portable password input¶ Source code: 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)¶ 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 using the replace error handler if needed. 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 GetPassWarning. 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 getpass.GetPassWarning¶ A UserWarning subclass issued when password input may be echoed. getpass.getuser()¶ Return the “login name” of the user. 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(). Changed in version 3.13: Previously, various exceptions beyond just OSError were raised. Previous topic optparse — Parser for command line options Next topic fileinput — Iterate over lines from multiple input streams This page Report a bug Show source « Navigation index modules | next | previous | Python » 3.13.18 Documentation » The Python standard library » Command-line interface libraries » getpass — Portable password input | Theme Auto Light Dark | © Copyright 2001-2026, Python Software Foundation. This page is licensed under the Python Software Foundation License Version 2. Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License. See History and License for more information. The Python Software Foundation is a non-profit corporation. Please donate. Last updated on Oct 26, 2026 (13:10 UTC). Found a bug? Created using Sphinx 8.2.3.