mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 17:08:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

Move the 2.6 reST doc tree in place.

Browse source
This commit is contained in:
Georg Brandl 2007-08-15 14:28:01 +00:00
parent f56181ff53
commit 8ec7f65613
445 changed files with 136056 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

38
Doc/library/getpass.rst Normal file
View file

@ -0,0 +1,38 @@
:mod:`getpass` --- Portable password input
==========================================
.. module:: getpass
:synopsis: Portable reading of passwords and retrieval of the userid.
.. moduleauthor:: Piers Lauder <piers@cs.su.oz.au>
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
.. % Windows (& Mac?) support by Guido van Rossum.
The :mod:`getpass` module provides two functions:
.. function:: getpass([prompt[, stream]])
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).
Availability: Macintosh, Unix, Windows.
.. versionchanged:: 2.5
The *stream* parameter was added.
.. function:: getuser()
Return the "login name" of the user. Availability: Unix, Windows.
This function checks the environment variables :envvar:`LOGNAME`,
:envvar:`USER`, :envvar:`LNAME` and :envvar:`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 :mod:`pwd` module, otherwise, an exception is raised.