Документация Python неофициальный перевод

gc.md

149 строк · 16.8 КБ · обычная страница · сырой текст · скачать

1> **Источник:** https://python-all.ru/3.3/library/gc.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 28.11. [`gc`](https://python-all.ru/3.3/library/gc.html#module-gc) – Интерфейс сборщика мусора89Этот модуль предоставляет интерфейс к опциональному сборщику мусора. Он позволяет отключить сборщик, настроить частоту сборки и установить параметры отладки. Также предоставляет доступ к недостижимым объектам, которые сборщик нашёл, но не может освободить. Поскольку сборщик дополняет подсчёт ссылок, уже используемый в Python, вы можете отключить сборщик, если уверены, что ваша программа не создаёт циклические ссылки. Автоматическую сборку можно отключить вызовом `gc.disable()`. Для отладки программы с утечками вызовите `gc.set_debug(gc.DEBUG_LEAK)`. Обратите внимание, что это включает `gc.DEBUG_SAVEALL`, в результате чего объекты, собранные сборщиком мусора, сохраняются в gc.garbage для проверки.1011Модуль [`gc`](https://python-all.ru/3.3/library/gc.html#module-gc) предоставляет следующие функции:1213#### `gc.enable()`1415Включить автоматическую сборку мусора.1617#### `gc.disable()`1819Отключить автоматическую сборку мусора.2021#### `gc.isenabled()`2223Возвращает истину, если автоматическая сборка включена.2425#### `gc.collect(generations=2)`2627Без аргументов выполняет полную сборку. Необязательный аргумент *generation* может быть целым числом, указывающим, какое поколение собирать (от 0 до 2). Если номер поколения недействителен, возбуждается [`ValueError`](https://python-all.ru/3.3/library/exceptions.html#ValueError). Возвращается количество найденных недостижимых объектов.2829Свободные списки, поддерживаемые для ряда встроенных типов, очищаются при каждой полной сборке или сборке самого старшего поколения (2). Не все элементы в некоторых свободных списках могут быть освобождены из-за особенностей реализации, в частности [`float`](https://python-all.ru/3.3/library/functions.html#float).3031#### `gc.set_debug(flags)`3233Устанавливает флаги отладки сборки мусора. Отладочная информация будет записываться в `sys.stderr`. См. ниже список флагов отладки, которые можно комбинировать с помощью побитовых операций для управления отладкой.3435#### `gc.get_debug()`3637Возвращает текущие установленные флаги отладки.3839#### `gc.get_objects()`4041Возвращает список всех объектов, отслеживаемых сборщиком, за исключением возвращаемого списка.4243#### `gc.set_threshold(threshold0[, threshold1[, threshold2]])`4445Устанавливает пороги сборки мусора (частоту сборки). Установка *threshold0* в ноль отключает сборку.4647Сборщик мусора классифицирует объекты по трём поколениям в зависимости от того, сколько циклов сборки они пережили. Новые объекты помещаются в самое молодое поколение (поколение `0`). Если объект переживает сборку, он перемещается в следующее более старое поколение. Поскольку поколение `2` является самым старым, объекты в этом поколении остаются там после сборки. Чтобы решить, когда запускаться, сборщик отслеживает количество выделений и освобождений объектов с момента последней сборки. Когда количество выделений минус количество освобождений превышает *threshold0*, начинается сборка. Изначально проверяется только поколение `0`. Если поколение `0` проверялось более *threshold1* раз с тех пор, как проверялось поколение `1`, то также проверяется поколение `1`. Аналогично, *threshold2* управляет количеством сборок поколения `1` перед сборкой поколения `2`.4849#### `gc.get_count()`5051Возвращает текущие счётчики сборки в виде кортежа `(count0, count1, count2)`.5253#### `gc.get_threshold()`5455Возвращает текущие пороги сборки в виде кортежа `(threshold0, threshold1, threshold2)`.5657#### `gc.get_referrers(*objs)`5859Возвращает список объектов, которые напрямую ссылаются на любой из objs. Эта функция находит только те контейнеры, которые поддерживают сборку мусора; типы расширений, которые ссылаются на другие объекты, но не поддерживают сборку мусора, найдены не будут.6061Обратите внимание, что объекты, на которые уже нет ссылок, но которые находятся в циклах и ещё не были собраны сборщиком мусора, могут быть перечислены среди результирующих ссылающихся объектов. Чтобы получить только текущие живые объекты, вызовите [`collect()`](https://python-all.ru/3.3/library/gc.html#gc.collect) перед вызовом [`get_referrers()`](https://python-all.ru/3.3/library/gc.html#gc.get_referrers).6263Следует соблюдать осторожность при использовании объектов, возвращаемых [`get_referrers()`](https://python-all.ru/3.3/library/gc.html#gc.get_referrers), поскольку некоторые из них могут всё ещё находиться в процессе построения и, следовательно, во временно недействительном состоянии. Избегайте использования [`get_referrers()`](https://python-all.ru/3.3/library/gc.html#gc.get_referrers) для любых целей, кроме отладки.6465#### `gc.get_referents(*objs)`6667Возвращает список объектов, на которые непосредственно ссылается любой из аргументов. Возвращаемые референты – это объекты, посещаемые C-уровневым методом [`tp_traverse`](https://python-all.ru/3.3/c-api/typeobj.html#PyTypeObject.tp_traverse) аргументов (если он есть), и могут не включать все объекты, фактически достижимые напрямую. Методы [`tp_traverse`](https://python-all.ru/3.3/c-api/typeobj.html#PyTypeObject.tp_traverse) поддерживаются только объектами, которые поддерживают сборку мусора, и требуются только для посещения объектов, которые могут быть вовлечены в цикл. Так, например, если целое число напрямую достижимо из аргумента, этот объект целого числа может как появиться, так и не появиться в результирующем списке.6869#### `gc.is_tracked(obj)`7071Возвращает `True`, если объект в настоящее время отслеживается сборщиком мусора, и `False` в противном случае. Как правило, экземпляры атомарных типов не отслеживаются, а экземпляры неатомарных типов (контейнеры, пользовательские объекты...) отслеживаются. Однако могут присутствовать некоторые оптимизации для конкретных типов, чтобы уменьшить влияние на сборщик мусора для простых экземпляров (например, словари, содержащие только атомарные ключи и значения):7273```python74>>> gc.is_tracked(0)75False76>>> gc.is_tracked("a")77False78>>> gc.is_tracked([])79True80>>> gc.is_tracked({})81False82>>> gc.is_tracked({"a": 1})83False84>>> gc.is_tracked({"a": []})85True86```8788Новое в версии 3.1.8990Следующие переменные предназначены для доступа только для чтения (можно изменять их значения, но не следует их переназначать):9192#### `gc.garbage`9394Список объектов, которые сборщик счёл недостижимыми, но не смог освободить (несобираемые объекты). По умолчанию этот список содержит только объекты с методами [`__del__()`](https://python-all.ru/3.3/reference/datamodel.html#object.__del__). Объекты, имеющие методы [`__del__()`](https://python-all.ru/3.3/reference/datamodel.html#object.__del__) и входящие в циклическую ссылку, делают всю циклическую ссылку несобираемой, включая объекты, не обязательно находящиеся в цикле, но достижимые только из него. Python не собирает такие циклы автоматически, потому что, вообще говоря, Python не может угадать безопасный порядок выполнения методов [`__del__()`](https://python-all.ru/3.3/reference/datamodel.html#object.__del__). Если известен безопасный порядок, можно принудительно решить проблему, изучив список *garbage* и явно разрывая циклы, обусловленные вашими объектами в этом списке. Обратите внимание, что эти объекты остаются живыми благодаря нахождению в списке *garbage*, поэтому их также следует удалить из *garbage*. Например, после разрыва циклов выполните `del gc.garbage[:]`, чтобы очистить список. Обычно лучше избегать этой проблемы, не создавая циклы, содержащие объекты с методами [`__del__()`](https://python-all.ru/3.3/reference/datamodel.html#object.__del__); в таком случае можно проверить *garbage*, чтобы убедиться, что такие циклы не создаются.9596Если установлен [`DEBUG_SAVEALL`](https://python-all.ru/3.3/library/gc.html#gc.DEBUG_SAVEALL), то все недостижимые объекты будут добавлены в этот список, а не освобождены.9798Изменено в версии 3.2: Если при завершении интерпретатора этот список не пуст, выдается [`ResourceWarning`](https://python-all.ru/3.3/library/exceptions.html#ResourceWarning), которая по умолчанию молчалива. Если также установлен [`DEBUG_UNCOLLECTABLE`](https://python-all.ru/3.3/library/gc.html#gc.DEBUG_UNCOLLECTABLE), дополнительно выводятся все несобираемые объекты.99100#### `gc.callbacks`101102Список колбэков, которые будут вызываться сборщиком мусора до и после сборки. Колбэки будут вызываться с двумя аргументами: *phase* и *info*.103104*phase* может принимать одно из двух значений:105106> “start”: сборка мусора начинается.107>108> “stop”: сборка мусора завершена.109110*info* – это словарь, предоставляющий дополнительную информацию для колбэка. В настоящее время определены следующие ключи:111112> “generation”: самое старое поколение, участвующее в сборке.113>114> “collected”: когда *phase* равен “stop”, количество успешно собранных объектов.115>116> «uncollectable»: когда *phase* равен «stop», количество объектов, которые не удалось собрать и которые были помещены в [`garbage`](https://python-all.ru/3.3/library/gc.html#gc.garbage).117118Приложения могут добавлять свои собственные колбэки в этот список. Основные случаи использования:119120> Сбор статистики о сборке мусора, например, как часто собираются различные поколения и сколько времени занимает сборка.121>122> Позволяет приложениям определять и очищать свои собственные несобираемые типы, когда они появляются в [`garbage`](https://python-all.ru/3.3/library/gc.html#gc.garbage).123124Новое в версии 3.3.125126Следующие константы предоставляются для использования с [`set_debug()`](https://python-all.ru/3.3/library/gc.html#gc.set_debug):127128#### `gc.DEBUG_STATS`129130Вывод статистики во время сборки. Эта информация может быть полезна при настройке частоты сборки.131132#### `gc.DEBUG_COLLECTABLE`133134Вывод информации о найденных собираемых объектах.135136#### `gc.DEBUG_UNCOLLECTABLE`137138Выводит информацию о найденных несобираемых объектах (объекты, которые не являются достижимыми, но не могут быть освобождены сборщиком). Эти объекты будут добавлены в список `garbage`.139140Изменено в версии 3.2: Также выводить содержимое списка [`garbage`](https://python-all.ru/3.3/library/gc.html#gc.garbage) при завершении интерпретатора, если он не пуст.141142#### `gc.DEBUG_SAVEALL`143144Если установлен, все найденные недостижимые объекты будут добавляться в *garbage*, а не освобождаться. Это может быть полезно для отладки программы с утечками.145146#### `gc.DEBUG_LEAK`147148Флаги отладки, необходимые сборщику для вывода информации об утекающей программе (равны `DEBUG_COLLECTABLE | DEBUG_UNCOLLECTABLE | DEBUG_SAVEALL`).149