Объекты типов

type PyTypeObject

Часть Ограниченного API (в виде непрозрачной структуры).

Структура C объектов, используемых для описания встроенных типов.

PyTypeObject PyType_Type

Часть Стабильного ABI.

Это объект типа для объектов типов; на уровне Python это тот же объект, что и type.

int PyType_Check(PyObject *o)

Возвращает ненулевое значение, если объект o является объектом типа, включая экземпляры типов, производных от стандартного объекта типа. Во всех остальных случаях возвращает 0. Эта функция всегда завершается успешно.

int PyType_CheckExact(PyObject *o)

Возвращает ненулевое значение, если объект o является объектом типа, но не подтипом стандартного объекта типа. Во всех остальных случаях возвращает 0. Эта функция всегда завершается успешно.

unsigned int PyType_ClearCache()

Часть Стабильного ABI.

Очищает внутренний кэш поиска. Возвращает текущую метку версии.

unsigned long PyType_GetFlags(PyTypeObject *type)

Часть Стабильного ABI.

Возвращает член tp_flags объекта type. Эта функция предназначена главным образом для использования с Py_LIMITED_API; отдельные биты флагов гарантированно остаются неизменными в разных выпусках Python, но доступ к самому tp_flags не входит в ограниченный API.

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

Изменено в версии 3.4: Теперь возвращаемый тип — unsigned long, а не long.

PyObject *PyType_GetDict(PyTypeObject *type)

Возвращает внутреннее пространство имён объекта типа, которое в противном случае доступно только через прокси, доступный только для чтения (cls.__dict__). Эта функция заменяет прямой доступ к tp_dict. Возвращённый словарь необходимо считать доступным только для чтения.

Эта функция предназначена для особых случаев встраивания и привязки языков, когда необходим прямой доступ к словарю, а косвенный доступ (например, через прокси или PyObject_GetAttr()) недостаточен.

Расширениям следует по-прежнему использовать tp_dict, напрямую или косвенно, при настройке собственных типов.

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

void PyType_Modified(PyTypeObject *type)

Часть Стабильного ABI.

Инвалидирует внутренний кэш поиска для типа и всех его подтипов. Эту функцию необходимо вызывать после любого ручного изменения атрибутов или базовых классов типа.

int PyType_AddWatcher(PyType_WatchCallback callback)

Регистрирует callback в качестве наблюдателя типа. Возвращает неотрицательный целочисленный идентификатор, который необходимо передавать в последующие вызовы PyType_Watch(). В случае ошибки (например, если больше нет доступных идентификаторов наблюдателей) возвращает -1 и устанавливает исключение.

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

int PyType_ClearWatcher(int watcher_id)

Отключает наблюдателя с идентификатором watcher_id (ранее возвращённым функцией PyType_AddWatcher()). В случае успеха возвращает 0, в случае ошибки — -1 (например, если watcher_id никогда не регистрировался).

Расширение никогда не должно вызывать PyType_ClearWatcher с идентификатором watcher_id, который не был возвращён ему предыдущим вызовом PyType_AddWatcher().

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

int PyType_Watch(int watcher_id, PyObject *type)

Помечает type как отслеживаемый. Функция обратного вызова, связанная с watcher_id функцией PyType_AddWatcher(), будет вызвана, когда PyType_Modified() сообщит об изменении type. (Функция обратного вызова может быть вызвана лишь один раз для серии последовательных изменений type, если между изменениями для type не вызывается _PyType_Lookup(); это деталь реализации, которая может измениться.)

Расширение никогда не должно вызывать PyType_Watch с идентификатором watcher_id, который не был возвращён ему предыдущим вызовом PyType_AddWatcher().

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

typedef int (*PyType_WatchCallback)(PyObject *type)

Тип функции обратного вызова наблюдателя типа.

Функция обратного вызова не должна изменять type или приводить к вызову PyType_Modified() для type или любого типа в его MRO; нарушение этого правила может привести к бесконечной рекурсии.

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

int PyType_HasFeature(PyTypeObject *o, int feature)

Возвращает ненулевое значение, если объект типа o устанавливает признак feature. Признаки типов обозначаются однобитовыми флагами.

int PyType_IS_GC(PyTypeObject *o)

Возвращает истину, если объект типа поддерживает обнаружение циклических ссылок; для этого проверяется флаг типа Py_TPFLAGS_HAVE_GC.

int PyType_IsSubtype(PyTypeObject *a, PyTypeObject *b)

Часть Стабильного ABI.

Возвращает истину, если a является подтипом b.

Эта функция проверяет только фактические подтипы, то есть __subclasscheck__() для b не вызывается. Чтобы выполнить ту же проверку, что и issubclass(), вызвала бы, используйте PyObject_IsSubclass().

PyObject *PyType_GenericAlloc(PyTypeObject *type, Py_ssize_t nitems)

Возвращаемое значение: новая ссылка. Часть Стабильного ABI.

Универсальный обработчик слота tp_alloc объекта типа. Использует механизм выделения памяти Python по умолчанию для создания нового экземпляра и инициализирует всё его содержимое значением NULL.

PyObject *PyType_GenericNew(PyTypeObject *type, PyObject *args, PyObject *kwds)

Возвращаемое значение: новая ссылка. Часть Стабильного ABI.

Универсальный обработчик слота tp_new объекта типа. Создаёт новый экземпляр с помощью слота tp_alloc типа.

int PyType_Ready(PyTypeObject *type)

Часть Стабильного ABI.

Завершает подготовку объекта типа. Эту функцию следует вызывать для всех объектов типов, чтобы завершить их инициализацию. Функция отвечает за добавление унаследованных слотов из базового класса типа. В случае успеха возвращает 0, а в случае ошибки возвращает -1 и устанавливает исключение.

Примечание

Если некоторые из базовых классов реализуют протокол сборщика мусора, а предоставленный тип не включает Py_TPFLAGS_HAVE_GC в свои флаги, протокол сборщика мусора будет автоматически реализован на основе родительских классов. Напротив, если создаваемый тип включает Py_TPFLAGS_HAVE_GC в свои флаги, он должен самостоятельно реализовать протокол сборщика мусора, реализовав как минимум обработчик tp_traverse.

PyObject *PyType_GetName(PyTypeObject *type)

Возвращаемое значение: новая ссылка. Часть Стабильного ABI начиная с версии 3.11.

Возвращает имя типа. Эквивалентно получению атрибута __name__ типа.

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

PyObject *PyType_GetQualName(PyTypeObject *type)

Возвращаемое значение: новая ссылка. Часть Стабильного ABI начиная с версии 3.11.

Возвращает квалифицированное имя типа. Эквивалентно получению атрибута __qualname__ типа.

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

void *PyType_GetSlot(PyTypeObject *type, int slot)

Часть Стабильного ABI начиная с версии 3.4.

Возвращает указатель на функцию, сохранённый в указанном слоте. Если результат равен NULL, это означает, что слот либо NULL, либо функция была вызвана с недопустимыми параметрами. Обычно вызывающая сторона приводит возвращённый указатель к соответствующему типу функции.

Возможные значения аргумента slot см. в PyType_Slot.slot.

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

Изменено в версии 3.10: PyType_GetSlot() теперь принимает все типы. Ранее функция была ограничена динамическими типами.

PyObject *PyType_GetModule(PyTypeObject *type)

Часть Стабильного ABI начиная с версии 3.10.

Возвращает объект модуля, связанный с указанным типом, если тип был создан с помощью PyType_FromModuleAndSpec().

Если с указанным типом не связан модуль, устанавливает TypeError и возвращает NULL.

Эта функция обычно используется для получения модуля, в котором определён метод. Обратите внимание, что в таком методе PyType_GetModule(Py_TYPE(self)) может вернуть не тот результат, который нужен. Py_TYPE(self) может быть подклассом предполагаемого класса, а подклассы не обязательно определены в том же модуле, что и их суперкласс. Чтобы получить класс, в котором определён метод, см. PyCMethod. Для случаев, когда нельзя использовать PyCMethod, см. PyType_GetModuleByDef().

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

void *PyType_GetModuleState(PyTypeObject *type)

Часть Стабильного ABI начиная с версии 3.10.

Возвращает состояние объекта модуля, связанного с указанным типом. Это сокращённая форма вызова PyModule_GetState() для результата PyType_GetModule().

Если с указанным типом не связан модуль, устанавливает TypeError и возвращает NULL.

Если с типом type связан модуль, но его состояние равно NULL, возвращает NULL, не устанавливая исключение.

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

PyObject *PyType_GetModuleByDef(PyTypeObject *type, struct PyModuleDef *def)

Находит первый суперкласс, модуль которого был создан из указанного PyModuleDef def, и возвращает этот модуль.

Если модуль не найден, вызывает исключение TypeError и возвращает NULL.

Эта функция предназначена для совместного использования с PyModule_GetState() при получении состояния модуля из методов слотов (например, tp_init или nb_add) и в других случаях, когда класс, определяющий метод, нельзя передать с помощью соглашения о вызовах PyCMethod.

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

int PyUnstable_Type_AssignVersionTag(PyTypeObject *type)

Это Нестабильный API. Он может измениться без предупреждения в минорных выпусках.

Пытается присвоить указанному типу метку версии.

Возвращает 1, если у типа уже была действительная метка версии или была присвоена новая, либо 0, если новую метку присвоить не удалось.

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