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

PyTypeObject

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

PyTypeObject PyType_Type

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

int PyType_Check(PyObject *o)

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

int PyType_CheckExact(PyObject *o)

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

unsigned int PyType_ClearCache()

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

unsigned long PyType_GetFlags(PyTypeObject* type)

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

Новое в версии 3.2.

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

void PyType_Modified(PyTypeObject *type)

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

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)

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

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

PyObject* PyType_GenericAlloc(PyTypeObject *type, Py_ssize_t nitems)

Возвращаемое значение: новая ссылка.

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

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

Возвращаемое значение: новая ссылка.

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

int PyType_Ready(PyTypeObject *type)

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

Примечание

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

void* PyType_GetSlot(PyTypeObject *type, int slot)

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

См. PyType_Slot.slot для возможных значений аргумента slot.

Исключение генерируется, если type не является типом кучи.

Новое в версии 3.4.

PyObject* PyType_GetModule(PyTypeObject *type)

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

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

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

Новое в версии 3.9.

void* PyType_GetModuleState(PyTypeObject *type)

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

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

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

Новое в версии 3.9.