resource — Информация об использовании ресурсов

Этот модуль предоставляет базовые механизмы для измерения и управления системными ресурсами, используемыми программой.

Символьные константы используются для указания конкретных системных ресурсов и для запроса информации об использовании текущего процесса или его дочерних процессов.

Определена единственная исключительная ситуация для ошибок:

exception resource.error

Описанные ниже функции могут вызвать эту ошибку, если возникает непредвиденное неудачное выполнение системного вызова.

1. Пределы использования ресурсов

Использование ресурсов может быть ограничено с помощью функции setrlimit(), описанной ниже. Каждый ресурс контролируется парой пределов: мягким пределом и жёстким пределом. Мягкий предел — текущий предел, который процесс может изменять со временем. Мягкий предел никогда не может превышать жёсткий предел. Жёсткий предел может быть уменьшен до любого значения, большего, чем мягкий предел, но не увеличен. (Только процессы с эффективным UID суперпользователя могут повысить жёсткий предел.)

Конкретные ресурсы, которые могут быть ограничены, зависят от системы. Они описаны в справке getrlimit(2). Перечисленные ниже ресурсы поддерживаются, когда это поддерживается базовой операционной системой; ресурсы, которые не могут быть проверены или контролируются операционной системой, в этом модуле не определены для этих платформ.

resource.RLIM_INFINITY

Константа, используемая для представления предела неограниченного ресурса.

resource.getrlimit(resource)

Возвращает кортеж (soft, hard) с текущими мягким и жёстким пределами resource. Вызывает ValueError, если указан недопустимый ресурс, или error, если системный вызов завершается неудачно.

resource.setrlimit(resource, limits)

Устанавливает новые пределы потребления resource. Аргумент limits должен быть кортежем (soft, hard) из двух целых чисел, описывающих новые пределы. Значение RLIM_INFINITY может быть использовано для запроса предела, который не ограничен.

Вызывает ValueError, если указан недопустимый ресурс, если новый мягкий предел превышает жёсткий предел или если процесс пытается повысить свой жёсткий предел. Указание предела RLIM_INFINITY, когда жёсткий или системный предел для этого ресурса не неограничен, приведёт к ValueError. Процесс с эффективным UID суперпользователя может запросить любое допустимое значение предела, включая неограниченное, но ValueError по-прежнему будет вызвано, если запрашиваемый предел превышает системный ограниченный предел.

setrlimit также может вызвать error, если системный вызов завершится неудачно.

Эти символы определяют ресурсы, потребление которых может быть контролировано с помощью функций setrlimit() и getrlimit(), описанных ниже. Значения этих символов точно соответствуют константам, используемым программами C.

В справке Unix для getrlimit(2) перечислены доступные ресурсы. Обратите внимание, что не все системы используют один и тот же символ или значение для обозначения одного и того же ресурса. Этот модуль не пытается скрыть различия между платформами — символы, не определённые для платформы, недоступны в этом модуле на этой платформе.

resource.RLIMIT_CORE

Максимальный размер (в байтах) файла ядра, который может создать текущий процесс. Это может привести к созданию частичного файла ядра, если для хранения всего образа процесса потребовался бы больший файл ядра.

resource.RLIMIT_CPU

Максимальное время процессора (в секундах), которое может использовать процесс. Если этот предел превышен, процессу отправляется сигнал SIGXCPU. (См. документацию модуля signal для получения информации о том, как перехватить этот сигнал и выполнить полезные действия, например, записать открытые файлы на диск.)

resource.RLIMIT_FSIZE

Максимальный размер файла, который может создать процесс.

resource.RLIMIT_DATA

Максимальный размер (в байтах) кучи процесса.

resource.RLIMIT_STACK

Максимальный размер (в байтах) стека вызовов для текущего процесса. Это влияет только на стек основного потока в многопоточном процессе.

resource.RLIMIT_RSS

Максимальный размер резидентного набора, который должен быть предоставлен процессу.

resource.RLIMIT_NPROC

Максимальное количество процессов, которые может создать текущий процесс.

resource.RLIMIT_NOFILE

Максимальное количество открытых дескрипторов файлов для текущего процесса.

resource.RLIMIT_OFILE

Имя BSD для RLIMIT_NOFILE.

resource.RLIMIT_MEMLOCK

Максимальный адресной пространство, которое может быть заблокировано в памяти.

resource.RLIMIT_VMEM

Наибольшая область отображённой памяти, которую может занимать процесс.

resource.RLIMIT_AS

Максимальная область (в байтах) адресного пространства, которое может занять процесс.

2. Использование ресурсов

Эти функции используются для получения информации об использовании ресурсов:

resource.getrusage(who)

Эта функция возвращает объект, описывающий ресурсы, потребляемые либо текущим процессом, либо его дочерними процессами, как указано параметром who. Параметр who должен быть задан с помощью одной из RUSAGE_* констант, описанных ниже.

Поля возвращаемого значения описывают, как был использован конкретный системный ресурс, например, количество времени, потраченного на выполнение в пользовательском режиме, или количество раз, когда процесс был вытеснен из основной памяти. Некоторые значения зависят от внутреннего интервала тактов часов, например, количество памяти, используемой процессом.

Для обратной совместимости возвращаемое значение также доступно как кортеж из 16 элементов.

Поля ru_utime и ru_stime возвращаемого значения — это значения с плавающей точкой, представляющие количество времени, потраченное на выполнение в пользовательском режиме и в системном режиме соответственно. Остальные значения — целые числа. Подробную информацию о значениях см. в справке getrusage(2). Здесь приведён краткий обзор:

Индекс	Поле	Ресурс
0	ru_utime	время в пользовательском режиме (float)
1	ru_stime	время в системном режиме (float)
2	ru_maxrss	максимальный размер резидентного набора
3	ru_ixrss	размер общей памяти
4	ru_idrss	размер незащищённой памяти
5	ru_isrss	размер незащищённого стека
6	ru_minflt	страничные нарушения, не требующие ввода/вывода
7	ru_majflt	страничные нарушения, требующие ввода/вывода
8	ru_nswap	количество перестановок
9	ru_inblock	операции ввода блоков
10	ru_oublock	операции вывода блоков
11	ru_msgsnd	отправленные сообщения
12	ru_msgrcv	полученные сообщения
13	ru_nsignals	полученные сигналы
14	ru_nvcsw	добровольные переключения контекста
15	ru_nivcsw	вынужденные переключения контекста

Эта функция вызовет ValueError, если указан недопустимый параметр who. Она также может вызвать исключение error в необычных ситуациях.

Изменено в версии 2.3: Добавлен доступ к значениям в качестве атрибутов возвращаемого объекта.

resource.getpagesize()

Возвращает количество байтов в системной странице. (Это необязательно должно совпадать с размером страницы оборудования.)

Следующие RUSAGE_* символы передаются функции getrusage(), чтобы указать, информация о каких процессах должна быть предоставлена.

resource.RUSAGE_SELF

RUSAGE_SELF следует использовать для запроса информации, относящейся только к самому процессу.

resource.RUSAGE_CHILDREN

Передайте getrusage(), чтобы запросить информацию о ресурсах для дочерних процессов вызывающего процесса.

resource.RUSAGE_BOTH

Передайте getrusage(), чтобы запросить ресурсы, потребляемые как текущим процессом, так и дочерними процессами. Может быть недоступно на всех системах.