gc.md

1> **Источник:** https://python-all.ru/3.12/library/gc.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `gc` – интерфейс сборщика мусора89---1011Этот модуль предоставляет интерфейс к необязательному сборщику мусора. Он позволяет отключить сборщик, настроить частоту сборки и установить параметры отладки. Также он предоставляет доступ к недостижимым объектам, которые сборщик нашел, но не может освободить. Поскольку сборщик дополняет подсчёт ссылок, уже используемый в Python, его можно отключить, если программа не создаёт циклических ссылок. Автоматическую сборку можно отключить вызовом `gc.disable()`. Для отладки утекающей программы вызовите `gc.set_debug(gc.DEBUG_LEAK)`. Обратите внимание, что это включает `gc.DEBUG_SAVEALL`, что приводит к сохранению собранных объектов в gc.garbage для проверки.1213Модуль [`gc`](https://python-all.ru/3.12/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.12/library/exceptions.html#ValueError). Возвращается количество найденных недостижимых объектов.3031Списки свободной памяти, ведущиеся для ряда встроенных типов, очищаются при полной сборке или сборке самого старшего поколения (2). Не все элементы в некоторых списках свободной памяти могут быть освобождены из-за особенностей реализации, в частности [`float`](https://python-all.ru/3.12/library/functions.html#float).3233Эффект от вызова `gc.collect()`, когда интерпретатор уже выполняет сборку, не определён.3435#### `gc.set_debug(flags)`3637Устанавливает флаги отладки сборщика мусора. Отладочная информация будет записываться в `sys.stderr`. См. ниже список флагов отладки, которые можно комбинировать с помощью битовых операций для управления отладкой.3839#### `gc.get_debug()`4041Возвращает текущие установленные флаги отладки.4243#### `gc.get_objects(generation=None)`4445Возвращает список всех объектов, отслеживаемых сборщиком, за исключением возвращаемого списка. Если *generation* не равно `None`, возвращает только объекты, отслеживаемые сборщиком, которые находятся в этом поколении.4647Изменено в версии 3.8: Новый параметр *generation*.4849Вызывает [событие аудита](https://python-all.ru/3.12/library/sys.html#auditing) `gc.get_objects` с аргументом `generation`.5051#### `gc.get_stats()`5253Возвращает список из трёх словарей по поколениям, содержащих статистику сборки с момента запуска интерпретатора. Количество ключей может измениться в будущем, но в настоящее время каждый словарь содержит следующие элементы:5455- `collections` – количество сборок этого поколения;56- `collected` – общее количество объектов, собранных в этом поколении;57- `uncollectable` – общее количество объектов, признанных не подлежащими сборке (и поэтому перемещённых в список [`garbage`](https://python-all.ru/3.12/library/gc.html#gc.garbage)) в этом поколении.5859Добавлено в версии 3.4.6061#### `gc.set_threshold(threshold0[, threshold1[, threshold2]])`6263Устанавливает пороги сборки мусора (частоту сборки). Установка *threshold0* в ноль отключает сборку.6465Сборщик мусора (GC) классифицирует объекты по трём поколениям в зависимости от того, сколько циклов сборки они пережили. Новые объекты помещаются в самое молодое поколение (поколение `0`). Если объект переживает сборку, он перемещается в следующее, более старое поколение. Поскольку поколение `2` является самым старым, объекты в этом поколении остаются там после сборки. Чтобы решить, когда запускать сборку, сборщик отслеживает количество выделений и освобождений объектов с момента последней сборки. Когда количество выделений минус количество освобождений превышает *threshold0*, сборка начинается. Изначально проверяется только поколение `0`. Если поколение `0` проверялось больше *threshold1* раз с момента проверки поколения `1`, то проверяется также поколение `1`. С третьим поколением ситуация немного сложнее: подробнее см. [Collecting the oldest generation](https://python-all.ru/3.12/library/gc.html).6667#### `gc.get_count()`6869Возвращает текущие счётчики сборок в виде кортежа из `(count0, count1, count2)`.7071#### `gc.get_threshold()`7273Возвращает текущие пороговые значения сборок в виде кортежа из `(threshold0, threshold1, threshold2)`.7475#### `gc.get_referrers(*objs)`7677Возвращает список объектов, которые напрямую ссылаются на любой из objs. Эта функция находит только те контейнеры, которые поддерживают сборку мусора; типы расширений, которые ссылаются на другие объекты, но не поддерживают сборку мусора, найдены не будут.7879Обратите внимание, что объекты, на которые уже нет ссылок, но которые находятся в циклах и ещё не собраны сборщиком мусора, могут оказаться среди возвращаемых ссылающихся объектов. Чтобы получить только живые объекты, вызовите [`collect()`](https://python-all.ru/3.12/library/gc.html#gc.collect) перед вызовом [`get_referrers()`](https://python-all.ru/3.12/library/gc.html#gc.get_referrers).8081> **Предупреждение**82>83> Следует соблюдать осторожность при использовании объектов, возвращаемых [`get_referrers()`](https://python-all.ru/3.12/library/gc.html#gc.get_referrers), поскольку некоторые из них могут всё ещё находиться в процессе конструирования и, следовательно, во временно недопустимом состоянии. Избегайте использования [`get_referrers()`](https://python-all.ru/3.12/library/gc.html#gc.get_referrers) для каких-либо целей, кроме отладки.8485Вызывает [событие аудита](https://python-all.ru/3.12/library/sys.html#auditing) `gc.get_referrers` с аргументом `objs`.8687#### `gc.get_referents(*objs)`8889Возвращает список объектов, на которые напрямую ссылается любой из аргументов. Возвращаемые референты – это объекты, посещённые C-уровневыми методами [`tp_traverse`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_traverse) аргументов (если они есть), и это могут быть не все объекты, действительно достижимые напрямую. Методы [`tp_traverse`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_traverse) поддерживаются только объектами, которые поддерживают сборку мусора, и от них требуется только посещение объектов, которые могут участвовать в циклах. Так, например, если целое число напрямую достижимо из аргумента, этот целочисленный объект может как появиться в результирующем списке, так и нет.9091Вызывает [событие аудита](https://python-all.ru/3.12/library/sys.html#auditing) `gc.get_referents` с аргументом `objs`.9293#### `gc.is_tracked(obj)`9495Возвращает `True`, если объект в настоящее время отслеживается сборщиком мусора, и `False` в противном случае. Как правило, экземпляры атомарных типов не отслеживаются, а экземпляры неатомарных типов (контейнеры, пользовательские объекты и т.д.) отслеживаются. Однако могут присутствовать некоторые оптимизации для конкретных типов, чтобы уменьшить влияние на сборщик мусора простых экземпляров (например, словарей, содержащих только атомарные ключи и значения):9697```python98>>> gc.is_tracked(0)99False100>>> gc.is_tracked("a")101False102>>> gc.is_tracked([])103True104>>> gc.is_tracked({})105False106>>> gc.is_tracked({"a": 1})107False108>>> gc.is_tracked({"a": []})109True110```111112Добавлено в версии 3.1.113114#### `gc.is_finalized(obj)`115116Возвращает `True`, если указанный объект был финализирован сборщиком мусора, и `False` в противном случае.117118```python119>>> x = None120>>> class Lazarus:121...     def __del__(self):122...         global x123...         x = self124...125>>> lazarus = Lazarus()126>>> gc.is_finalized(lazarus)127False128>>> del lazarus129>>> gc.is_finalized(x)130True131```132133Добавлено в версии 3.9.134135#### `gc.freeze()`136137Замораживает все объекты, отслеживаемые сборщиком мусора; перемещает их в постоянное поколение и игнорирует во всех последующих сборках.138139Если процесс будет `fork()` без `exec()`, избегание ненужного копирования при записи в дочерних процессах максимизирует совместное использование памяти и снижает общее потребление памяти. Это требует как предотвращения создания освобождённых «дыр» в страницах памяти в родительском процессе, так и гарантии, что сборки мусора в дочерних процессах не затронут счётчик `gc_refs` долгоживущих объектов, созданных в родительском процессе. Для достижения обоих целей вызовите `gc.disable()` рано в родительском процессе, `gc.freeze()` непосредственно перед `fork()` и `gc.enable()` рано в дочерних процессах.140141Добавлено в версии 3.7.142143#### `gc.unfreeze()`144145Размораживает объекты в постоянном поколении, возвращает их обратно в самое старое поколение.146147Добавлено в версии 3.7.148149#### `gc.get_freeze_count()`150151Возвращает количество объектов в постоянном поколении.152153Добавлено в версии 3.7.154155Следующие переменные предназначены для доступа только для чтения (можно изменять их значения, но не следует их переназначать):156157#### `gc.garbage`158159Список объектов, которые сборщик обнаружил как недостижимые, но не смог освободить (неподлежащие сборке объекты). Начиная с Python 3.4, этот список в большинстве случаев должен быть пуст, за исключением использования экземпляров типов расширений C с не-`NULL` слотом `tp_del`.160161Если [`DEBUG_SAVEALL`](https://python-all.ru/3.12/library/gc.html#gc.DEBUG_SAVEALL) установлено, то все недостижимые объекты будут добавлены в этот список, а не освобождены.162163Изменено в версии 3.2: Если этот список не пуст при [завершении интерпретатора](https://python-all.ru/3.12/glossary.html#term-interpreter-shutdown), выдается [`ResourceWarning`](https://python-all.ru/3.12/library/exceptions.html#ResourceWarning), который по умолчанию является молчаливым. Если [`DEBUG_UNCOLLECTABLE`](https://python-all.ru/3.12/library/gc.html#gc.DEBUG_UNCOLLECTABLE) установлено, дополнительно выводятся все неподлежащие сборке объекты.164165Изменено в версии 3.4: В соответствии с [**PEP 442**](https://python-all.ru/3.12/library/gc.html), объекты с методом [`__del__()`](https://python-all.ru/3.12/reference/datamodel.html#object.__del__) больше не попадают в [`gc.garbage`](https://python-all.ru/3.12/library/gc.html#gc.garbage).166167#### `gc.callbacks`168169Список колбэков, которые будут вызываться сборщиком мусора до и после сборки. Колбэки будут вызываться с двумя аргументами: *phase* и *info*.170171*phase* может принимать одно из двух значений:172173> “start”: сборка мусора начинается.174>175> “stop”: сборка мусора завершена.176177*info* – это словарь, предоставляющий дополнительную информацию для колбэка. В настоящее время определены следующие ключи:178179> “generation”: самое старое поколение, участвующее в сборке.180>181> “collected”: когда *phase* равен “stop”, количество успешно собранных объектов.182>183> “uncollectable”: когда *phase* равен “stop”, количество объектов, которые не удалось собрать и которые были помещены в [`garbage`](https://python-all.ru/3.12/library/gc.html#gc.garbage).184185Приложения могут добавлять свои собственные колбэки в этот список. Основные случаи использования:186187> Сбор статистики о сборке мусора, например, как часто собираются различные поколения и сколько времени занимает сборка.188>189> Позволяет приложениям выявлять и очищать собственные несобираемые типы, когда они появляются в [`garbage`](https://python-all.ru/3.12/library/gc.html#gc.garbage).190191Добавлено в версии 3.3.192193Следующие константы предоставляются для использования с [`set_debug()`](https://python-all.ru/3.12/library/gc.html#gc.set_debug):194195#### `gc.DEBUG_STATS`196197Вывод статистики во время сборки. Эта информация может быть полезна при настройке частоты сборки.198199#### `gc.DEBUG_COLLECTABLE`200201Вывод информации о найденных собираемых объектах.202203#### `gc.DEBUG_UNCOLLECTABLE`204205Вывод информации о найденных несобираемых объектах (объекты, которые недостижимы, но не могут быть освобождены сборщиком). Эти объекты будут добавлены в список `garbage`.206207Изменено в версии 3.2: Также выводить содержимое списка [`garbage`](https://python-all.ru/3.12/library/gc.html#gc.garbage) при [завершении интерпретатора](https://python-all.ru/3.12/glossary.html#term-interpreter-shutdown), если он не пуст.208209#### `gc.DEBUG_SAVEALL`210211Если установлен, все найденные недостижимые объекты будут добавляться в *garbage*, а не освобождаться. Это может быть полезно для отладки программы с утечками.212213#### `gc.DEBUG_LEAK`214215Флаги отладки, необходимые для вывода сборщиком информации о программе с утечками (равно `DEBUG_COLLECTABLE | DEBUG_UNCOLLECTABLE | DEBUG_SAVEALL`).216