resource — 资源使用信息


此模块提供度量和控制程序利用系统资源的基本机制。

可用性 :Unix,非 WASI。

符号常量用于指定特定系统资源,并请求有关当前进程或其子级的使用信息。

An OSError 被引发当 syscall 故障时。

exception resource. error

被弃用别名化的 OSError .

3.3 版改变: 遵循 PEP 3151 ,此类是别名化的 OSError .

资源限制

可以限制资源的使用,使用 setrlimit() function described below. Each resource is controlled by a pair of limits: a soft limit and a hard limit. The soft limit is the current limit, and may be lowered or raised by a process over time. The soft limit can never exceed the hard limit. The hard limit can be lowered to any value greater than the soft limit, but not raised. (Only processes with the effective UID of the super-user can raise a hard limit.)

The specific resources that can be limited are system dependent. They are described in the getrlimit(2) man page. The resources listed below are supported when the underlying operating system supports them; resources which cannot be checked or controlled by the operating system are not defined in this module for those platforms.

resource. RLIM_INFINITY

Constant used to represent the limit for an unlimited resource.

resource. getrlimit ( resource )

返回元组 (soft, hard) with the current soft and hard limits of resource 。引发 ValueError if an invalid resource is specified, or error if the underlying system call fails unexpectedly.

resource. setrlimit ( resource , limits )

Sets new limits of consumption of resource limits argument must be a tuple (soft, hard) of two integers describing the new limits. A value of RLIM_INFINITY can be used to request a limit that is unlimited.

引发 ValueError if an invalid resource is specified, if the new soft limit exceeds the hard limit, or if a process tries to raise its hard limit. Specifying a limit of RLIM_INFINITY when the hard or system limit for that resource is not unlimited will result in a ValueError . A process with the effective UID of super-user can request any valid limit value, including unlimited, but ValueError will still be raised if the requested limit exceeds the system imposed limit.

setrlimit 还可能引发 error 若底层系统调用失败。

VxWorks 仅支持设置 RLIMIT_NOFILE .

引发 审计事件 resource.setrlimit 采用自变量 resource , limits .

resource. prlimit ( pid , resource [ , limits ] )

组合 setrlimit() and getrlimit() in one function and supports to get and set the resources limits of an arbitrary process. If pid is 0, then the call applies to the current process. resource and limits 拥有相同含义如在 setrlimit() ,除了 limits is optional.

limits is not given the function returns the resource limit of the process pid 。当 limits is given the resource limit of the process is set and the former resource limit is returned.

引发 ProcessLookupError pid can’t be found and PermissionError when the user doesn’t have CAP_SYS_RESOURCE for the process.

引发 审计事件 resource.prlimit 采用自变量 pid , resource , limits .

可用性 : Linux >= 2.6.36 with glibc >= 2.13.

Added in version 3.4.

These symbols define resources whose consumption can be controlled using the setrlimit() and getrlimit() functions described below. The values of these symbols are exactly the constants used by C programs.

The Unix man page for getrlimit(2) lists the available resources. Note that not all systems use the same symbol or same value to denote the same resource. This module does not attempt to mask platform differences — symbols not defined for a platform will not be available from this module on that platform.

resource. RLIMIT_CORE

The maximum size (in bytes) of a core file that the current process can create. This may result in the creation of a partial core file if a larger core would be required to contain the entire process image.

resource. RLIMIT_CPU

The maximum amount of processor time (in seconds) that a process can use. If this limit is exceeded, a SIGXCPU signal is sent to the process. (See the signal module documentation for information about how to catch this signal and do something useful, e.g. flush open files to disk.)

resource. RLIMIT_FSIZE

The maximum size of a file which the process may create.

resource. RLIMIT_DATA

The maximum size (in bytes) of the process’s heap.

resource. RLIMIT_STACK

The maximum size (in bytes) of the call stack for the current process. This only affects the stack of the main thread in a multi-threaded process.

resource. RLIMIT_RSS

The maximum resident set size that should be made available to the process.

resource. RLIMIT_NPROC

The maximum number of processes the current process may create.

resource. RLIMIT_NOFILE

The maximum number of open file descriptors for the current process.

resource. RLIMIT_OFILE

The BSD name for RLIMIT_NOFILE .

resource. RLIMIT_MEMLOCK

The maximum address space which may be locked in memory.

resource. RLIMIT_VMEM

The largest area of mapped memory which the process may occupy.

可用性 : FreeBSD >= 11.

resource. RLIMIT_AS

The maximum area (in bytes) of address space which may be taken by the process.

resource. RLIMIT_MSGQUEUE

The number of bytes that can be allocated for POSIX message queues.

可用性 : Linux >= 2.6.8.

Added in version 3.4.

resource. RLIMIT_NICE

The ceiling for the process’s nice level (calculated as 20 - rlim_cur).

可用性 : Linux >= 2.6.12.

Added in version 3.4.

resource. RLIMIT_RTPRIO

The ceiling of the real-time priority.

可用性 : Linux >= 2.6.12.

Added in version 3.4.

resource. RLIMIT_RTTIME

The time limit (in microseconds) on CPU time that a process can spend under real-time scheduling without making a blocking syscall.

可用性 : Linux >= 2.6.25.

Added in version 3.4.

resource. RLIMIT_SIGPENDING

The number of signals which the process may queue.

可用性 : Linux >= 2.6.8.

Added in version 3.4.

resource. RLIMIT_SBSIZE

The maximum size (in bytes) of socket buffer usage for this user. This limits the amount of network memory, and hence the amount of mbufs, that this user may hold at any time.

可用性 : FreeBSD.

Added in version 3.4.

resource. RLIMIT_SWAP

The maximum size (in bytes) of the swap space that may be reserved or used by all of this user id’s processes. This limit is enforced only if bit 1 of the vm.overcommit sysctl is set. Please see tuning(7) for a complete description of this sysctl.

可用性 : FreeBSD.

Added in version 3.4.

resource. RLIMIT_NPTS

The maximum number of pseudo-terminals created by this user id.

可用性 : FreeBSD.

Added in version 3.4.

resource. RLIMIT_KQUEUES

The maximum number of kqueues this user id is allowed to create.

可用性 : FreeBSD >= 11.

3.10 版添加。

资源使用情况

这些函数用于检索资源使用信息:

resource. getrusage ( who )

This function returns an object that describes the resources consumed by either the current process or its children, as specified by the who parameter. The who parameter should be specified using one of the RUSAGE_* constants described below.

简单范例:

from resource import *
import time
# a non CPU-bound task
time.sleep(3)
print(getrusage(RUSAGE_SELF))
# a CPU-bound task
for i in range(10 ** 8):
   _ = 1 + 1
print(getrusage(RUSAGE_SELF))