gc.md

1> **Источник:** https://python-all.ru/3.8/library/gc.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`gc`](https://python-all.ru/3.8/library/gc.html#module-gc) – интерфейс сборщика мусора89---1011Этот модуль предоставляет интерфейс к необязательному сборщику мусора. Он позволяет отключить сборщик, настроить частоту сборки и установить параметры отладки. Также он предоставляет доступ к недостижимым объектам, которые сборщик нашел, но не может освободить. Поскольку сборщик дополняет подсчёт ссылок, уже используемый в Python, его можно отключить, если программа не создаёт циклических ссылок. Автоматическую сборку можно отключить вызовом `gc.disable()`. Для отладки утекающей программы вызовите `gc.set_debug(gc.DEBUG_LEAK)`. Обратите внимание, что это включает `gc.DEBUG_SAVEALL`, что приводит к сохранению собранных объектов в gc.garbage для проверки.1213Модуль [`gc`](https://python-all.ru/3.8/library/gc.html#module-gc) предоставляет следующие функции:1415#### `gc.enable()`1617Включить автоматическую сборку мусора.1819#### `gc.disable()`2021Отключить автоматическую сборку мусора.2223#### `gc.isenabled()`2425Возвращает `True`, если автоматическая сборка включена.2627#### `gc.collect(generation=2)`2829Без аргументов выполняет полную сборку. Необязательный аргумент *поколение* может быть целым числом, указывающим, какое поколение собирать (от 0 до 2). Если номер поколения неверен, вызывается исключение [`ValueError`](https://python-all.ru/3.8/library/exceptions.html#ValueError). Возвращается количество найденных недостижимых объектов.3031Списки свободной памяти, ведущиеся для ряда встроенных типов, очищаются при полной сборке или сборке самого старшего поколения (2). Не все элементы в некоторых списках свободной памяти могут быть освобождены из-за особенностей реализации, в частности [`float`](https://python-all.ru/3.8/library/functions.html#float).3233#### `gc.set_debug(flags)`3435Устанавливает флаги отладки сборщика мусора. Отладочная информация будет записываться в `sys.stderr`. См. ниже список флагов отладки, которые можно комбинировать с помощью битовых операций для управления отладкой.3637#### `gc.get_debug()`3839Возвращает текущие установленные флаги отладки.4041#### `gc.get_objects(generation=None)`4243Возвращает список всех объектов, отслеживаемых сборщиком, за исключением возвращаемого списка. Если *generation* не равно None, возвращает только объекты, отслеживаемые сборщиком и находящиеся в этом поколении.4445Изменено в версии 3.8: Новый параметр *generation*.4647Вызывает [событие аудита](https://python-all.ru/3.8/library/sys.html#auditing) `gc.get_objects` с аргументом `generation`.4849#### `gc.get_stats()`5051Возвращает список из трёх словарей по поколениям, содержащих статистику сборки с момента запуска интерпретатора. Количество ключей может измениться в будущем, но в настоящее время каждый словарь содержит следующие элементы:5253- `collections` – количество сборок этого поколения;54- `collected` – общее количество объектов, собранных в этом поколении;55- `uncollectable` – общее количество объектов, признанных не подлежащими сборке (и поэтому перемещённых в список [`garbage`](https://python-all.ru/3.8/library/gc.html#gc.garbage)) в этом поколении.5657Новое в версии 3.4.5859#### `gc.set_threshold(threshold0[, threshold1[, threshold2]])`6061Устанавливает пороги сборки мусора (частоту сборки). Установка *threshold0* в ноль отключает сборку.6263Сборщик мусора (GC) классифицирует объекты по трём поколениям в зависимости от того, сколько циклов сборки они пережили. Новые объекты помещаются в самое молодое поколение (поколение `0`). Если объект переживает сборку, он перемещается в следующее, более старое поколение. Поскольку поколение `2` является самым старым, объекты в этом поколении остаются там после сборки. Чтобы решить, когда запускать сборку, сборщик отслеживает количество выделений и освобождений объектов с момента последней сборки. Когда количество выделений минус количество освобождений превышает *threshold0*, сборка начинается. Изначально проверяется только поколение `0`. Если поколение `0` проверялось больше *threshold1* раз с момента проверки поколения `1`, то проверяется также поколение `1`. С третьим поколением ситуация немного сложнее: подробнее см. [Collecting the oldest generation](https://python-all.ru/3.8/library/gc.html).6465#### `gc.get_count()`6667Возвращает текущие счётчики сборок в виде кортежа из `(count0, count1, count2)`.6869#### `gc.get_threshold()`7071Возвращает текущие пороговые значения сборок в виде кортежа из `(threshold0, threshold1, threshold2)`.7273#### `gc.get_referrers(*objs)`7475Возвращает список объектов, которые напрямую ссылаются на любой из objs. Эта функция находит только те контейнеры, которые поддерживают сборку мусора; типы расширений, которые ссылаются на другие объекты, но не поддерживают сборку мусора, найдены не будут.7677Обратите внимание, что объекты, на которые уже нет ссылок, но которые находятся в циклах и ещё не собраны сборщиком мусора, могут оказаться среди возвращаемых ссылающихся объектов. Чтобы получить только живые объекты, вызовите [`collect()`](https://python-all.ru/3.8/library/gc.html#gc.collect) перед вызовом [`get_referrers()`](https://python-all.ru/3.8/library/gc.html#gc.get_referrers).7879> **Предупреждение**80>81> Следует соблюдать осторожность при использовании объектов, возвращаемых [`get_referrers()`](https://python-all.ru/3.8/library/gc.html#gc.get_referrers), поскольку некоторые из них могут всё ещё находиться в процессе конструирования и, следовательно, во временно недопустимом состоянии. Избегайте использования [`get_referrers()`](https://python-all.ru/3.8/library/gc.html#gc.get_referrers) для каких-либо целей, кроме отладки.8283Вызывает [событие аудита](https://python-all.ru/3.8/library/sys.html#auditing) `gc.get_referrers` с аргументом `objs`.8485#### `gc.get_referents(*objs)`8687Возвращает список объектов, на которые напрямую ссылается любой из аргументов. Возвращаемые референты – это объекты, посещённые C-уровневыми методами [`tp_traverse`](https://python-all.ru/3.8/c-api/typeobj.html#c.PyTypeObject.tp_traverse) аргументов (если они есть), и это могут быть не все объекты, действительно достижимые напрямую. Методы [`tp_traverse`](https://python-all.ru/3.8/c-api/typeobj.html#c.PyTypeObject.tp_traverse) поддерживаются только объектами, которые поддерживают сборку мусора, и от них требуется только посещение объектов, которые могут участвовать в циклах. Так, например, если целое число напрямую достижимо из аргумента, этот целочисленный объект может как появиться в результирующем списке, так и нет.8889Вызывает [событие аудита](https://python-all.ru/3.8/library/sys.html#auditing) `gc.get_referents` с аргументом `objs`.9091#### `gc.is_tracked(obj)`9293Возвращает `True`, если объект в настоящее время отслеживается сборщиком мусора, и `False` в противном случае. Как правило, экземпляры атомарных типов не отслеживаются, а экземпляры неатомарных типов (контейнеры, пользовательские объекты и т.д.) отслеживаются. Однако могут присутствовать некоторые оптимизации для конкретных типов, чтобы уменьшить влияние на сборщик мусора простых экземпляров (например, словарей, содержащих только атомарные ключи и значения):9495```python96>>> gc.is_tracked(0)97False98>>> gc.is_tracked("a")99False100>>> gc.is_tracked([])101True102>>> gc.is_tracked({})103False104>>> gc.is_tracked({"a": 1})105False106>>> gc.is_tracked({"a": []})107True108```109110Новое в версии 3.1.111112#### `gc.freeze()`113114Замораживает все объекты, отслеживаемые gc, – перемещает их в постоянное поколение и игнорирует все будущие сборки. Это можно использовать перед вызовом POSIX fork(), чтобы сделать gc дружественным к copy-on-write или ускорить сборку. Кроме того, сборка перед вызовом POSIX fork() может освободить страницы для будущих выделений, что тоже может вызвать copy-on-write, поэтому рекомендуется отключать gc в родительском процессе и замораживать перед fork, а включать gc в дочернем процессе.115116Добавлено в версии 3.7.117118#### `gc.unfreeze()`119120Размораживает объекты в постоянном поколении, возвращает их обратно в самое старое поколение.121122Добавлено в версии 3.7.123124#### `gc.get_freeze_count()`125126Возвращает количество объектов в постоянном поколении.127128Добавлено в версии 3.7.129130Следующие переменные предназначены для доступа только для чтения (можно изменять их значения, но не следует их переназначать):131132#### `gc.garbage`133134Список объектов, которые сборщик обнаружил как недостижимые, но не смог освободить (неподлежащие сборке объекты). Начиная с Python 3.4, этот список в большинстве случаев должен быть пуст, за исключением использования экземпляров типов расширений C с не-`NULL` слотом `tp_del`.135136Если [`DEBUG_SAVEALL`](https://python-all.ru/3.8/library/gc.html#gc.DEBUG_SAVEALL) установлено, то все недостижимые объекты будут добавлены в этот список, а не освобождены.137138Изменено в версии 3.2: Если этот список не пуст при [завершении интерпретатора](https://python-all.ru/3.8/glossary.html#term-interpreter-shutdown), выдается [`ResourceWarning`](https://python-all.ru/3.8/library/exceptions.html#ResourceWarning), который по умолчанию является молчаливым. Если [`DEBUG_UNCOLLECTABLE`](https://python-all.ru/3.8/library/gc.html#gc.DEBUG_UNCOLLECTABLE) установлено, дополнительно выводятся все неподлежащие сборке объекты.139140Изменено в версии 3.4: В соответствии с [**PEP 442**](https://python-all.ru/3.8/library/gc.html), объекты с методом [`__del__()`](https://python-all.ru/3.8/reference/datamodel.html#object.__del__) больше не попадают в [`gc.garbage`](https://python-all.ru/3.8/library/gc.html#gc.garbage).141142#### `gc.callbacks`143144Список колбэков, которые будут вызываться сборщиком мусора до и после сборки. Колбэки будут вызываться с двумя аргументами: *phase* и *info*.145146*phase* может принимать одно из двух значений:147148> “start”: сборка мусора начинается.149>150> “stop”: сборка мусора завершена.151152*info* – это словарь, предоставляющий дополнительную информацию для колбэка. В настоящее время определены следующие ключи:153154> “generation”: самое старое поколение, участвующее в сборке.155>156> “collected”: когда *phase* равен “stop”, количество успешно собранных объектов.157>158> “uncollectable”: когда *phase* равен “stop”, количество объектов, которые не удалось собрать и которые были помещены в [`garbage`](https://python-all.ru/3.8/library/gc.html#gc.garbage).159160Приложения могут добавлять свои собственные колбэки в этот список. Основные случаи использования:161162> Сбор статистики о сборке мусора, например, как часто собираются различные поколения и сколько времени занимает сборка.163>164> Позволяет приложениям выявлять и очищать собственные несобираемые типы, когда они появляются в [`garbage`](https://python-all.ru/3.8/library/gc.html#gc.garbage).165166Новое в версии 3.3.167168Следующие константы предоставляются для использования с [`set_debug()`](https://python-all.ru/3.8/library/gc.html#gc.set_debug):169170#### `gc.DEBUG_STATS`171172Вывод статистики во время сборки. Эта информация может быть полезна при настройке частоты сборки.173174#### `gc.DEBUG_COLLECTABLE`175176Вывод информации о найденных собираемых объектах.177178#### `gc.DEBUG_UNCOLLECTABLE`179180Вывод информации о найденных несобираемых объектах (объекты, которые недостижимы, но не могут быть освобождены сборщиком). Эти объекты будут добавлены в список `garbage`.181182Изменено в версии 3.2: Также выводить содержимое списка [`garbage`](https://python-all.ru/3.8/library/gc.html#gc.garbage) при [завершении интерпретатора](https://python-all.ru/3.8/glossary.html#term-interpreter-shutdown), если он не пуст.183184#### `gc.DEBUG_SAVEALL`185186Если установлен, все найденные недостижимые объекты будут добавляться в *garbage*, а не освобождаться. Это может быть полезно для отладки программы с утечками.187188#### `gc.DEBUG_LEAK`189190Флаги отладки, необходимые для вывода сборщиком информации о программе с утечками (равно `DEBUG_COLLECTABLE | DEBUG_UNCOLLECTABLE | DEBUG_SAVEALL`).191