Підтримка циклічного збирання сміття

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

To create a container type, the tp_flags field of the type object must include the Py_TPFLAGS_HAVE_GC and provide an implementation of the tp_traverse handler. If instances of the type are mutable, a tp_clear implementation must also be provided.

Py_TPFLAGS_HAVE_GC

Об’єкти типу з цим прапорцем мають відповідати задокументованим тут правилам. Для зручності ці об’єкти будуть називатися об’єктами-контейнерами.

Конструктори для типів контейнерів повинні відповідати двом правилам:

1. The memory for the object must be allocated using PyObject_GC_New or PyObject_GC_NewVar.

2. Після ініціалізації всіх полів, які можуть містити посилання на інші контейнери, він повинен викликати PyObject_GC_Track().

Подібним чином, делокатор для об’єкта має відповідати подібній парі правил:

1. Перш ніж поля, які посилаються на інші контейнери, стануть недійсними, необхідно викликати PyObject_GC_UnTrack().

2. Пам’ять об’єкта має бути звільнено за допомогою PyObject_GC_Del().

   Попередження

   Якщо тип додає Py_TPFLAGS_HAVE_GC, тоді він має реалізувати принаймні обробник tp_traverse або явно використовувати один із свого підкласу або підкласів.

   When calling PyType_Ready() or some of the APIs that indirectly call it like PyType_FromSpecWithBases() or PyType_FromSpec() the interpreter will automatically populate the tp_flags, tp_traverse and tp_clear fields if the type inherits from a class that implements the garbage collector protocol and the child class does not include the Py_TPFLAGS_HAVE_GC flag.

PyObject_GC_New(TYPE, typeobj)

Analogous to PyObject_New but for container objects with the Py_TPFLAGS_HAVE_GC flag set.

PyObject_GC_NewVar(TYPE, typeobj, size)

Analogous to PyObject_NewVar but for container objects with the Py_TPFLAGS_HAVE_GC flag set.

PyObject_GC_Resize(TYPE, op, newsize)

Resize an object allocated by PyObject_NewVar. Returns the resized object of type TYPE* (refers to any C type) or NULL on failure.

op must be of type PyVarObject* and must not be tracked by the collector yet. newsize must be of type Py_ssize_t.

void PyObject_GC_Track(PyObject *op)

Part of the Stable ABI.

Додає об’єкт op до набору об’єктів-контейнерів, які відстежує збирач. Збирач може запускатися в несподіваний час, тому об’єкти мають бути дійсними під час відстеження. Його слід викликати, коли всі поля, за якими йде обробник tp_traverse, стануть дійсними, як правило, ближче до кінця конструктора.

int PyObject_IS_GC(PyObject *obj)

Повертає ненульове значення, якщо об’єкт реалізує протокол збирача сміття, інакше повертає 0.

Збирач сміття не може відстежувати об’єкт, якщо ця функція повертає 0.

int PyObject_GC_IsTracked(PyObject *op)

Part of the Stable ABI since version 3.9.

Повертає 1, якщо тип об’єкта op реалізує протокол GC і op зараз відстежується збирачем сміття, і 0 в іншому випадку.

Це аналогічно функції Python gc.is_tracked().

Нове в версії 3.9.

int PyObject_GC_IsFinalized(PyObject *op)

Part of the Stable ABI since version 3.9.

Повертає 1, якщо тип об’єкта op реалізує протокол GC і op вже завершено збирачем сміття, і 0 в іншому випадку.

Це аналогічно функції Python gc.is_finalized().

Нове в версії 3.9.

void PyObject_GC_Del(void *op)

Part of the Stable ABI.

Releases memory allocated to an object using PyObject_GC_New or PyObject_GC_NewVar.

void PyObject_GC_UnTrack(void *op)

Part of the Stable ABI.

Видаліть об’єкт op із набору об’єктів-контейнерів, які відстежує збирач. Зауважте, що PyObject_GC_Track() можна знову викликати для цього об’єкта, щоб додати його назад до набору відстежуваних об’єктів. Deallocator (tp_dealloc обробник) має викликати це для об’єкта до того, як будь-яке з полів, що використовуються tp_traverse обробником, стане недійсним.

Змінено в версії 3.8: The _PyObject_GC_TRACK() and _PyObject_GC_UNTRACK() macros have been removed from the public C API.

Обробник tp_traverse приймає параметр функції такого типу:

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

Part of the Stable ABI.

Тип функції відвідувача, переданої обробнику tp_traverse. Функція має бути викликана з об’єктом для проходження як object і третім параметром для обробника tp_traverse як arg. Ядро Python використовує кілька функцій відвідувачів для реалізації циклічного виявлення сміття; не очікується, що користувачам доведеться писати власні функції відвідувачів.

Обробник tp_traverse повинен мати такий тип:

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

Part of the Stable ABI.

Функція обходу для об’єкта-контейнера. Реалізації повинні викликати функцію visit для кожного об’єкта, який безпосередньо міститься в self, з параметрами visit, які містять об’єкт, а значення arg передається обробнику. Функцію visit не можна викликати з аргументом об’єкта NULL. Якщо visit повертає ненульове значення, це значення має бути повернуто негайно.

Для спрощення написання обробників tp_traverse передбачено макрос Py_VISIT(). Щоб використовувати цей макрос, реалізація tp_traverse має назвати свої аргументи точно visit і arg:

void Py_VISIT(PyObject *o)

Якщо o не є NULL, викличте зворотній виклик visit з аргументами o і arg. Якщо visit повертає ненульове значення, поверніть його. За допомогою цього макросу обробники tp_traverse виглядають так:

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

Обробник tp_clear має бути типу inquiry або NULL, якщо об’єкт є незмінним.

typedef int (*inquiry)(PyObject *self)

Part of the Stable ABI.

Видалити посилання, які могли створити цикли посилань. Незмінні об’єкти не повинні визначати цей метод, оскільки вони ніколи не можуть безпосередньо створювати еталонні цикли. Зауважте, що об’єкт все ще має бути дійсним після виклику цього методу (не просто викликайте Py_DECREF() за посиланням). Збирач викличе цей метод, якщо виявить, що цей об’єкт бере участь у еталонному циклі.

Контроль стану Garbage Collector

C-API надає такі функції для керування виконанням збирання сміття.

Py_ssize_t PyGC_Collect(void)

Part of the Stable ABI.

Виконати повне збирання сміття, якщо ввімкнено збирач сміття. (Зверніть увагу, що gc.collect() запускає його безумовно.)

Повертає кількість зібраних + недосяжних об’єктів, які неможливо зібрати. Якщо збирач сміття вимкнено або вже збирає, негайно повертає 0. Помилки під час збирання сміття передаються до sys.unraisablehook. Ця функція не викликає винятків.

int PyGC_Enable(void)

Part of the Stable ABI since version 3.10.

Увімкніть збирач сміття: подібно до gc.enable(). Повертає попередній стан, 0 для вимкнено та 1 для ввімкнено.

Нове в версії 3.10.

int PyGC_Disable(void)

Part of the Stable ABI since version 3.10.

Вимкнути збирач сміття: подібно до gc.disable(). Повертає попередній стан, 0 для вимкнено та 1 для ввімкнено.

Нове в версії 3.10.

int PyGC_IsEnabled(void)

Part of the Stable ABI since version 3.10.

Запитайте стан збирача сміття: подібно до gc.isenabled(). Повертає поточний стан, 0 для вимкнено та 1 для ввімкнено.

Нове в версії 3.10.