Объекты типов¶Type Objects

type PyTypeObject¶

Часть Limited API (как непрозрачная структура).

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

PyTypeObject PyType_Type¶

Часть Stable ABI.

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

int PyType_Check(PyObject *o)¶

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

int PyType_CheckExact(PyObject *o)¶

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

unsigned int PyType_ClearCache()¶

Часть Stable ABI.

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

unsigned long PyType_GetFlags(PyTypeObject *type)¶

Часть Stable 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)¶

Часть Stable ABI.

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

int PyType_AddWatcher(PyType_WatchCallback callback)¶

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

В сборках со свободной многопоточностью PyType_AddWatcher() не является потокобезопасным, поэтому он должен вызываться при запуске (до создания первого потока).

Добавлено в версии 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.

int PyType_Unwatch(int watcher_id, PyObject *type)¶

Помечает type как неотслеживаемый. Это отменяет предыдущий вызов PyType_Watch(). type не должен быть NULL.

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

При успехе функция возвращает 0. При неудаче функция возвращает -1 с установленным исключением.

Добавлено в версии 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_FastSubclass(PyTypeObject *type, int flag)¶

Возвращает ненулевое значение, если объект типа type устанавливает флаг подкласса flag. Флаги подклассов обозначаются Py_TPFLAGS_*_SUBCLASS. Эта функция используется многими функциями _Check для распространённых типов.

См. также

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

int PyType_IS_GC(PyTypeObject *o)¶

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

int PyType_IsSubtype(PyTypeObject *a, PyTypeObject *b)¶

Часть Stable ABI.

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

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

PyObject *PyType_GenericAlloc(PyTypeObject *type, Py_ssize_t nitems)¶

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

Общий обработчик для слота tp_alloc объекта типа. Использует механизм выделения памяти Python по умолчанию для выделения памяти под новый экземпляр, обнуляет память, а затем инициализирует её, как при вызове PyObject_Init() или PyObject_InitVar().

Не вызывайте это напрямую для выделения памяти под объект; вместо этого вызывайте слот tp_alloc типа.

Для типов, поддерживающих сборку мусора (т.е. установлен флаг Py_TPFLAGS_HAVE_GC), эта функция ведёт себя как PyObject_GC_New или PyObject_GC_NewVar (за исключением того, что память гарантированно обнуляется перед инициализацией), и должна использоваться в паре с PyObject_GC_Del() в tp_free. В противном случае она ведёт себя как PyObject_New или PyObject_NewVar (с той же гарантией обнуления) и должна использоваться в паре с PyObject_Free() в tp_free.

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

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

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

int PyType_Ready(PyTypeObject *type)¶

Часть Stable ABI.

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

Примечание

If some of the base classes implements the GC protocol and the provided type does not include the Py_TPFLAGS_HAVE_GC in its flags, then the GC protocol will be automatically implemented from its parents. On the contrary, if the type being created does include Py_TPFLAGS_HAVE_GC in its flags then it must implement the GC protocol itself by at least implementing the tp_traverse handle.

PyObject *PyType_GetName(PyTypeObject *type)¶

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

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

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

PyObject *PyType_GetQualName(PyTypeObject *type)¶

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

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

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

PyObject *PyType_GetFullyQualifiedName(PyTypeObject *type)¶

Часть Stable ABI, начиная с версии 3.13.

Возвращает полное квалифицированное имя типа. Эквивалентно f"{type.__module__}.{type.__qualname__}" или type.__qualname__, если type.__module__ не является строкой или равно "builtins".

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

PyObject *PyType_GetModuleName(PyTypeObject *type)¶

Часть Stable ABI, начиная с версии 3.13.

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

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

void *PyType_GetSlot(PyTypeObject *type, int slot)¶

Часть Stable ABI начиная с версии 3.4.

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

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

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

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

PyObject *PyType_GetModule(PyTypeObject *type)¶

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

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

Возвращаемая ссылка является заимствованной от type и будет действительна, пока существует ссылка на type. Не освобождайте её с помощью Py_DECREF() или аналогичных средств.

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

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

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

void *PyType_GetModuleState(PyTypeObject *type)¶

Часть Stable ABI начиная с версии 3.10.

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

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

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

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

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

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

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

Если модуль не найден, возбуждает TypeError и возвращает NULL.

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

Возвращаемая ссылка является заимствованной от type и будет действительна, пока существует ссылка на type. Не освобождайте её с помощью Py_DECREF() или аналогичных средств.

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

int PyType_GetBaseByToken(PyTypeObject *type, void *token, PyTypeObject **result)¶

Часть Stable ABI начиная с версии 3.14.

Найти первый суперкласс в type в порядке разрешения методов, у которого Py_tp_token токен равен заданному.

• Если найдено, установить *result в новую сильную ссылку на него и вернуть 1.

• Если не найдено, установить *result в NULL и вернуть 0.

• При ошибке установить *result в NULL и вернуть -1 с установленным исключением.

Аргумент result может быть равен NULL, и в этом случае *result не устанавливается. Используйте это, если нужно только возвращаемое значение.

Аргумент token не может быть NULL.

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

int PyUnstable_Type_AssignVersionTag(PyTypeObject *type)¶

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

Пытается назначить версионный тег заданному типу.

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

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

int PyType_SUPPORTS_WEAKREFS(PyTypeObject *type)¶

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

См. также

• Объекты слабых ссылокWeak Reference Objects

• weakref