Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
29 changes: 29 additions & 0 deletions stubs/psutil/@tests/test_cases/check_optional_returns.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
"""Test cases for psutil functions that can return None at runtime."""

from __future__ import annotations

import sys
from typing_extensions import assert_type

import psutil
from psutil._ntuples import pionice, scpufreq, snetio

# cpu_freq() and net_io_counters() return None if the platform reports nothing.
assert_type(psutil.cpu_freq(), scpufreq | None)
assert_type(psutil.cpu_freq(percpu=True), list[scpufreq])
assert_type(psutil.net_io_counters(), snetio | None)
assert_type(psutil.net_io_counters(pernic=True), dict[str, snetio])

proc = psutil.Process()

# wait() returns None if the process is not a child of the current process.
assert_type(proc.wait(), int | None)

if sys.platform != "darwin":
# Getting returns the current value, setting returns None.
assert_type(proc.ionice(), pionice)
assert_type(proc.ionice(2), None)

if sys.platform == "linux":
assert_type(proc.rlimit(psutil.RLIMIT_NOFILE), tuple[int, int])
assert_type(proc.rlimit(psutil.RLIMIT_NOFILE, (1024, 4096)), None)
18 changes: 13 additions & 5 deletions stubs/psutil/psutil/__init__.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,11 @@ class Process:
def num_fds(self) -> int: ...
if sys.platform != "darwin":
def io_counters(self) -> _ntp.pio: ...
def ionice(self, ioclass: int | None = None, value: int | None = None) -> _ntp.pionice: ...

@overload
def ionice(self, ioclass: None = None, value: None = None) -> _ntp.pionice: ...
@overload
def ionice(self, ioclass: int, value: int | None = None) -> None: ...

@overload
def cpu_affinity(self, cpus: None = None) -> list[int]: ...
Expand All @@ -316,7 +320,11 @@ class Process:
def memory_maps(self, grouped: bool) -> list[_ntp.pmmap_grouped] | list[_ntp.pmmap_ext]: ...

if sys.platform == "linux":
def rlimit(self, resource: int, limits: tuple[int, int] | None = None) -> tuple[int, int]: ...
@overload
def rlimit(self, resource: int, limits: None = None) -> tuple[int, int]: ...
@overload
def rlimit(self, resource: int, limits: tuple[int, int]) -> None: ...

def cpu_num(self) -> int: ...

def environ(self) -> dict[str, str]: ...
Expand All @@ -340,7 +348,7 @@ class Process:
def resume(self) -> None: ...
def terminate(self) -> None: ...
def kill(self) -> None: ...
def wait(self, timeout: float | None = None) -> int: ...
def wait(self, timeout: float | None = None) -> int | None: ...
def net_connections(self, kind: str = "inet") -> list[_ntp.pconn]: ...

class Popen(Process):
Expand Down Expand Up @@ -432,7 +440,7 @@ def wait_procs(
def cpu_count(logical: bool = True) -> int | None: ...

@overload
def cpu_freq(percpu: Literal[False] = False) -> _ntp.scpufreq: ...
def cpu_freq(percpu: Literal[False] = False) -> _ntp.scpufreq | None: ...
@overload
def cpu_freq(percpu: Literal[True]) -> list[_ntp.scpufreq]: ...

Expand Down Expand Up @@ -469,7 +477,7 @@ def disk_io_counters(perdisk: Literal[False] = False, nowrap: bool = True) -> _n
def disk_io_counters(perdisk: Literal[True], nowrap: bool = True) -> dict[str, _ntp.sdiskio]: ...

@overload
def net_io_counters(pernic: Literal[False] = False, nowrap: bool = True) -> _ntp.snetio: ...
def net_io_counters(pernic: Literal[False] = False, nowrap: bool = True) -> _ntp.snetio | None: ...
@overload
def net_io_counters(pernic: Literal[True], nowrap: bool = True) -> dict[str, _ntp.snetio]: ...

Expand Down
Loading