Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
warsaw merged 1 commit into from
Jan 24, 2018
+11 −8
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions Doc/library/getpass.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
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
View file
Open in desktop
Original file line number Diff line number Diff line change
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