Об’єкти типу

type PyTypeObject
Part of the Limited API (as an opaque struct).

Структура C об’єктів, що використовуються для опису вбудованих типів.

PyTypeObject PyType_Type
Part of the Stable ABI.

Це об’єкт типу для об’єктів типу; це той самий об’єкт, що й type на рівні Python.

int PyType_Check(PyObject *o)

Повертає ненульове значення, якщо об’єкт o є об’єктом типу, включаючи екземпляри типів, похідних від об’єкта стандартного типу. Повертає 0 у всіх інших випадках. Ця функція завжди успішна.

int PyType_CheckExact(PyObject *o)

Повертає відмінне від нуля значення, якщо об’єкт o є об’єктом типу, але не підтипом об’єкта стандартного типу. Повертає 0 у всіх інших випадках. Ця функція завжди успішна.

unsigned int PyType_ClearCache()
Part of the Stable ABI.

Очистіть внутрішній кеш пошуку. Повернути тег поточної версії.

unsigned long PyType_GetFlags(PyTypeObject *type)
Part of the Stable ABI.

Return the tp_flags member of type. This function is primarily meant for use with Py_LIMITED_API; the individual flag bits are guaranteed to be stable across Python releases, but access to tp_flags itself is not part of the limited API.

Added in version 3.2.

Змінено в версії 3.4: Тип повернення тепер unsigned long, а не long.

PyObject *PyType_GetDict(PyTypeObject *type)

Return the type object’s internal namespace, which is otherwise only exposed via a read-only proxy (cls.__dict__). This is a replacement for accessing tp_dict directly. The returned dictionary must be treated as read-only.

This function is meant for specific embedding and language-binding cases, where direct access to the dict is necessary and indirect access (e.g. via the proxy or PyObject_GetAttr()) isn’t adequate.

Extension modules should continue to use tp_dict, directly or indirectly, when setting up their own types.

Added in version 3.12.

void PyType_Modified(PyTypeObject *type)
Part of the Stable ABI.

Визнати недійсним внутрішній кеш пошуку для типу та всіх його підтипів. Цю функцію необхідно викликати після будь-якої ручної зміни атрибутів або базових класів типу.

int PyType_AddWatcher(PyType_WatchCallback callback)

Register callback as a type watcher. Return a non-negative integer ID which must be passed to future calls to PyType_Watch(). In case of error (e.g. no more watcher IDs available), return -1 and set an exception.

In free-threaded builds, PyType_AddWatcher() is not thread-safe, so it must be called at start up (before spawning the first thread).

Added in version 3.12.

int PyType_ClearWatcher(int watcher_id)

Clear watcher identified by watcher_id (previously returned from PyType_AddWatcher()). Return 0 on success, -1 on error (e.g. if watcher_id was never registered.)

An extension should never call PyType_ClearWatcher with a watcher_id that was not returned to it by a previous call to PyType_AddWatcher().

Added in version 3.12.

int PyType_Watch(int watcher_id, PyObject *type)

Mark type as watched. The callback granted watcher_id by PyType_AddWatcher() will be called whenever PyType_Modified() reports a change to type. (The callback may be called only once for a series of consecutive modifications to type, if _PyType_Lookup() is not called on type between the modifications; this is an implementation detail and subject to change.)

An extension should never call PyType_Watch with a watcher_id that was not returned to it by a previous call to PyType_AddWatcher().

Added in version 3.12.

typedef int (*PyType_WatchCallback)(PyObject *type)

Type of a type-watcher callback function.

The callback must not modify type or cause PyType_Modified() to be called on type or any type in its MRO; violating this rule could cause infinite recursion.

Added in version 3.12.

int PyType_HasFeature(PyTypeObject *o, int feature)

Повертає ненульове значення, якщо об’єкт типу o встановлює функцію feature. Функції типу позначаються однобітовими прапорцями.

int PyType_IS_GC(PyTypeObject *o)

Return true if the type object includes support for the cycle detector; this tests the type flag Py_TPFLAGS_HAVE_GC.

int PyType_IsSubtype(PyTypeObject *a, PyTypeObject *b)
Part of the Stable ABI.

Повертає true, якщо a є підтипом b.

This function only checks for actual subtypes, which means that __subclasscheck__() is not called on b. Call PyObject_IsSubclass() to do the same check that issubclass() would do.

PyObject *PyType_GenericAlloc(PyTypeObject *type, Py_ssize_t nitems)
Return value: New reference. Part of the Stable ABI.

Generic handler for the tp_alloc slot of a type object. Uses Python’s default memory allocation mechanism to allocate memory for a new instance, zeros the memory, then initializes the memory as if by calling PyObject_Init() or PyObject_InitVar().

Do not call this directly to allocate memory for an object; call the type’s tp_alloc slot instead.

For types that support garbage collection (i.e., the Py_TPFLAGS_HAVE_GC flag is set), this function behaves like PyObject_GC_New or PyObject_GC_NewVar (except the memory is guaranteed to be zeroed before initialization), and should be paired with PyObject_GC_Del() in tp_free. Otherwise, it behaves like PyObject_New or PyObject_NewVar (except the memory is guaranteed to be zeroed before initialization) and should be paired with PyObject_Free() in tp_free.

PyObject *PyType_GenericNew(PyTypeObject *type, PyObject *args, PyObject *kwds)
Return value: New reference. Part of the Stable ABI.

Generic handler for the tp_new slot of a type object. Creates a new instance using the type’s tp_alloc slot and returns the resulting object.

int PyType_Ready(PyTypeObject *type)
Part of the 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)
Return value: New reference. Part of the Stable ABI since version 3.11.

Return the type’s name. Equivalent to getting the type’s __name__ attribute.

Added in version 3.11.

PyObject *PyType_GetQualName(PyTypeObject *type)
Return value: New reference. Part of the Stable ABI since version 3.11.

Return the type’s qualified name. Equivalent to getting the type’s __qualname__ attribute.

Added in version 3.11.

PyObject *PyType_GetFullyQualifiedName(PyTypeObject *type)
Part of the Stable ABI since version 3.13.

Return the type’s fully qualified name. Equivalent to f"{type.__module__}.{type.__qualname__}", or type.__qualname__ if type.__module__ is not a string or is equal to "builtins".

Added in version 3.13.

PyObject *PyType_GetModuleName(PyTypeObject *type)
Part of the Stable ABI since version 3.13.

Return the type’s module name. Equivalent to getting the type.__module__ attribute.

Added in version 3.13.

void *PyType_GetSlot(PyTypeObject *type, int slot)
Part of the Stable ABI since version 3.4.

Повертає вказівник функції, що зберігається у вказаному слоті. Якщо результат NULL, це означає, що або слот має NULL, або що функцію було викликано з недійсними параметрами. Викликачі зазвичай перетворюють покажчик результату на відповідний тип функції.

Перегляньте PyType_Slot.slot, щоб дізнатися про можливі значення аргументу slot.

Added in version 3.4.

Змінено в версії 3.10: PyType_GetSlot() тепер може приймати всі типи. Раніше це було обмежено типами купи.

PyObject *PyType_GetModule(PyTypeObject *type)
Part of the Stable ABI since version 3.10.

Повертає об’єкт модуля, пов’язаний із заданим типом, коли тип було створено за допомогою PyType_FromModuleAndSpec().

Якщо жоден модуль не пов’язаний із заданим типом, встановлюється TypeError і повертається NULL.

This function is usually used to get the module in which a method is defined. Note that in such a method, PyType_GetModule(Py_TYPE(self)) may not return the intended result. Py_TYPE(self) may be a subclass of the intended class, and subclasses are not necessarily defined in the same module as their superclass. See PyCMethod to get the class that defines the method. See PyType_GetModuleByDef() for cases when PyCMethod cannot be used.

Added in version 3.9.

void *PyType_GetModuleState(PyTypeObject *type)
Part of the Stable ABI since version 3.10.

Повертає стан об’єкта модуля, пов’язаного з заданим типом. Це ярлик для виклику PyModule_GetState() за результатом PyType_GetModule().

Якщо жоден модуль не пов’язаний із заданим типом, встановлюється TypeError і повертається NULL.

Якщо тип має пов’язаний модуль, але його стан NULL, повертає NULL без встановлення винятку.

Added in version 3.9.

PyObject *PyType_GetModuleByDef(PyTypeObject *type, struct PyModuleDef *def)
Return value: Borrowed reference. Part of the Stable ABI since version 3.13.

Find the first superclass whose module was created from the given PyModuleDef def, and return that module.

If no module is found, raises a TypeError and returns NULL.

This function is intended to be used together with PyModule_GetState() to get module state from slot methods (such as tp_init or nb_add) and other places where a method’s defining class cannot be passed using the PyCMethod calling convention.

The returned reference is borrowed from type, and will be valid as long as you hold a reference to type. Do not release it with Py_DECREF() or similar.

Added in version 3.11.

int PyType_GetBaseByToken(PyTypeObject *type, void *token, PyTypeObject **result)
Part of the Stable ABI since version 3.14.

Find the first superclass in type’s method resolution order whose Py_tp_token token is equal to the given one.

  • If found, set *result to a new strong reference to it and return 1.

  • If not found, set *result to NULL and return 0.

  • On error, set *result to NULL and return -1 with an exception set.

The result argument may be NULL, in which case *result is not set. Use this if you need only the return value.

The token argument may not be NULL.

Added in version 3.14.

int PyUnstable_Type_AssignVersionTag(PyTypeObject *type)
This is Unstable API. It may change without warning in minor releases.

Attempt to assign a version tag to the given type.

Returns 1 if the type already had a valid version tag or a new one was assigned, or 0 if a new tag could not be assigned.

Added in version 3.12.

Створення типів, виділених у купі

Наступні функції та структури використовуються для створення типів купи.

PyObject *PyType_FromMetaclass(PyTypeObject *metaclass, PyObject *module, PyType_Spec *spec, PyObject *bases)
Part of the Stable ABI since version 3.12.

Create and return a heap type from the spec (see Py_TPFLAGS_HEAPTYPE).

The metaclass metaclass is used to construct the resulting type object. When metaclass is NULL, the metaclass is derived from bases (or Py_tp_base[s] slots if bases is NULL, see below).

Metaclasses that override tp_new are not supported, except if tp_new is NULL.

Аргумент bases можна використовувати для визначення базових класів; це може бути лише один клас або кортеж класів. Якщо bases має значення NULL, замість нього використовується слот Py_tp_bases. Якщо це також NULL, замість нього використовується слот Py_tp_base. Якщо це також NULL, новий тип походить від object.

Аргумент module можна використовувати для запису модуля, в якому визначено новий клас. Це має бути об’єкт модуля або NULL. Якщо не NULL, модуль асоціюється з новим типом і може бути пізніше отриманий за допомогою PyType_GetModule(). Асоційований модуль не успадковується підкласами; її необхідно вказувати для кожного класу окремо.

Ця функція викликає PyType_Ready() для нового типу.

Note that this function does not fully match the behavior of calling type() or using the class statement. With user-provided base types or metaclasses, prefer calling type (or the metaclass) over PyType_From* functions. Specifically:

Added in version 3.12.

PyObject *PyType_FromModuleAndSpec(PyObject *module, PyType_Spec *spec, PyObject *bases)
Return value: New reference. Part of the Stable ABI since version 3.10.

Equivalent to PyType_FromMetaclass(NULL, module, spec, bases).

Added in version 3.9.

Змінено в версії 3.10: Тепер функція приймає один клас як аргумент bases і NULL як слот tp_doc.

Змінено в версії 3.12: The function now finds and uses a metaclass corresponding to the provided base classes. Previously, only type instances were returned.

The tp_new of the metaclass is ignored. which may result in incomplete initialization. Creating classes whose metaclass overrides tp_new is deprecated.

Змінено в версії 3.14: Creating classes whose metaclass overrides tp_new is no longer allowed.

PyObject *PyType_FromSpecWithBases(PyType_Spec *spec, PyObject *bases)
Return value: New reference. Part of the Stable ABI since version 3.3.

Equivalent to PyType_FromMetaclass(NULL, NULL, spec, bases).

Added in version 3.3.

Змінено в версії 3.12: The function now finds and uses a metaclass corresponding to the provided base classes. Previously, only type instances were returned.

The tp_new of the metaclass is ignored. which may result in incomplete initialization. Creating classes whose metaclass overrides tp_new is deprecated.

Змінено в версії 3.14: Creating classes whose metaclass overrides tp_new is no longer allowed.

PyObject *PyType_FromSpec(PyType_Spec *spec)
Return value: New reference. Part of the Stable ABI.

Equivalent to PyType_FromMetaclass(NULL, NULL, spec, NULL).

Змінено в версії 3.12: The function now finds and uses a metaclass corresponding to the base classes provided in Py_tp_base[s] slots. Previously, only type instances were returned.

The tp_new of the metaclass is ignored. which may result in incomplete initialization. Creating classes whose metaclass overrides tp_new is deprecated.

Змінено в версії 3.14: Creating classes whose metaclass overrides tp_new is no longer allowed.

int PyType_Freeze(PyTypeObject *type)
Part of the Stable ABI since version 3.14.

Make a type immutable: set the Py_TPFLAGS_IMMUTABLETYPE flag.

All base classes of type must be immutable.

On success, return 0. On error, set an exception and return -1.

The type must not be used before it’s made immutable. For example, type instances must not be created before the type is made immutable.

Added in version 3.14.

type PyType_Spec
Part of the Stable ABI (including all members).

Структура, що визначає поведінку типу.

const char *name

Назва типу, що використовується для встановлення PyTypeObject.tp_name.

int basicsize

If positive, specifies the size of the instance in bytes. It is used to set PyTypeObject.tp_basicsize.

If zero, specifies that tp_basicsize should be inherited.

If negative, the absolute value specifies how much space instances of the class need in addition to the superclass. Use PyObject_GetTypeData() to get a pointer to subclass-specific memory reserved this way. For negative basicsize, Python will insert padding when needed to meet tp_basicsize’s alignment requirements.

Змінено в версії 3.12: Previously, this field could not be negative.

int itemsize

Size of one element of a variable-size type, in bytes. Used to set PyTypeObject.tp_itemsize. See tp_itemsize documentation for caveats.

If zero, tp_itemsize is inherited. Extending arbitrary variable-sized classes is dangerous, since some types use a fixed offset for variable-sized memory, which can then overlap fixed-sized memory used by a subclass. To help prevent mistakes, inheriting itemsize is only possible in the following situations:

unsigned int flags

Прапорці типу, які використовуються для встановлення PyTypeObject.tp_flags.

Якщо прапор Py_TPFLAGS_HEAPTYPE не встановлено, PyType_FromSpecWithBases() встановлює його автоматично.

PyType_Slot *slots

Масив структур PyType_Slot. Закінчується спеціальним значенням слота {0, NULL}.

Each slot ID should be specified at most once.

type PyType_Slot
Part of the Stable ABI (including all members).

Структура, що визначає необов’язкову функціональність типу, що містить ідентифікатор слота та покажчик значення.

int slot

Ідентифікатор слота.

Ідентифікатори слотів називаються як імена полів структур PyTypeObject, PyNumberMethods, PySequenceMethods, PyMappingMethods і PyAsyncMethods з доданим префіксом Py_. Наприклад, використовуйте:

An additional slot is supported that does not correspond to a PyTypeObject struct field:

The following “offset” fields cannot be set using PyType_Slot:

If it is not possible to switch to a MANAGED flag (for example, for vectorcall or to support Python older than 3.12), specify the offset in Py_tp_members. See PyMemberDef documentation for details.

The following internal fields cannot be set at all when creating a heap type:

Setting Py_tp_bases or Py_tp_base may be problematic on some platforms. To avoid issues, use the bases argument of PyType_FromSpecWithBases() instead.

Змінено в версії 3.9: Слоти в PyBufferProcs можна встановити в необмеженому API.

Змінено в версії 3.11: bf_getbuffer and bf_releasebuffer are now available under the limited API.

Змінено в версії 3.14: The field tp_vectorcall can now set using Py_tp_vectorcall. See the field’s documentation for details.

void *pfunc

Бажане значення слота. У більшості випадків це вказівник на функцію.

pfunc values may not be NULL, except for the following slots:

Py_tp_token

A slot that records a static memory layout ID for a class.

If the PyType_Spec of the class is statically allocated, the token can be set to the spec using the special value Py_TP_USE_SPEC:

static PyType_Slot foo_slots[] = {
   {Py_tp_token, Py_TP_USE_SPEC},

It can also be set to an arbitrary pointer, but you must ensure that:

  • The pointer outlives the class, so it’s not reused for something else while the class exists.

  • It «belongs» to the extension module where the class lives, so it will not clash with other extensions.

Use PyType_GetBaseByToken() to check if a class’s superclass has a given token – that is, check whether the memory layout is compatible.

To get the token for a given class (without considering superclasses), use PyType_GetSlot() with Py_tp_token.

Added in version 3.14.

Py_TP_USE_SPEC

Used as a value with Py_tp_token to set the token to the class’s PyType_Spec. Expands to NULL.

Added in version 3.14.