> **Источник:** https://python-all.ru/3.12/c-api/gcsupport.html
>
> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.

---

# Поддержка циклической сборки мусора

Поддержка Python обнаружения и сбора мусора, связанного с циклическими ссылками, требует поддержки со стороны объектных типов, которые являются «контейнерами» для других объектов, которые также могут быть контейнерами. Типы, которые не хранят ссылок на другие объекты или хранят только ссылки на атомарные типы (например, числа или строки), не нуждаются в явной поддержке сборки мусора.

Чтобы создать контейнерный тип, поле [`tp_flags`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_flags) объекта типа должно включать [`Py_TPFLAGS_HAVE_GC`](https://python-all.ru/3.12/c-api/typeobj.html#c.Py_TPFLAGS_HAVE_GC) и предоставлять реализацию обработчика [`tp_traverse`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_traverse). Если экземпляры типа являются изменяемыми, также должна быть предоставлена реализация [`tp_clear`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_clear).

**[`Py_TPFLAGS_HAVE_GC`](https://python-all.ru/3.12/c-api/typeobj.html#c.Py_TPFLAGS_HAVE_GC)**

Объекты с типом, у которого установлен этот флаг, должны соответствовать правилам, описанным здесь. Для удобства такие объекты будут называться контейнерными объектами.

Конструкторы контейнерных типов должны соответствовать двум правилам:

1. Память для объекта должна выделяться с помощью [`PyObject_GC_New`](https://python-all.ru/3.12/c-api/gcsupport.html#c.PyObject_GC_New) или [`PyObject_GC_NewVar`](https://python-all.ru/3.12/c-api/gcsupport.html#c.PyObject_GC_NewVar).
2. Как только все поля, которые могут содержать ссылки на другие контейнеры, будут инициализированы, необходимо вызвать [`PyObject_GC_Track()`](https://python-all.ru/3.12/c-api/gcsupport.html#c.PyObject_GC_Track).

Аналогично, деаллокатор объекта должен соответствовать такой же паре правил:

1. Перед тем как поля, ссылающиеся на другие контейнеры, станут недействительными, должен быть вызван [`PyObject_GC_UnTrack()`](https://python-all.ru/3.12/c-api/gcsupport.html#c.PyObject_GC_UnTrack).
2. Память объекта должна быть освобождена с помощью [`PyObject_GC_Del()`](https://python-all.ru/3.12/c-api/gcsupport.html#c.PyObject_GC_Del).

   > **Предупреждение**
   >
   > Если тип добавляет Py\_TPFLAGS\_HAVE\_GC, то он *должен* реализовать как минимум обработчик [`tp_traverse`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_traverse) или явно использовать его из своего подкласса или подклассов.
   >
   > При вызове [`PyType_Ready()`](https://python-all.ru/3.12/c-api/type.html#c.PyType_Ready) или некоторых API, которые вызывают его косвенно, таких как [`PyType_FromSpecWithBases()`](https://python-all.ru/3.12/c-api/type.html#c.PyType_FromSpecWithBases) или [`PyType_FromSpec()`](https://python-all.ru/3.12/c-api/type.html#c.PyType_FromSpec), интерпретатор автоматически заполнит поля [`tp_flags`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_flags), [`tp_traverse`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_traverse) и [`tp_clear`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_clear), если тип наследуется от класса, реализующего протокол сборщика мусора, и дочерний класс *не* включает флаг [`Py_TPFLAGS_HAVE_GC`](https://python-all.ru/3.12/c-api/typeobj.html#c.Py_TPFLAGS_HAVE_GC).

#### `PyObject_GC_New(TYPE, typeobj)`

Аналогично [`PyObject_New`](https://python-all.ru/3.12/c-api/allocation.html#c.PyObject_New), но для контейнерных объектов с установленным флагом [`Py_TPFLAGS_HAVE_GC`](https://python-all.ru/3.12/c-api/typeobj.html#c.Py_TPFLAGS_HAVE_GC).

#### `PyObject_GC_NewVar(TYPE, typeobj, size)`

Аналогично [`PyObject_NewVar`](https://python-all.ru/3.12/c-api/allocation.html#c.PyObject_NewVar), но для контейнерных объектов с установленным флагом [`Py_TPFLAGS_HAVE_GC`](https://python-all.ru/3.12/c-api/typeobj.html#c.Py_TPFLAGS_HAVE_GC).

#### `PyObject *PyUnstable_Object_GC_NewWithExtraData(PyTypeObject *type, size_t extra_size)`

> *Это [нестабильное API](https://python-all.ru/3.12/c-api/stable.html#unstable-c-api). Оно может меняться без предупреждения в минорных версиях.*

Аналог [`PyObject_GC_New`](https://python-all.ru/3.12/c-api/gcsupport.html#c.PyObject_GC_New), но выделяет *extra\_size* байт в конце объекта (по смещению [`tp_basicsize`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_basicsize)). Выделенная память обнуляется, за исключением [`Python object header`](https://python-all.ru/3.12/c-api/structures.html#c.PyObject).

Дополнительные данные будут освобождены вместе с объектом, но в остальном Python ими не управляет.

> **Предупреждение**
>
> Функция помечена как нестабильная, потому что окончательный механизм резервирования дополнительных данных после экземпляра ещё не определён. Для выделения переменного числа полей предпочтительнее использовать [`PyVarObject`](https://python-all.ru/3.12/c-api/structures.html#c.PyVarObject) и [`tp_itemsize`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_itemsize).

Добавлено в версии 3.12.

#### `PyObject_GC_Resize(TYPE, op, newsize)`

Изменяет размер объекта, выделенного через [`PyObject_NewVar`](https://python-all.ru/3.12/c-api/allocation.html#c.PyObject_NewVar). Возвращает объект нового размера типа `TYPE*` (ссылается на любой тип C) или `NULL` в случае ошибки.

*op* должен иметь тип [PyVarObject](https://python-all.ru/3.12/c-api/structures.html#c.PyVarObject)\* и ещё не отслеживаться сборщиком. *newsize* должен иметь тип [`Py_ssize_t`](https://python-all.ru/3.12/c-api/intro.html#c.Py_ssize_t).

#### `void PyObject_GC_Track(PyObject *op)`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).*

Добавляет объект *op* в набор контейнерных объектов, отслеживаемых сборщиком. Сборщик может запускаться в неожиданные моменты, поэтому объекты должны быть корректны во время отслеживания. Эту функцию следует вызывать, когда все поля, за которыми следит обработчик [`tp_traverse`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_traverse), станут корректны, обычно ближе к концу конструктора.

#### `int PyObject_IS_GC(PyObject *obj)`

Возвращает ненулевое значение, если объект реализует протокол сборщика мусора, иначе возвращает 0.

Объект не может отслеживаться сборщиком мусора, если эта функция возвращает 0.

#### `int PyObject_GC_IsTracked(PyObject *op)`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.9.*

Возвращает 1, если тип объекта *op* реализует протокол GC и *op* в данный момент отслеживается сборщиком мусора, и 0 в противном случае.

Это аналог функции Python [`gc.is_tracked()`](https://python-all.ru/3.12/library/gc.html#gc.is_tracked).

Добавлено в версии 3.9.

#### `int PyObject_GC_IsFinalized(PyObject *op)`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.9.*

Возвращает 1, если тип объекта *op* реализует протокол GC и *op* уже был финализирован сборщиком мусора, и 0 в противном случае.

Это аналог функции Python [`gc.is_finalized()`](https://python-all.ru/3.12/library/gc.html#gc.is_finalized).

Добавлено в версии 3.9.

#### `void PyObject_GC_Del(void *op)`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).*

Освобождает память, выделенную объекту через [`PyObject_GC_New`](https://python-all.ru/3.12/c-api/gcsupport.html#c.PyObject_GC_New) или [`PyObject_GC_NewVar`](https://python-all.ru/3.12/c-api/gcsupport.html#c.PyObject_GC_NewVar).

#### `void PyObject_GC_UnTrack(void *op)`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).*

Удаляет объект *op* из набора контейнерных объектов, отслеживаемых сборщиком. Обратите внимание, что [`PyObject_GC_Track()`](https://python-all.ru/3.12/c-api/gcsupport.html#c.PyObject_GC_Track) можно снова вызвать для этого объекта, чтобы вернуть его в набор отслеживаемых объектов. Деструктор (обработчик [`tp_dealloc`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_dealloc)) должен вызывать это для объекта до того, как какие-либо поля, используемые обработчиком [`tp_traverse`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_traverse), станут недействительными.

Изменено в версии 3.8: Макросы `_PyObject_GC_TRACK()` и `_PyObject_GC_UNTRACK()` были удалены из публичного C API.

Обработчик [`tp_traverse`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_traverse) принимает параметр-функцию следующего типа:

#### `typedef int (*visitproc)(PyObject *object, void *arg)`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).*

Тип функции обхода, передаваемой обработчику [`tp_traverse`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_traverse). Функцию следует вызывать с объектом для обхода в качестве *object* и третьим параметром обработчика [`tp_traverse`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_traverse) в качестве *arg*. Ядро Python использует несколько функций обхода для реализации обнаружения циклического мусора; не ожидается, что пользователям потребуется писать собственные функции обхода.

Обработчик [`tp_traverse`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_traverse) должен иметь следующий тип:

#### `typedef int (*traverseproc)(PyObject *self, visitproc visit, void *arg)`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).*

Функция обхода для объекта-контейнера. Реализации должны вызывать функцию *visit* для каждого объекта, непосредственно содержащегося в *self*; параметрами *visit* являются содержащийся объект и значение *arg*, переданное обработчику. Функция *visit* не должна вызываться с аргументом-объектом `NULL`. Если *visit* возвращает ненулевое значение, его следует немедленно вернуть.

Чтобы упростить написание обработчиков [`tp_traverse`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_traverse), предоставляется макрос [`Py_VISIT()`](https://python-all.ru/3.12/c-api/gcsupport.html#c.Py_VISIT). Для использования этого макроса реализация [`tp_traverse`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_traverse) должна называть свои аргументы точно *visit* и *arg*:

#### `void Py_VISIT(PyObject *o)`

Если *o* не равно `NULL`, вызвать колбэк *visit* с аргументами *o* и *arg*. Если *visit* возвращает ненулевое значение, вернуть его. Используя этот макрос, обработчики [`tp_traverse`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_traverse) выглядят так:

```c
static int
my_traverse(Noddy *self, visitproc visit, void *arg)
{
    Py_VISIT(self->foo);
    Py_VISIT(self->bar);
    return 0;
}
```

Обработчик [`tp_clear`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_clear) должен иметь тип [`inquiry`](https://python-all.ru/3.12/c-api/gcsupport.html#c.inquiry) или `NULL`, если объект неизменяем.

#### `typedef int (*inquiry)(PyObject *self)`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).*

Удаляет ссылки, которые могли создать циклические ссылки. Неизменяемые объекты не обязаны определять этот метод, поскольку они никогда не могут напрямую создавать циклические ссылки. Обратите внимание, что объект после вызова этого метода должен оставаться корректным (нельзя просто вызвать [`Py_DECREF()`](https://python-all.ru/3.12/c-api/refcounting.html#c.Py_DECREF) для ссылки). Сборщик вызовет этот метод, если обнаружит, что этот объект участвует в циклической ссылке.

## Управление состоянием сборщика мусора

C-API предоставляет следующие функции для управления запусками сборки мусора.

#### `Py_ssize_t PyGC_Collect(void)`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).*

Выполняет полную сборку мусора, если сборщик мусора включён. (Обратите внимание, что [`gc.collect()`](https://python-all.ru/3.12/library/gc.html#gc.collect) запускает её безусловно.)

Возвращает количество собранных + недостижимых объектов, которые не могут быть собраны. Если сборщик мусора отключён или уже выполняет сборку, немедленно возвращает `0`. Ошибки во время сборки мусора передаются в [`sys.unraisablehook`](https://python-all.ru/3.12/library/sys.html#sys.unraisablehook). Эта функция не вызывает исключений.

#### `int PyGC_Enable(void)`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.10.*

Включает сборщик мусора: аналогично [`gc.enable()`](https://python-all.ru/3.12/library/gc.html#gc.enable). Возвращает предыдущее состояние: 0 – отключён, 1 – включён.

Добавлено в версии 3.10.

#### `int PyGC_Disable(void)`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.10.*

Отключает сборщик мусора: аналогично [`gc.disable()`](https://python-all.ru/3.12/library/gc.html#gc.disable). Возвращает предыдущее состояние: 0 – отключён, 1 – включён.

Добавлено в версии 3.10.

#### `int PyGC_IsEnabled(void)`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.10.*

Запрашивает состояние сборщика мусора: аналогично [`gc.isenabled()`](https://python-all.ru/3.12/library/gc.html#gc.isenabled). Возвращает текущее состояние: 0 – отключён, 1 – включён.

Добавлено в версии 3.10.

## Запрос состояния сборщика мусора

C-API предоставляет следующий интерфейс для запроса информации о сборщике мусора.

#### `void PyUnstable_GC_VisitObjects(gcvisitobjects_t callback, void *arg)`

> *Это [нестабильное API](https://python-all.ru/3.12/c-api/stable.html#unstable-c-api). Оно может меняться без предупреждения в минорных версиях.*

Вызывает переданный *колбэк* для всех живых объектов, поддерживающих GC. *arg* передаётся во все вызовы *колбэк*.

> **Предупреждение**
>
> Если колбэк выделяет или освобождает новые объекты, то не определено, будут ли они посещены.
>
> Во время работы сборка мусора отключена. Явный запуск сборки в колбэке может привести к неопределённому поведению, например, к посещению одних и тех же объектов несколько раз или ни разу.

Добавлено в версии 3.12.

#### `typedef int (*gcvisitobjects_t)(PyObject *object, void *arg)`

Тип функции-посетителя, передаваемой в [`PyUnstable_GC_VisitObjects()`](https://python-all.ru/3.12/c-api/gcsupport.html#c.PyUnstable_GC_VisitObjects). Параметр *arg* – то же самое, что *arg*, переданный в `PyUnstable_GC_VisitObjects`. Возвращайте `0` для продолжения итерации, `1` – для остановки. Остальные возвращаемые значения пока зарезервированы, поэтому поведение при возврате чего-либо другого не определено.

Добавлено в версии 3.12.