sdkagent

psutil API reference

103 public APIs from psutil (giampaolo/psutil) — 12 classes, 63 functions, 28 methods. Signatures extracted by static analysis of the actual source.

Repository: giampaolo/psutil

KindCount
Classes12
Functions63
Methods28

API list

class.github.workflows.triage_labels.BadDecision
The model's tool call doesn't match the schema.
func.github.workflows.triage_labels.add_labels(number, labels)
Add labels to a ticket.
func.github.workflows.triage_labels.classify(client, title, body, files)
Ask Claude which labels apply.
classpsutil.Process
Represents an OS process identified by a PID.
methodpsutil.Process.cmdline() -> list[str]
The command line this process has been called with.
methodpsutil.Process.cpu_affinity(cpus:list[int] | None=None) -> list[int] | None
Get or set process CPU affinity.
methodpsutil.Process.cpu_num() -> int
Return what CPU this process is currently running on.
methodpsutil.Process.cwd() -> str
Process current working directory as an absolute path.
methodpsutil.Process.environ() -> dict[str, str]
The environment variables of the process as a dict.
methodpsutil.Process.exe() -> str
The process executable as an absolute path.
methodpsutil.Process.gids() -> pgids
Return process GIDs as a `(real, effective, saved)` named tuple.
methodpsutil.Process.info() -> dict
Return pre-fetched `process_iter()` info dict.
methodpsutil.Process.ionice(ioclass:int | None=None, value:int | None=None) -> pionice | ProcessIOPriority | None
Get or set process I/O niceness (priority).
methodpsutil.Process.is_running() -> bool
Return whether this process is running.
methodpsutil.Process.name() -> str
The process name.
methodpsutil.Process.nice(value:int | None=None) -> int | None
Get or set process niceness (priority).
methodpsutil.Process.num_threads() -> int
Return the number of threads used by this process.
methodpsutil.Process.pid() -> int
The process PID.
methodpsutil.Process.ppid() -> int
The process parent PID.
methodpsutil.Process.rlimit(resource:int, limits:tuple[int, int] | None=None) -> tuple[int, int] | None
Get or set process resource limits as a `(soft, hard)` tuple.
methodpsutil.Process.status() -> ProcessStatus | str
The process current status as a `STATUS_` constant.
methodpsutil.Process.terminal() -> str | None
The terminal associated with this process, if any, else None.
methodpsutil.Process.uids() -> puids
Return process UIDs as a `(real, effective, saved)` named tuple.
methodpsutil.Process.username() -> str
The name of the user that owns the process.
classpsutil._common.AccessDenied
Exception raised when permission to perform an action is denied.
classpsutil._common.Error
Base exception class.
classpsutil._common.ZombieProcess
Exception raised when querying a zombie process.
funcpsutil._common.bcat(fname, fallback=_DEFAULT)
Same as above but opens file in binary mode.
funcpsutil._common.bytes2human(n, format='%(value).1f%(symbol)s')
Used by various scripts.
funcpsutil._common.cache_activate(proc)
Activate cache.
funcpsutil._common.cache_deactivate(proc)
Deactivate and clear cache.
funcpsutil._common.get_procfs_path()
Return updated psutil.PROCFS_PATH constant.
funcpsutil._common.warn(msg)
Emit a RuntimeWarning.
classpsutil._psaix.Process
Wrapper class around underlying C implementation.
funcpsutil._psaix.cpu_stats()
Return various CPU stats as a named tuple.
funcpsutil._psaix.disk_partitions(all=False)
Return system disk partitions.
funcpsutil._psaix.net_connections(kind, _pid=-1)
Return socket connections.
funcpsutil._psaix.net_if_stats()
Get NIC stats (isup, duplex, speed, mtu).
funcpsutil._psaix.pid_exists(pid)
Check for the existence of a unix pid.
classpsutil._psbsd.Process
Wrapper class around underlying C implementation.
methodpsutil._psbsd.Process.cwd()
Return process current working directory.
funcpsutil._psbsd.adjust_proc_create_time(ctime)
Account for system clock updates.
funcpsutil._psbsd.cpu_freq()
Return frequency metrics for CPUs.
funcpsutil._psbsd.cpu_stats()
Return various CPU stats as a named tuple.
funcpsutil._psbsd.net_connections(kind)
System-wide network connections.
funcpsutil._psbsd.net_if_stats()
Get NIC stats (isup, duplex, speed, mtu).
funcpsutil._psbsd.per_cpu_times()
Return system CPU times as a named tuple.
funcpsutil._psbsd.sensors_battery()
Return battery info.
classpsutil._pslinux.Process
Linux process implementation.
methodpsutil._pslinux.Process.cpu_num()
What CPU the process is on.
funcpsutil._pslinux.cpu_freq()
Return frequency metrics for all CPUs.
funcpsutil._pslinux.cpu_stats()
Return various CPU stats as a named tuple.
funcpsutil._pslinux.net_connections(kind='inet')
Return system-wide open connections.
funcpsutil._pslinux.net_if_stats()
Get NIC stats (isup, duplex, speed, mtu).
funcpsutil._pslinux.pid_exists(pid)
Check for the existence of a unix PID.
funcpsutil._pslinux.readlink(path)
Wrapper around os.readlink().
funcpsutil._pslinux.sensors_battery()
Return battery information.
funcpsutil._pslinux.swap_memory()
Return swap memory metrics.
funcpsutil._pslinux.virtual_memory()
Report virtual memory stats.
classpsutil._psosx.Process
Wrapper class around underlying C implementation.
funcpsutil._psosx.adjust_proc_create_time(ctime)
Account for system clock updates.
funcpsutil._psosx.cpu_freq()
Return CPU frequency.
funcpsutil._psosx.cpu_times()
Return system CPU times as a named tuple.
funcpsutil._psosx.net_connections(kind='inet')
System-wide network connections.
funcpsutil._psosx.net_if_stats()
Get NIC stats (isup, duplex, speed, mtu).
funcpsutil._psosx.per_cpu_times()
Return system CPU times as a named tuple.
funcpsutil._psosx.sensors_battery()
Return battery information.
funcpsutil._psosx.virtual_memory()
System virtual memory as a named tuple.
funcpsutil._psposix.disk_usage(path)
Return disk usage associated with path.
classpsutil._pssunos.Process
Wrapper class around underlying C implementation.
funcpsutil._pssunos.cpu_stats()
Return various CPU stats as a named tuple.
funcpsutil._pssunos.disk_partitions(all=False)
Return system disk partitions.
funcpsutil._pssunos.net_connections(kind, _pid=-1)
Return socket connections.
funcpsutil._pssunos.net_if_stats()
Get NIC stats (isup, duplex, speed, mtu).
funcpsutil._pssunos.pid_exists(pid)
Check for the existence of a unix pid.
funcpsutil._pssunos.swap_memory()
Report swap memory metrics.
funcpsutil._pssunos.virtual_memory()
Report virtual memory metrics.
classpsutil._pswindows.Process
Wrapper class around underlying C implementation.
classpsutil._pswindows.WindowsService
Represents an installed Windows service.
methodpsutil._pswindows.WindowsService.description() -> str
Service long description.
methodpsutil._pswindows.WindowsService.display_name() -> str
The service display name.
methodpsutil._pswindows.WindowsService.name() -> str
The service name.
methodpsutil._pswindows.WindowsService.pid() -> int | None
The process PID, if any, else None.
methodpsutil._pswindows.WindowsService.status() -> str
Service status as a string.
methodpsutil._pswindows.WindowsService.username() -> str
The name of the user that owns this service.
funcpsutil._pswindows.cpu_freq()
Return CPU frequency.
funcpsutil._pswindows.cpu_stats()
Return CPU statistics.
funcpsutil._pswindows.cpu_times()
Return system CPU times as a named tuple.
funcpsutil._pswindows.disk_partitions(all)
Return disk partitions.
funcpsutil._pswindows.disk_usage(path)
Return disk usage associated with path.
funcpsutil._pswindows.net_connections(kind, _pid=-1)
Return socket connections.
funcpsutil._pswindows.net_if_stats()
Get NIC stats (isup, duplex, speed, mtu).
funcpsutil._pswindows.sensors_battery()
Return battery information.
funcpsutil._pswindows.virtual_memory()
System virtual memory as a named tuple.
funcpsutil.cpu_stats() -> scpustats
Return CPU statistics.
funcpsutil.cpu_times(percpu:bool=False) -> scputimes | list[scputimes]
Return system-wide CPU times as a named tuple.
funcpsutil.pid_exists(pid:int) -> bool
Return True if *pid* exists in the current process list.
funcpsutil.pids() -> list[int]
Return a list of current running PIDs.
funcpsutil.sensors_battery() -> sbattery | None
Return battery information.
funcpsutil.sensors_fans() -> dict[str, list[sfan]]
Return fans speed.
funcpsutil.sensors_temperatures(fahrenheit:bool=False) -> dict[str, list[shwtemp]]
Return hardware temperatures.
funcpsutil.virtual_memory() -> svmem
Return statistics about system memory usage as a named tuple.
funcpsutil.win_service_get(name) -> WindowsService
Get a Windows service by *name*.

About this data

These signatures were extracted from the public source of giampaolo/psutil using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries