pydoc > resource

man perldoc info pydoc3 ri search

📛 NAME

resource

🚀 Quick Reference

Use Case	Command	Description
🔍 Check CPU time limit	resource.getrlimit(resource.RLIMIT_CPU)	Returns (soft, hard) limits for CPU time in seconds
📂 Set open file limit	resource.setrlimit(resource.RLIMIT_NOFILE, (1024, 4096))	Sets soft limit to 1024, hard limit to 4096 file descriptors
📊 Measure memory usage	resource.getrusage(resource.RUSAGE_SELF).ru_maxrss	Returns max resident set size in kilobytes
📄 Get system page size	resource.getpagesize()	Returns page size in bytes
👥 Limit another process	resource.prlimit(pid, resource.RLIMIT_NPROC, (100, 200))	Sets max processes for given PID
🧒 Child process usage	resource.getrusage(resource.RUSAGE_CHILDREN)	Returns cumulative usage of all terminated children

📚 MODULE REFERENCE

https://docs.python.org/3.10/library/resource.html

The following documentation is automatically generated from the Python source files. It may be incomplete, incorrect or include features that are considered implementation detail and may vary between Python implementations. When in doubt, consult the module reference at the location listed above.

🏗️ CLASSES

builtins.tuple(builtins.object)

struct_rusage

📦 class struct_rusage(builtins.tuple)

struct_rusage: Result from getrusage.

This object may be accessed either as a tuple of

(utime,stime,maxrss,ixrss,idrss,isrss,minflt,majflt,nswap,inblock,oublock,msgsnd,msgrcv,nsignals,nvcsw,nivcsw)

or via the attributes ru_utime, ru_stime, ru_maxrss, and so on.

Method resolution order:

• struct_rusage
• builtins.tuple
• builtins.object

🔹 Methods defined here

• __reduce__(...) — Helper for pickle.
• __repr__(self, /) — Return repr(self).

🔹 Static methods defined here

• __new__(*args, **kwargs) from builtins.type — Create and return a new object. See help(type) for accurate signature.

🔹 Data descriptors defined here

• ru_idrss — unshared data size
• ru_inblock — block input operations
• ru_isrss — unshared stack size
• ru_ixrss — shared memory size
• ru_majflt — page faults requiring I/O
• ru_maxrss — max. resident set size
• ru_minflt — page faults not requiring I/O
• ru_msgrcv — IPC messages received
• ru_msgsnd — IPC messages sent
• ru_nivcsw — involuntary context switches
• ru_nsignals — signals received
• ru_nswap — number of swap outs
• ru_nvcsw — voluntary context switches
• ru_oublock — block output operations
• ru_stime — system time used
• ru_utime — user time used

🔹 Data and other attributes defined here

• __match_args__ = ('ru_utime', 'ru_stime', 'ru_maxrss', 'ru_ixrss', 'ru...')
• n_fields = 16
• n_sequence_fields = 16
• n_unnamed_fields = 0

🔹 Methods inherited from builtins.tuple

• __add__(self, value, /) — Return self+value.
• __contains__(self, key, /) — Return key in self.
• __eq__(self, value, /) — Return self==value.
• __ge__(self, value, /) — Return self>=value.
• __getattribute__(self, name, /) — Return getattr(self, name).
• __getitem__(self, key, /) — Return self[key].
• __getnewargs__(self, /)
• __gt__(self, value, /) — Return self>value.
• __hash__(self, /) — Return hash(self).
• __iter__(self, /) — Implement iter(self).
• __le__(self, value, /) — Return self<=value.
• __len__(self, /) — Return len(self).
• __lt__(self, value, /) — Return self<value.
• __mul__(self, value, /) — Return self*value.
• __ne__(self, value, /) — Return self!=value.
• __rmul__(self, value, /) — Return value*self.
• count(self, value, /) — Return number of occurrences of value.
• index(self, value, start=0, stop=9223372036854775807, /) — Return first index of value. Raises ValueError if the value is not present.

🔹 Class methods inherited from builtins.tuple

• __class_getitem__(...) from builtins.type — See PEP 585

⚙️ FUNCTIONS

• getpagesize() — Returns the system page size in bytes.
• getrlimit(resource, /) — Returns a tuple (soft, hard) of the current resource limit.
• getrusage(who, /) — Returns a struct_rusage object with resource usage for the current process, children, or thread.
• prlimit(pid, resource, [limits]) — Combines setrlimit and getrlimit; if limits is omitted, returns the current limit for pid; otherwise sets the limit and returns the old limit.
• setrlimit(resource, limits, /) — Sets new resource limits.

📊 DATA

• RLIMIT_AS = 9 — Address space limit
• RLIMIT_CORE = 4 — Core file size limit
• RLIMIT_CPU = 0 — CPU time limit
• RLIMIT_DATA = 2 — Data segment size limit
• RLIMIT_FSIZE = 1 — File size limit
• RLIMIT_MEMLOCK = 8 — Locked memory limit
• RLIMIT_MSGQUEUE = 12 — POSIX message queue limit
• RLIMIT_NICE = 13 — Nice value limit
• RLIMIT_NOFILE = 7 — Open file descriptors limit
• RLIMIT_NPROC = 6 — Number of processes limit
• RLIMIT_OFILE = 7 — (alias for RLIMIT_NOFILE)
• RLIMIT_RSS = 5 — Resident set size limit
• RLIMIT_RTPRIO = 14 — Real-time priority limit
• RLIMIT_RTTIME = 15 — Real-time CPU time limit
• RLIMIT_SIGPENDING = 11 — Pending signals limit
• RLIMIT_STACK = 3 — Stack size limit
• RLIM_INFINITY = -1 — No limit
• RUSAGE_CHILDREN = -1 — Usage for all terminated children
• RUSAGE_SELF = 0 — Usage for the calling process
• RUSAGE_THREAD = 1 — Usage for the calling thread

📁 FILE

/usr/lib/python3.10/lib-dynload/resource.cpython-310-x86_64-linux-gnu.so

📛 NAME 🚀 Quick Reference 📚 MODULE REFERENCE 🏗️ CLASSES ⚙️ FUNCTIONS 📊 DATA 📁 FILE