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

type PyTypeObject

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

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

PyTypeObject PyType_Type

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

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

int PyType_Check(PyObject *o)

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

int PyType_CheckExact(PyObject *o)

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

unsigned int PyType_ClearCache()

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

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

unsigned long PyType_GetFlags(PyTypeObject *type)

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

Возвращает член 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)

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

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

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, если _PyType_Lookup() не вызывался для type между изменениями; это деталь реализации и может быть изменено.)

Расширение никогда не должно вызывать 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)

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

int PyType_IsSubtype(PyTypeObject *a, PyTypeObject *b)

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

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

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

PyObject *PyType_GenericAlloc(PyTypeObject *type, Py_ssize_t nitems)

Значение возврата: Новая ссылка. Часть Стабильного API.

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

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

Значение возврата: Новая ссылка. Часть Стабильного API.

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

int PyType_Ready(PyTypeObject *type)

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

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

Примечание

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

PyObject *PyType_GetName(PyTypeObject *type)

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

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

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

PyObject *PyType_GetQualName(PyTypeObject *type)

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

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

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

void *PyType_GetSlot(PyTypeObject *type, int slot)

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

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

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

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

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

PyObject *PyType_GetModule(PyTypeObject *type)

Часть Стабильного API начиная с версии 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)

Часть Стабильного API начиная с версии 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.