mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-01 04:42:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

bpo-32651 Recommend getpass.getuser() (GH-5301) (#5304)

Browse source 
* bpo-32651 - In the documentation for os.getlogin(), recommend getpass.getuser()
(cherry picked from commit d499031f5f)
This commit is contained in:
Miss Islington (bot) 2018-01-24 11:09:56 -08:00 • committed by Barry Warsaw
parent fd844efa9c
commit 196b8cbab2
2 changed files with 11 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

10
Doc/library/getpass.rst
View file

@ -42,8 +42,10 @@ The :mod:`getpass` module provides two functions:
Return the "login name" of the user. Return the "login name" of the user.
This function checks the environment variables :envvar:`LOGNAME`, This function checks the environment variables :envvar:`LOGNAME`,
:envvar:`USER`, :envvar:`LNAME` and :envvar:`USERNAME`, in order, and returns :envvar:`USER`, :envvar:`LNAME` and :envvar:`USERNAME`, in order, and
the value of the first one which is set to a non-empty string. If none are set, returns the value of the first one which is set to a non-empty string. If
the login name from the password database is returned on systems which support none are set, the login name from the password database is returned on
the :mod:`pwd` module, otherwise, an exception is raised. systems which support the :mod:`pwd` module, otherwise, an exception is
raised.
In general, this function should be preferred over :func:`os.getlogin()`.

9
Doc/library/os.rst
View file

@ -325,10 +325,11 @@ process and user.
.. function:: getlogin() .. function:: getlogin()
Return the name of the user logged in on the controlling terminal of the 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 process. For most purposes, it is more useful to use
variables :envvar:`LOGNAME` or :envvar:`USERNAME` to find out who the user :func:`getpass.getuser` since the latter checks the environment variables
is, or ``pwd.getpwuid(os.getuid())[0]`` to get the login name of the current :envvar:`LOGNAME` or :envvar:`USERNAME` to find out who the user is, and
real user id. falls back to ``pwd.getpwuid(os.getuid())[0]`` to get the login name of the
current real user id.
Availability: Unix, Windows. Availability: Unix, Windows.