Objetos tipo

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

La estructura C de los objetos utilizados para describir los tipos incorporados.

PyTypeObject PyType_Type
Part of the Stable ABI.

Este es el objeto tipo para objetos tipo; es el mismo objeto que type en la capa Python.

int PyType_Check(PyObject *o)

Retorna un valor distinto de cero si el objeto o es un objeto tipo, incluidas las instancias de tipos derivados del objeto de tipo estándar. Retorna 0 en todos los demás casos. Esta función siempre finaliza con éxito.

int PyType_CheckExact(PyObject *o)

Retorna un valor distinto de cero si el objeto o es un objeto tipo, pero no un subtipo del objeto tipo estándar. Retorna 0 en todos los demás casos. Esta función siempre finaliza con éxito.

unsigned int PyType_ClearCache()
Part of the Stable ABI.

Borra la caché de búsqueda interna. Retorna la etiqueta (tag) de la versión actual.

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.

Nuevo en la versión 3.2.

Distinto en la versión 3.4: El tipo de retorno es ahora unsigned long en vez de long.

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

Invalida la memoria caché de búsqueda interna para el tipo y todos sus subtipos. Esta función debe llamarse después de cualquier modificación manual de los atributos o clases base del tipo.

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.

Nuevo en la versión 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().

Nuevo en la versión 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().

Nuevo en la versión 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.

Nuevo en la versión 3.12.

int PyType_HasFeature(PyTypeObject *o, int feature)

Retorna un valor distinto de cero si el tipo objeto o establece la característica feature. Las características de tipo se indican mediante flags de un solo bit.

int PyType_IS_GC(PyTypeObject *o)

Retorna verdadero si el objeto tipo incluye soporte para el detector de ciclo; Esto prueba el indicador de tipo Py_TPFLAGS_HAVE_GC.

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

Retorna verdadero si a es un subtipo de b.

Esta función solo busca subtipos reales, lo que significa que __subclasscheck__() no se llama en b. Llama PyObject_IsSubclass() para hacer el mismo chequeo que issubclass() haría.

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

Controlador genérico para la ranura tp_alloc de un objeto tipo. Usa el mecanismo de asignación de memoria predeterminado de Python para asignar una nueva instancia e inicializar todo su contenido a NULL.

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

Controlador genérico para la ranura tp_new de un objeto tipo. Crea una nueva instancia utilizando la ranura del tipo tp_alloc.

int PyType_Ready(PyTypeObject *type)
Part of the Stable ABI.

Finalizar un objeto tipo. Se debe llamar a todos los objetos tipo para finalizar su inicialización. Esta función es responsable de agregar ranuras heredadas de la clase base de un tipo. Retorna 0 en caso de éxito o retorna -1 y establece una excepción en caso de error.

Nota

Si algunas de las clases base implementan el protocolo GC y el tipo proporcionado no incluye el Py_TPFLAGS_HAVE_GC en sus banderas, entonces el protocolo GC se implementará automáticamente desde sus padres. Por el contrario, si el tipo que se está creando incluye Py_TPFLAGS_HAVE_GC en sus banderas, entonces debe implementar el protocolo GC por sí mismo al implementar al menos el identificador tp_traverse.

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.

Nuevo en la versión 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.

Nuevo en la versión 3.11.

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

Retorna el puntero de función almacenado en la ranura dada. Si el resultado es NULL, esto indica que la ranura es NULL o que la función se llamó con parámetros no válidos. Las personas que llaman suelen convertir el puntero de resultado en el tipo de función apropiado.

Consulte PyType_Slot.slot para conocer los posibles valores del argumento slot.

Nuevo en la versión 3.4.

Distinto en la versión 3.10: PyType_GetSlot() ahora puede aceptar todos los tipos. Anteriormente, estaba limitado a heap types.

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

Retorna el objeto módulo asociado con el tipo dado cuando se creó el tipo usando PyType_FromModuleAndSpec().

Si no hay ningún módulo asociado con el tipo dado, establece TypeError y retorna 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.

Nuevo en la versión 3.9.

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

Retorna el estado del objeto de módulo asociado con el tipo dado. Este es un atajo para llamar PyModule_GetState() en el resultado de PyType_GetModule().

Si no hay ningún módulo asociado con el tipo dado, establece TypeError y retorna NULL.

Si el tipo type tiene un módulo asociado pero su estado es NULL, retorna NULL sin establecer una excepción.

Nuevo en la versión 3.9.

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

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.

Nuevo en la versión 3.11.

Crear tipos asignados en montículo (heap)

Las siguientes funciones y estructuras se utilizan para crear heap types.

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). Note that metaclasses that override tp_new are not supported.

El argumento bases se puede utilizar para especificar clases base; puede ser solo una clase o una tupla de clases. Si bases es NULL, en su lugar se utiliza la ranura Py_tp_bases. Si esa también es NULL, se usa la ranura Py_tp_base en su lugar. Si también es NULL, el nuevo tipo se deriva de object.

El argumento module se puede utilizar para registrar el módulo en el que se define la nueva clase. Debe ser un objeto de módulo o NULL. Si no es NULL, el módulo se asocia con el nuevo tipo y luego se puede recuperar con PyType_GetModule(). El módulo asociado no es heredado por subclases; debe especificarse para cada clase individualmente.

Esta función llama PyType_Ready() en el tipo nuevo.

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:

Nuevo en la versión 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).

Nuevo en la versión 3.9.

Distinto en la versión 3.10: La función ahora acepta una sola clase como argumento bases y NULL como ranura tp_doc.

Distinto en la versión 3.12: The function now finds and uses a metaclass corresponding to the provided base classes. Previously, only type instances were returned.

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).

Nuevo en la versión 3.3.

Distinto en la versión 3.12: The function now finds and uses a metaclass corresponding to the provided base classes. Previously, only type instances were returned.

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

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

Distinto en la versión 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.

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

Estructura que define el comportamiento de un tipo.

const char *PyType_Spec.name

Nombre del tipo, utilizado para establecer PyTypeObject.tp_name.

int PyType_Spec.basicsize
int PyType_Spec.itemsize

Tamaño de la instancia en bytes, utilizado para establecer PyTypeObject.tp_basicsize y PyTypeObject.tp_itemsize.

int PyType_Spec.flags

Banderas (flags) del tipo, que se usan para establecer PyTypeObject.tp_flags.

Si el indicador Py_TPFLAGS_HEAPTYPE no está establecido, PyType_FromSpecWithBases() lo establece automáticamente.

PyType_Slot *PyType_Spec.slots

Arreglo de estructuras PyType_Slot. Terminado por el valor de ranura especial {0, NULL}.

Each slot ID should be specified at most once.

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

Estructura que define la funcionalidad opcional de un tipo, que contiene una ranura ID y un puntero de valor.

int PyType_Slot.slot

Una ranura ID.

Las ranuras IDs se nombran como los nombres de campo de las estructuras PyTypeObject, PyNumberMethods, PySequenceMethods, PyMappingMethods y PyAsyncMethods con un prefijo Py_ agregado. Por ejemplo, use:

Los siguientes campos no se pueden configurar en absoluto usando PyType_Spec y PyType_Slot:

Estableciendo Py_tp_bases o Py_tp_base puede ser problemático en algunas plataformas. Para evitar problemas, use el argumento bases de PyType_FromSpecWithBases() en su lugar.

Distinto en la versión 3.9: Slots in PyBufferProcs may be set in the unlimited API.

Distinto en la versión 3.11: bf_getbuffer and bf_releasebuffer are now available under the limited API.

void *PyType_Slot.pfunc

El valor deseado de la ranura. En la mayoría de los casos, este es un puntero a una función.

Las ranuras que no sean Py_tp_doc pueden no ser NULL.