summaryrefslogtreecommitdiffstats
path: root/Doc/library/os.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/library/os.rst')
-rw-r--r--Doc/library/os.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index ee08853..9cb34de 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -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.