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

type PyTypeObject

Часть Ограниченного API (как неявная структура).

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

PyTypeObject PyType_Type

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

Это объект типа для объектов типов; он совпадает с объектом type на уровне Python.

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.

void PyType_Modified(PyTypeObject *type)

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

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

int PyType_HasFeature(PyTypeObject *o, int feature)

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

int PyType_IS_GC(PyTypeObject *o)

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

int PyType_IsSubtype(PyTypeObject *a, PyTypeObject *b)

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

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

Эта функция проверяет только фактические подтипы, что означает, что __subclasscheck__() не вызывается для b. Вызовите PyObject_IsSubclass() для выполнения той же проверки, что и 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 и устанавливает исключение при ошибке.

Примечание

Если некоторые из базовых классов реализуют протокол GC, а предоставленный тип не включает Py_TPFLAGS_HAVE_GC в своих флагах, то протокол GC будет автоматически реализован от его родителей. Напротив, если создаваемый тип включает Py_TPFLAGS_HAVE_GC в своих флагах, то он должен реализовать сам протокол 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, или что функция была вызвана с недопустимыми параметрами. Вызывающие стороны обычно преобразуют указатель результата в соответствующий тип функции.

См. PyType_Slot.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 для получения класса, определяющего метод. См. PyType_GetModuleByDef() для случаев, когда PyCMethod не может быть использован.

Введено в версии 3.9.

void *PyType_GetModuleState(PyTypeObject *type)

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

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

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

Если с типом связан модуль, но его состояние 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.