Skip to content

Commit

Permalink
bpo-32651 Recommend getpass.getuser() (GH-5301) (#5304)
Browse files Browse the repository at this point in the history
* bpo-32651 - In the documentation for os.getlogin(), recommend getpass.getuser()
(cherry picked from commit d499031)
  • Loading branch information
miss-islington authored and warsaw committed Jan 24, 2018
1 parent fd844ef commit 196b8cb
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
10 changes: 6 additions & 4 deletions Doc/library/getpass.rst
Expand Up @@ -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()`.
9 changes: 5 additions & 4 deletions Doc/library/os.rst
Expand Up @@ -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.

Expand Down

0 comments on commit 196b8cb

Please sign in to comment.