Skip to content

username

UsernameField

Bases: DataProvider

Finds the username and adds it to the LogRecord as username

Example

>>> import logging
>>> UsernameField().install()

Info

On UNIX systems this uses the :mod:pwd module which means root will be reported when :man:sudo is used (as it should). If this fails (for example on Windows) then :func:getpass.getuser() is used as a fallback.

Source code in src/loggext/extradata/username.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class UsernameField(DataProvider):
    r"""
    Finds the username and adds it to the LogRecord as `username`

    !!! example
        ```pycon
        >>> import logging
        >>> UsernameField().install()
        ```

    !!! info
        On UNIX systems this uses the :mod:`pwd` module which means ``root`` will
        be reported when :man:`sudo` is used (as it should). If this fails (for
        example on Windows) then :func:`getpass.getuser()` is used as a fallback.
    """

    @cache
    def _username(self) -> str:
        try:
            import pwd, os
            uid = os.getuid()
            return pwd.getpwuid(uid).pw_name
        except (ImportError, KeyError):
            import getpass
            return getpass.getuser()

    def add_data(self, record):
        record.username = self._username()