feat(api): handle exceptions for function getpass.getuser() (#130)

.pre-commit-config.yaml

@@ -25,7 +25,7 @@ repos:
       - id: debug-statements
       - id: double-quote-string-fixer
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.5.0
+    rev: v0.5.1
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]

CHANGELOG.md

@@ -13,7 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
--
+- Handle exceptions for function `getpass.getuser()` by [@XuehaiPan](https://github.com/XuehaiPan) in [#130](https://github.com/XuehaiPan/nvitop/pull/130). Issued by [@landgraf](https://github.com/landgraf).
 
 ### Changed
 

docs/source/spelling_wordlist.txt

@@ -154,3 +154,4 @@ pytorch
 api
 utils
 GpuStatsLogger
+hostname

nvitop/api/host.py

@@ -23,14 +23,15 @@
 from __future__ import annotations
 
 import os as _os
-import time as _time
 from typing import Callable as _Callable
 
 import psutil as _psutil
 from psutil import *  # noqa: F403 # pylint: disable=wildcard-import,unused-wildcard-import,redefined-builtin
 
 
 __all__ = [name for name in _psutil.__all__ if not name.startswith('_')] + [
+    'getuser',
+    'hostname',
     'load_average',
     'uptime',
     'memory_percent',
@@ -60,6 +61,23 @@
 MACOS = _psutil.MACOS
 
 
+def getuser() -> str:
+    """Get the current username from the environment or password database."""
+    import getpass  # pylint: disable=import-outside-toplevel
+
+    try:
+        return getpass.getuser()
+    except (ModuleNotFoundError, OSError):
+        return _os.getlogin()
+
+
+def hostname() -> str:
+    """Get the hostname of the machine."""
+    import platform  # pylint: disable=import-outside-toplevel
+
+    return platform.node()
+
+
 if hasattr(_psutil, 'getloadavg'):
 
     def load_average() -> tuple[float, float, float]:
@@ -75,6 +93,8 @@ def load_average() -> None:  # type: ignore[misc]
 
 def uptime() -> float:
     """Get the system uptime."""
+    import time as _time  # pylint: disable=import-outside-toplevel
+
     return _time.time() - _psutil.boot_time()
 
 

nvitop/gui/library/utils.py

@@ -3,10 +3,9 @@
 
 # pylint: disable=missing-module-docstring,missing-function-docstring
 
-import getpass
+import contextlib
 import math
 import os
-import platform
 
 from nvitop.api import NA, colored, host, set_color  # noqa: F401 # pylint: disable=unused-import
 from nvitop.gui.library.widestring import WideString
@@ -56,25 +55,23 @@ def make_bar(prefix, percent, width, *, extra_text=''):
     return f'{bar} {text}'.ljust(width)
 
 
-try:
-    USERNAME = getpass.getuser()
-except ModuleNotFoundError:
-    USERNAME = os.getlogin()
+USERNAME = 'N/A'
+with contextlib.suppress(ImportError, OSError):
+    USERNAME = host.getuser()
 
-if host.WINDOWS:
-    import ctypes
+SUPERUSER = False
+with contextlib.suppress(AttributeError, OSError):
+    if host.WINDOWS:
+        import ctypes
 
-    SUPERUSER = bool(ctypes.windll.shell32.IsUserAnAdmin())
-else:
-    try:
-        SUPERUSER = os.geteuid() == 0
-    except AttributeError:
+        SUPERUSER = bool(ctypes.windll.shell32.IsUserAnAdmin())
+    else:
         try:
-            SUPERUSER = os.getuid() == 0
+            SUPERUSER = os.geteuid() == 0
         except AttributeError:
-            SUPERUSER = False
+            SUPERUSER = os.getuid() == 0
 
-HOSTNAME = platform.node()
+HOSTNAME = host.hostname()
 if host.WSL:
     HOSTNAME = f'{HOSTNAME} (WSL)'
 

nvitop/select.py

@@ -57,14 +57,14 @@
 from __future__ import annotations
 
 import argparse
-import getpass
+import contextlib
 import math
 import os
 import sys
 import warnings
 from typing import TYPE_CHECKING, Any, Callable, Iterable, Sequence, overload
 
-from nvitop.api import Device, GpuProcess, Snapshot, colored, human2bytes, libnvml
+from nvitop.api import Device, GpuProcess, Snapshot, colored, host, human2bytes, libnvml
 from nvitop.version import __version__
 
 
@@ -74,10 +74,10 @@
 
 __all__ = ['select_devices']
 
-try:
-    USERNAME = getpass.getuser()
-except ModuleNotFoundError:
-    USERNAME = os.getlogin()
+
+USERNAME = 'N/A'
+with contextlib.suppress(ImportError, OSError):
+    USERNAME = host.getuser()
 
 TTY = sys.stdout.isatty()