Browse Source
bpo-32651 Recommend getpass.getuser() (#5301)
* bpo-32651 - In the documentation for os.getlogin(), recommend getpass.getuser()
pull/296/merge
Barry Warsaw
8 years ago
committed by
GitHub
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with
11 additions and
8 deletions
-
Doc/library/getpass.rst
-
Doc/library/os.rst
|
|
|
@ -42,8 +42,10 @@ The :mod:`getpass` module provides two functions: |
|
|
|
Return the "login name" of the user. |
|
|
|
|
|
|
|
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. |
|
|
|
: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. |
|
|
|
|
|
|
|
In general, this function should be preferred over :func:`os.getlogin()`. |
|
|
|
@ -325,10 +325,11 @@ process and user. |
|
|
|
.. function:: getlogin() |
|
|
|
|
|
|
|
Return the name of the user logged in on the controlling terminal of the |
|
|
|
process. For most purposes, it is more useful to use the environment |
|
|
|
variables :envvar:`LOGNAME` or :envvar:`USERNAME` to find out who the user |
|
|
|
is, or ``pwd.getpwuid(os.getuid())[0]`` to get the login name of the current |
|
|
|
real user id. |
|
|
|
process. For most purposes, it is more useful to use |
|
|
|
:func:`getpass.getuser` since the latter checks the environment variables |
|
|
|
:envvar:`LOGNAME` or :envvar:`USERNAME` to find out who the user is, and |
|
|
|
falls back to ``pwd.getpwuid(os.getuid())[0]`` to get the login name of the |
|
|
|
current real user id. |
|
|
|
|
|
|
|
Availability: Unix, Windows. |
|
|
|
|
|
|
|
|