# Objetos Tipo

Quizás una de las estructuras más importantes del sistema de objetos Python es la estructura que define un nuevo tipo: la estructura `PyTypeObject`. Los objetos tipo se pueden manejar utilizando cualquiera de las funciones `PyObject_*()` o `PyType_*()`, pero no ofrecen mucho que sea interesante para la mayoría de las aplicaciones de Python. Estos objetos son fundamentales para el comportamiento de los objetos, por lo que son muy importantes para el propio intérprete y para cualquier módulo de extensión que implemente nuevos tipos.

Los objetos de tipo son bastante grandes en comparación con la mayoría de los tipos estándar. La razón del tamaño es que cada objeto de tipo almacena una gran cantidad de valores, principalmente punteros de función C, cada uno de los cuales implementa una pequeña parte de la funcionalidad del tipo. Los campos del objeto tipo se examinan en detalle en esta sección. Los campos se describirán en el orden en que aparecen en la estructura.

Además de la siguiente referencia rápida, la sección Ejemplos proporciona una visión rápida del significado y uso de `PyTypeObject`.

## Referencia rápida

### «ranuras tp» (tp slots)

Ranura `PyTypeObject` 1 | Type | métodos/atributos especiales | Información 2
--- | --- | --- | ---
O | T | D | I
<R> `tp_name` | const char * | __name__ | X | X |  |
`tp_basicsize` | Py_ssize_t |  | X | X |  | X
`tp_itemsize` | Py_ssize_t |  |  | X |  | X
`tp_dealloc` | `destructor` |  | X | X |  | X
`tp_vectorcall_offset` | Py_ssize_t |  |  |  |  | ?
(`tp_getattr`) | `getattrfunc` | __getattribute__, __getattr__ |  |  |  | G
(`tp_setattr`) | `setattrfunc` | __setattr__, __delattr__ |  |  |  | G
`tp_as_async` | `PyAsyncMethods` * | sub-ranuras (sub-slots) |  |  |  | %
`tp_repr` | `reprfunc` | __repr__ | X | X |  | X
`tp_as_number` | `PyNumberMethods` * | sub-ranuras (sub-slots) |  |  |  | %
`tp_as_sequence` | `PySequenceMethods` * | sub-ranuras (sub-slots) |  |  |  | %
`tp_as_mapping` | `PyMappingMethods` * | sub-ranuras (sub-slots) |  |  |  | %
`tp_hash` | `hashfunc` | __hash__ | X |  |  | G
`tp_call` | `ternaryfunc` | __call__ |  | X |  | X
`tp_str` | `reprfunc` | __str__ | X |  |  | X
`tp_getattro` | `getattrofunc` | __getattribute__, __getattr__ | X | X |  | G
`tp_setattro` | `setattrofunc` | __setattr__, __delattr__ | X | X |  | G
`tp_as_buffer` | `PyBufferProcs` * |  |  |  |  | %
`tp_flags` | unsigned long |  | X | X |  | ?
`tp_doc` | const char * | __doc__ | X | X |  |
`tp_traverse` | `traverseproc` |  |  | X |  | G
`tp_clear` | `inquiry` |  |  | X |  | G
`tp_richcompare` | `richcmpfunc` | __lt__, __le__, __eq__, __ne__, __gt__, __ge__ | X |  |  | G
`tp_weaklistoffset` | Py_ssize_t |  |  | X |  | ?
`tp_iter` | `getiterfunc` | __iter__ |  |  |  | X
`tp_iternext` | `iternextfunc` | __next__ |  |  |  | X
`tp_methods` | `PyMethodDef` [] |  | X | X |  |
`tp_members` | `PyMemberDef` [] |  |  | X |  |
`tp_getset` | `PyGetSetDef` [] |  | X | X |  |
`tp_base` | `PyTypeObject` * | __base__ |  |  | X |
`tp_dict` | `PyObject` * | __dict__ |  |  | ? |
`tp_descr_get` | `descrgetfunc` | __get__ |  |  |  | X
`tp_descr_set` | `descrsetfunc` | __set__, __delete__ |  |  |  | X
`tp_dictoffset` | Py_ssize_t |  |  | X |  | ?
`tp_init` | `initproc` | __init__ | X | X |  | X
`tp_alloc` | `allocfunc` |  | X |  | ? | ?
`tp_new` | `newfunc` | __new__ | X | X | ? | ?
`tp_free` | `freefunc` |  | X | X | ? | ?
`tp_is_gc` | `inquiry` |  |  | X |  | X
<`tp_bases`> | `PyObject` * | __bases__ |  |  | ~ |
<`tp_mro`> | `PyObject` * | __mro__ |  |  | ~ |
[`tp_cache`] | `PyObject` * |  |  |  |
[`tp_subclasses`] | `PyObject` * | __subclasses__ |  |  |
[`tp_weaklist`] | `PyObject` * |  |  |  |
(`tp_del`) | `destructor` |  |  |  |  |
[`tp_version_tag`] | unsigned int |  |  |  |
`tp_finalize` | `destructor` | __del__ |  |  |  | X

Si `COUNT_ALLOCS` está definido, entonces también existen los siguientes campos (solo internos):

- `tp_allocs`

- `tp_frees`

- `tp_maxalloc`

- `tp_prev`

- `tp_next`

1

  Un nombre de ranura entre paréntesis indica que está (efectivamente) en desuso. Los nombres entre paréntesis angulares deben tratarse como de solo lectura. Los nombres entre corchetes son solo para uso interno. «<R>» (como prefijo) significa que el campo es obligatorio (no debe ser `NULL`).

2

  Columnas:

  «O»: establecido en `PyBaseObject_Type`

  «T»: establecido en `PyType_Type`

  «D»: por defecto (si la ranura está establecida como `NULL`)

      X - PyType_Ready sets this value if it is NULL
      ~ - PyType_Ready always sets this value (it should be NULL)
      ? - PyType_Ready may set this value depending on other slots

      Also see the inheritance column ("I").

  «I»: herencia

      X - type slot is inherited via PyType_Ready if defined with a NULL value
      % - the slots of the sub-struct are inherited individually
      G - inherited, but only in combination with other slots; see the slot's description
      ? - it's complicated; see the slot's description

  Tenga en cuenta que algunos espacios se heredan efectivamente a través de la cadena de búsqueda de atributos normal.

### sub-ranuras (sub-slots)

Ranuras (Slot) | Type | métodos especiales
--- | --- | ---
`am_await` | `unaryfunc` | __await__
`am_aiter` | `unaryfunc` | __aiter__
`am_anext` | `unaryfunc` | __anext__
`nb_add` | `binaryfunc` | __add__ __radd__
`nb_inplace_add` | `binaryfunc` | __iadd__
`nb_subtract` | `binaryfunc` | __sub__ __rsub__
`nb_inplace_subtract` | `binaryfunc` | __sub__
`nb_multiply` | `binaryfunc` | __mul__ __rmul__
`nb_inplace_multiply` | `binaryfunc` | __mul__
`nb_remainder` | `binaryfunc` | __mod__ __rmod__
`nb_inplace_remainder` | `binaryfunc` | __mod__
`nb_divmod` | `binaryfunc` | __divmod__ __rdivmod__
`nb_power` | `ternaryfunc` | __pow__ __rpow__
`nb_inplace_power` | `ternaryfunc` | __pow__
`nb_negative` | `unaryfunc` | __neg__
`nb_positive` | `unaryfunc` | __pos__
`nb_absolute` | `unaryfunc` | __abs__
`nb_bool` | `inquiry` | __bool__
`nb_invert` | `unaryfunc` | __invert__
`nb_lshift` | `binaryfunc` | __lshift__ __rlshift__
`nb_inplace_lshift` | `binaryfunc` | __lshift__
`nb_rshift` | `binaryfunc` | __rshift__ __rrshift__
`nb_inplace_rshift` | `binaryfunc` | __rshift__
`nb_and` | `binaryfunc` | __and__ __rand__
`nb_inplace_and` | `binaryfunc` | __and__
`nb_xor` | `binaryfunc` | __xor__ __rxor__
`nb_inplace_xor` | `binaryfunc` | __xor__
`nb_or` | `binaryfunc` | __or__ __ror__
`nb_inplace_or` | `binaryfunc` | __or__
`nb_int` | `unaryfunc` | __int__
`nb_reserved` | void * |
`nb_float` | `unaryfunc` | __float__
`nb_floor_divide` | `binaryfunc` | __floordiv__
`nb_inplace_floor_divide` | `binaryfunc` | __floordiv__
`nb_true_divide` | `binaryfunc` | __truediv__
`nb_inplace_true_divide` | `binaryfunc` | __truediv__
`nb_index` | `unaryfunc` | __index__
`nb_matrix_multiply` | `binaryfunc` | __matmul__ __rmatmul__
`nb_inplace_matrix_multiply` | `binaryfunc` | __matmul__
`mp_length` | `lenfunc` | __len__
`mp_subscript` | `binaryfunc` | __getitem__
`mp_ass_subscript` | `objobjargproc` | __setitem__, __delitem__
`sq_length` | `lenfunc` | __len__
`sq_concat` | `binaryfunc` | __add__
`sq_repeat` | `ssizeargfunc` | __mul__
`sq_item` | `ssizeargfunc` | __getitem__
`sq_ass_item` | `ssizeobjargproc` | __setitem__ __delitem__
`sq_contains` | `objobjproc` | __contains__
`sq_inplace_concat` | `binaryfunc` | __iadd__
`sq_inplace_repeat` | `ssizeargfunc` | __imul__
`bf_getbuffer` | `getbufferproc()` |
`bf_releasebuffer` | `releasebufferproc()` |

### ranura de typedefs

typedef | Tipos Parámetros | Tipo de Retorno
--- | --- | ---
`allocfunc` | `PyTypeObject` * Py_ssize_t | `PyObject` *
`destructor` | void * | void
`freefunc` | void * | void
`traverseproc` | void * `visitproc` void * | int
`newfunc` | `PyObject` * `PyObject` * `PyObject` * | `PyObject` *
`initproc` | `PyObject` * `PyObject` * `PyObject` * | int
`reprfunc` | `PyObject` * | `PyObject` *
`getattrfunc` | `PyObject` * const char * | `PyObject` *
`setattrfunc` | `PyObject` * const char * `PyObject` * | int
`getattrofunc` | `PyObject` * `PyObject` * | `PyObject` *
`setattrofunc` | `PyObject` * `PyObject` * `PyObject` * | int
`descrgetfunc` | `PyObject` * `PyObject` * `PyObject` * | `PyObject` *
`descrsetfunc` | `PyObject` * `PyObject` * `PyObject` * | int
`hashfunc` | `PyObject` * | Py_hash_t
`richcmpfunc` | `PyObject` * `PyObject` * int | `PyObject` *
`getiterfunc` | `PyObject` * | `PyObject` *
`iternextfunc` | `PyObject` * | `PyObject` *
`lenfunc` | `PyObject` * | Py_ssize_t
`getbufferproc` | `PyObject` * `Py_buffer` * int | int
`releasebufferproc` | `PyObject` * `Py_buffer` * | void
`inquiry` | void * | int
`unaryfunc` | `PyObject` * | `PyObject` *
`binaryfunc` | `PyObject` * `PyObject` * | `PyObject` *
`ternaryfunc` | `PyObject` * `PyObject` * `PyObject` * | `PyObject` *
`ssizeargfunc` | `PyObject` * Py_ssize_t | `PyObject` *
`ssizeobjargproc` | `PyObject` * Py_ssize_t | int
`objobjproc` | `PyObject` * `PyObject` * | int
`objobjargproc` | `PyObject` * `PyObject` * `PyObject` * | int

Vea Tipo Ranura typedefs abajo para más detalles.

## Definición de `PyTypeObject`

La definición de estructura para `PyTypeObject` se puede encontrar en `Include/object.h`. Por conveniencia de referencia, esto repite la definición encontrada allí:

    typedef struct _typeobject {
        PyObject_VAR_HEAD
        const char *tp_name; /* For printing, in format "<module>.<name>" */
        Py_ssize_t tp_basicsize, tp_itemsize; /* For allocation */

        /* Methods to implement standard operations */

        destructor tp_dealloc;
        Py_ssize_t tp_vectorcall_offset;
        getattrfunc tp_getattr;
        setattrfunc tp_setattr;
        PyAsyncMethods *tp_as_async; /* formerly known as tp_compare (Python 2)
                                        or tp_reserved (Python 3) */
        reprfunc tp_repr;

        /* Method suites for standard classes */

        PyNumberMethods *tp_as_number;
        PySequenceMethods *tp_as_sequence;
        PyMappingMethods *tp_as_mapping;

        /* More standard operations (here for binary compatibility) */

        hashfunc tp_hash;
        ternaryfunc tp_call;
        reprfunc tp_str;
        getattrofunc tp_getattro;
        setattrofunc tp_setattro;

        /* Functions to access object as input/output buffer */
        PyBufferProcs *tp_as_buffer;

        /* Flags to define presence of optional/expanded features */
        unsigned long tp_flags;

        const char *tp_doc; /* Documentation string */

        /* call function for all accessible objects */
        traverseproc tp_traverse;

        /* delete references to contained objects */
        inquiry tp_clear;

        /* rich comparisons */
        richcmpfunc tp_richcompare;

        /* weak reference enabler */
        Py_ssize_t tp_weaklistoffset;

        /* Iterators */
        getiterfunc tp_iter;
        iternextfunc tp_iternext;

        /* Attribute descriptor and subclassing stuff */
        struct PyMethodDef *tp_methods;
        struct PyMemberDef *tp_members;
        struct PyGetSetDef *tp_getset;
        struct _typeobject *tp_base;
        PyObject *tp_dict;
        descrgetfunc tp_descr_get;
        descrsetfunc tp_descr_set;
        Py_ssize_t tp_dictoffset;
        initproc tp_init;
        allocfunc tp_alloc;
        newfunc tp_new;
        freefunc tp_free; /* Low-level free-memory routine */
        inquiry tp_is_gc; /* For PyObject_IS_GC */
        PyObject *tp_bases;
        PyObject *tp_mro; /* method resolution order */
        PyObject *tp_cache;
        PyObject *tp_subclasses;
        PyObject *tp_weaklist;
        destructor tp_del;

        /* Type attribute cache version tag. Added in version 2.6 */
        unsigned int tp_version_tag;

        destructor tp_finalize;

    } PyTypeObject;

## Ranuras (Slots) `PyObject`

La estructura de objeto de tipo extiende la estructura `PyVarObject`. El campo `ob_size` se usa para tipos dinámicos (creado por `type_new()`, generalmente llamado desde una declaración de clase). Tenga en cuenta que `PyType_Type` (el metatipo) inicializa `tp_itemsize`, lo que significa que sus instancias (es decir, objetos de tipo) deben tener el campo `ob_size`.

PyObject* `PyObject._ob_next`
PyObject* `PyObject._ob_prev`

  Estos campos solo están presentes cuando se define la macro `Py_TRACE_REFS`. Su inicialización a `NULL` se ocupa de la macro `PyObject_HEAD_INIT`. Para los objetos asignados estáticamente, estos campos siempre permanecen `NULL`. Para los objetos asignados dinámicamente, estos dos campos se utilizan para vincular el objeto en una lista doblemente vinculada de todos objetos vivos en el montón. Esto podría usarse para varios propósitos de depuración; Actualmente, el único uso es imprimir los objetos que aún están vivos al final de una ejecución cuando se establece la variable de entorno `PYTHONDUMPREFS`.

  Herencia:

  Estos campos no son heredados por subtipos.

Py_ssize_t `PyObject.ob_refcnt`

  Este es el recuento de referencia del objeto tipo, inicializado a `1` por el macro `PyObject_HEAD_INIT`. Tenga en cuenta que para los objetos de tipo asignados estáticamente, las instancias del tipo (objetos cuyo `ob_type` apunta al tipo) no cuentan como referencias. Pero para los objetos de tipo asignados dinámicamente, las instancias sí cuentan como referencias.

  Herencia:

  Este campo no es heredado por los subtipos.

PyTypeObject* `PyObject.ob_type`

  Este es el tipo del tipo, en otras palabras, su metatipo. Se inicializa mediante el argumento de la macro `PyObject_HEAD_INIT`, y su valor normalmente debería ser `&PyType_Type`. Sin embargo, para los módulos de extensión cargables dinámicamente que deben ser utilizables en Windows (al menos), el compilador se queja de que este no es un inicializador válido. Por lo tanto, la convención es pasar `NULL` al macro `PyObject_HEAD_INIT` e inicializar este campo explícitamente al comienzo de la función de inicialización del módulo, antes de hacer cualquier otra cosa. Esto normalmente se hace así:

      Foo_Type.ob_type = &PyType_Type;

  Esto debe hacerse antes de que se creen instancias del tipo. `PyType_Ready()` comprueba si `ob_type` es `NULL`, y si es así, lo inicializa en el campo `ob_type` de la clase base. `PyType_Ready()` no cambiará este campo si no es cero.

  Herencia:

  Este campo es heredado por subtipos.

## Ranuras `PyVarObject`

Py_ssize_t `PyVarObject.ob_size`

  Para los objetos tipo asignados estáticamente, esto debe inicializarse a cero. Para los objetos tipo asignados dinámicamente, este campo tiene un significado interno especial.

  Herencia:

  Este campo no es heredado por los subtipos.

## Ranuras `PyTypeObject`

Cada ranura tiene una sección que describe la herencia. Si `PyType_Ready()` puede establecer un valor cuando el campo se establece en `NULL`, entonces también habrá una sección «Predeterminada». (Tenga en cuenta que muchos campos establecidos en `PyBaseObject_Type` y `PyType_Type` actúan efectivamente como valores predeterminados).

const char* `PyTypeObject.tp_name`

  Puntero a una cadena de caracteres terminada en `NULL` que contiene el nombre del tipo. Para los tipos que son accesibles como módulos globales, la cadena debe ser el nombre completo del módulo, seguido de un punto, seguido del nombre del tipo; para los tipos integrados, debe ser solo el nombre del tipo. Si el módulo es un submódulo de un paquete, el nombre completo del paquete es parte del nombre completo del módulo. Por ejemplo, un tipo llamado `T` definido en el módulo `M` en el subpaquete `Q` en el paquete `P` debe tener el inicializador `tp_name` `"PQMT"`.

  Para los objetos tipo asignados dinámicamente, este debería ser solo el nombre del tipo, y el nombre del módulo almacenado explícitamente en el tipo diccionario (dict) como el valor para la clave `'__module__'`.

  Para los objetos tipo asignados estáticamente, el campo `tp_name` debe contener un punto. Todo antes del último punto se hace accesible como el atributo `__module__`, y todo después del último punto se hace accesible como el atributo `__name__`.

  Si no hay ningún punto, todo el campo `tp_name` se hace accesible como el atributo `__name__`, y el atributo `__module__` no está definido (a menos que sea explícitamente establecido en el diccionario, como se explicó anteriormente). Esto significa que su tipo será imposible de guardar como pickle. Además, no figurará en la documentación del módulo creado con pydoc.

  Este campo no debe ser `NULL`. Es el único campo obligatorio en `PyTypeObject()` (que no sea potencialmente `tp_itemsize`).

  Herencia:

  Este campo no es heredado por los subtipos.

Py_ssize_t `PyTypeObject.tp_basicsize`
Py_ssize_t `PyTypeObject.tp_itemsize`

  Estos campos permiten calcular el tamaño en bytes de instancias del tipo.

  Hay dos tipos de tipos: los tipos con instancias de longitud fija tienen un campo cero `tp_itemsize`, los tipos con instancias de longitud variable tienen un campo distinto de cero `tp_itemsize`. Para un tipo con instancias de longitud fija, todas las instancias tienen el mismo tamaño, dado en `tp_basicsize`.

  Para un tipo con instancias de longitud variable, las instancias deben tener un campo `ob_size`, y el tamaño de la instancia es `tp_basicsize` más N veces `tp_itemsize`, donde N es la «longitud» del objeto. El valor de N generalmente se almacena en el campo `ob_size` de la instancia. Hay excepciones: por ejemplo, los ints usan un negativo `ob_size` para indicar un número negativo, y N es `abs(ob_size)` allí. Además, la presencia de un campo `ob_size` en el diseño de la instancia no significa que la estructura de la instancia sea de longitud variable (por ejemplo, la estructura para el tipo de lista tiene instancias de longitud fija, aunque esas instancias tienen un significativo campo `ob_size`).

  El tamaño básico incluye los campos en la instancia declarada por el macro `PyObject_HEAD` o `PyObject_VAR_HEAD` (lo que se use para declarar la estructura de la instancia) y esto a su vez incluye campos `_ob_prev` y `_ob_next` si están presentes. Esto significa que la única forma correcta de obtener un inicializador para `tp_basicsize` es usar el operador `sizeof` en la estructura utilizada para declarar el diseño de la instancia. El tamaño básico no incluye el tamaño del encabezado del GC.

  Una nota sobre la alineación: si los elementos variables requieren una alineación particular, esto debe ser atendido por el valor de `tp_basicsize`. Ejemplo: supongamos que un tipo implementa un arreglo de dobles (`double`). `tp_itemsize` es `sizeof(double)`. Es responsabilidad del programador que `tp_basicsize` es un múltiplo de `sizeof(double)` (suponiendo que este sea el requisito de alineación para `double`).

  Para cualquier tipo con instancias de longitud variable, este campo no debe ser `NULL`.

  Herencia:

  Estos campos se heredan por separado por subtipos. Si el tipo base tiene un miembro distinto de cero `tp_itemsize`, generalmente no es seguro establecer `tp_itemsize` en un valor diferente de cero en un subtipo ( aunque esto depende de la implementación del tipo base).

destructor `PyTypeObject.tp_dealloc`

  Un puntero a la función destructor de instancias. Esta función debe definirse a menos que el tipo garantice que sus instancias nunca se desasignarán (como es el caso de los singletons `None` y `Ellipsis`). La firma de la función es:

      void tp_dealloc(PyObject *self);

  La función destructor es llamada por las macros `Py_DECREF()` y `Py_XDECREF()` cuando el nuevo recuento de referencia es cero. En este punto, la instancia todavía existe, pero no hay referencias a ella. La función destructor debe liberar todas las referencias que posee la instancia, liberar todos los búferes de memoria que posee la instancia (utilizando la función de liberación correspondiente a la función de asignación utilizada para asignar el búfer) y llamar a los tipos función `tp_free`. Si el tipo no es subtipable (no tiene establecido el bit de indicador `Py_TPFLAGS_BASETYPE`), está permitido llamar al objeto desasignador directamente en lugar de a través de `tp_free`. El objeto desasignador debe ser el utilizado para asignar la instancia; normalmente es `PyObject_Del()` si la instancia se asignó usando `PyObject_New()` o `PyObject_VarNew()`, o `PyObject_GC_Del()` si la instancia se asignó usando `PyObject_GC_New()` o `PyObject_GC_NewVar()`.

  Finalmente, si el tipo está asignado en el montón (`Py_TPFLAGS_HEAPTYPE`), el desasignador debería disminuir el conteo de referencia para su objeto tipo después de llamar al desasignador del tipo. Para evitar punteros colgantes, la forma recomendada de lograr esto es:

      static void foo_dealloc(foo_object *self) {
          PyTypeObject *tp = Py_TYPE(self);
          // free references and buffers here
          tp->tp_free(self);
          Py_DECREF(tp);
      }

  Herencia:

  Este campo es heredado por subtipos.

Py_ssize_t `PyTypeObject.tp_vectorcall_offset`

  Un desplazamiento opcional a una función por instancia que implementa la llamada al objeto usando el protocolo vectorcall, una alternativa más eficiente del más simple `tp_call`.

  Este campo solo se usa si se establece el indicador `_Py_TPFLAGS_HAVE_VECTORCALL`. Si es así, debe ser un número entero positivo que contenga el desplazamiento en la instancia de un puntero a `vectorcallfunc`. La firma es la misma que para `_PyObject_Vectorcall()`:

      PyObject *vectorcallfunc(PyObject *callable, PyObject *const *args, size_t nargsf, PyObject *kwnames)

  El puntero vectorcallfunc puede ser cero, en cuyo caso la instancia se comporta como si `_Py_TPFLAGS_HAVE_VECTORCALL` no se hubiera establecido: la llamada de la instancia recae en `tp_call`.

  Cualquier clase que establezca `_Py_TPFLAGS_HAVE_VECTORCALL` también debe establecer `tp_call` y asegurarse de que su comportamiento sea coherente con la función vectorcallfunc. Esto se puede hacer configurando tp_call en `PyVectorcall_Call`:

  PyObject *`PyVectorcall_Call`(PyObject *callable, PyObject *tuple, PyObject *dict)

    Llama el callable de vectorcallfunc con argumentos posicionales y de palabras clave dados en una tupla y diccionario (dict), respectivamente.

    Esta función está destinada a ser utilizada en la ranura `tp_call`. No vuelve a caer a `tp_call` y actualmente no marca la bandera `_Py_TPFLAGS_HAVE_VECTORCALL`. Para llamar a un objeto, use una de las funciones `PyObject_Call` en su lugar.

  Nota

  No se recomienda para tipos montículo para implementar el protocolo vectorcall. Cuando un usuario establece `__call__` en el código Python, solo se actualiza `tp_call`, posiblemente haciendo que sea inconsistente con la función vectorcall.

  Nota

  La semántica de la ranura `tp_vectorcall_offset` es provisional y se espera que finalice en Python 3.9. Si usa vectorcall, planifique actualizar su código para Python 3.9.

  Distinto en la versión 3.8: Esta ranura se usó para el formato de impresión en Python 2.x. En Python 3.0 a 3.7, estaba reservado y se llamaba `tp_print`.

  Herencia:

  Los subtipos heredan este campo junto con `tp_call`: un subtipo hereda `tp_vectorcall_offset` de su tipo base cuando el subtipo `tp_call` es `NULL`.

  Tenga en cuenta que los tipos montículo, (heap types, incluidas las subclases definidas en Python) no heredan el indicador `_Py_TPFLAGS_HAVE_VECTORCALL`.

getattrfunc `PyTypeObject.tp_getattr`

  Un puntero opcional a la función «obtener atributo cadena de caracteres» (get-attribute-string).

  Este campo está en desuso. Cuando se define, debe apuntar a una función que actúe igual que la función `tp_getattro`, pero tomando una cadena de caracteres C en lugar de un objeto de cadena Python para dar el nombre del atributo.

  Herencia:

  Grupo: `tp_getattr`, `tp_getattro`

  Este campo es heredado por los subtipos junto con `tp_getattro`: un subtipo hereda ambos `tp_getattr` y `tp_getattro` de su base escriba cuando los subtipos `tp_getattr` y `tp_getattro` son ambos `NULL`.

setattrfunc `PyTypeObject.tp_setattr`

  Un puntero opcional a la función para configurar y eliminar atributos.

  Este campo está en desuso. Cuando se define, debe apuntar a una función que actúe igual que la función `tp_setattro`, pero tomando una cadena de caracteres C en lugar de un objeto de cadena Python para dar el nombre del atributo.

  Herencia:

  Grupo: `tp_setattr`, `tp_setattro`

  Este campo es heredado por los subtipos junto con `tp_setattro`: un subtipo hereda ambos `tp_setattr` y `tp_setattro` de su base escriba cuando los subtipos `tp_setattr` y `tp_setattro` son ambos `NULL`.

PyAsyncMethods* `PyTypeObject.tp_as_async`

  Puntero a una estructura adicional que contiene campos relevantes solo para los objetos que implementan los protocolos «esperable» (awaitable) y «iterador asíncrono» (asynchronous iterator) en el nivel C. Ver Estructuras de objetos asíncronos para más detalles.

  Nuevo en la versión 3.5: Anteriormente conocidos como `tp_compare` y `tp_reserved`.

  Herencia:

  El campo `tp_as_async` no se hereda, pero los campos contenidos se heredan individualmente.

reprfunc `PyTypeObject.tp_repr`

  Un puntero opcional a una función que implementa la función incorporada `repr()`.

  La firma es la misma que para `PyObject_Repr()`:

      PyObject *tp_repr(PyObject *self);

  La función debe retornar una cadena de caracteres o un objeto Unicode. Idealmente, esta función debería retornar una cadena que, cuando se pasa a `eval()`, dado un entorno adecuado, retorna un objeto con el mismo valor. Si esto no es factible, debe retornar una cadena que comience con `'<'` y termine con `'>'` desde la cual se puede deducir tanto el tipo como el valor del objeto.

  Herencia:

  Este campo es heredado por subtipos.

  Por defecto:

  Cuando este campo no está configurado, se retorna una cadena de caracteres de la forma `<%s object at %p>`, donde `%s` se reemplaza por el nombre del tipo y `%p` por dirección de memoria del objeto.

PyNumberMethods* `PyTypeObject.tp_as_number`

  Puntero a una estructura adicional que contiene campos relevantes solo para objetos que implementan el protocolo numérico. Estos campos están documentados en Estructuras de Objetos de Números.

  Herencia:

  El campo `tp_as_number` no se hereda, pero los campos contenidos se heredan individualmente.

PySequenceMethods* `PyTypeObject.tp_as_sequence`

  Puntero a una estructura adicional que contiene campos relevantes solo para objetos que implementan el protocolo de secuencia. Estos campos están documentados en Estructuras de objetos secuencia.

  Herencia:

  El campo `tp_as_sequence` no se hereda, pero los campos contenidos se heredan individualmente.

PyMappingMethods* `PyTypeObject.tp_as_mapping`

  Puntero a una estructura adicional que contiene campos relevantes solo para objetos que implementan el protocolo de mapeo. Estos campos están documentados en Estructuras de Objetos Mapeo.

  Herencia:

  El campo `tp_as_mapping` no se hereda, pero los campos contenidos se heredan individualmente.

hashfunc `PyTypeObject.tp_hash`

  Un puntero opcional a una función que implementa la función incorporada `hash()`.

  La firma es la misma que para `PyObject_Hash()`:

      Py_hash_t tp_hash(PyObject *);

  El valor `-1` no debe retornarse como un valor de retorno normal; Cuando se produce un error durante el cálculo del valor hash, la función debe establecer una excepción y retornar `-1`.

  Cuando este campo no está establecido (y `tp_richcompare` no está establecido), se lanza `TypeError` cuando hay un intento de tomar el hash del objeto. Esto es lo mismo que establecerlo en `PyObject_HashNotImplemented()`.

  Este campo se puede establecer explícitamente en `PyObject_HashNotImplemented()` para bloquear la herencia del método hash de un tipo primario. Esto se interpreta como el equivalente de `__hash__ = None` en el nivel de Python, lo que hace que `isinstance(o, collections.Hashable)` retorne correctamente `False`. Tenga en cuenta que lo contrario también es cierto: establecer `__hash__ = None` en una clase en el nivel de Python dará como resultado que la ranura `tp_hash` se establezca en `PyObject_HashNotImplemented()`.

  Herencia:

  Grupo: `tp_hash`, `tp_richcompare`

  Este campo es heredado por subtipos junto con `tp_richcompare`: un subtipo hereda ambos `tp_richcompare` y `tp_hash`, cuando los subtipos `tp_richcompare` y `tp_hash` son ambos `NULL`.

ternaryfunc `PyTypeObject.tp_call`

  Un puntero opcional a una función que implementa la llamada al objeto. Esto debería ser `NULL` si el objeto no es invocable. La firma es la misma que para `PyObject_Call()`:

      PyObject *tp_call(PyObject *self, PyObject *args, PyObject *kwargs);

  Herencia:

  Este campo es heredado por subtipos.

reprfunc `PyTypeObject.tp_str`

  Un puntero opcional a una función que implementa la operación integrada `str()`. (Tenga en cuenta que `str` es un tipo ahora, y `str()` llama al constructor para ese tipo. Este constructor llama a `PyObject_Str()` para hacer el trabajo real, y `PyObject_Str()` llamará a este controlador.)

  La firma es la misma que para `PyObject_Str()`:

      PyObject *tp_str(PyObject *self);

  La función debe retornar una cadena de caracteres o un objeto Unicode. Debe ser una representación de cadena «amigable» del objeto, ya que esta es la representación que será utilizada, entre otras cosas, por la función `print()`.

  Herencia:

  Este campo es heredado por subtipos.

  Por defecto:

  Cuando este campo no está configurado, se llama a `PyObject_Repr()` para retornar una representación de cadena de caracteres.

getattrofunc `PyTypeObject.tp_getattro`

  Un puntero opcional a la función «obtener atributo» (get-attribute).

  La firma es la misma que para `PyObject_GetAttr()`:

      PyObject *tp_getattro(PyObject *self, PyObject *attr);

  Por lo general, es conveniente establecer este campo en `PyObject_GenericGetAttr()`, que implementa la forma normal de buscar atributos de objeto.

  Herencia:

  Grupo: `tp_getattr`, `tp_getattro`

  Este campo es heredado por los subtipos junto con `tp_getattr`: un subtipo hereda ambos `tp_getattr` y `tp_getattro` de su base escriba cuando los subtipos `tp_getattr` y `tp_getattro` son ambos `NULL`.

  Por defecto:

  `PyBaseObject_Type` usa `PyObject_GenericGetAttr()`.

setattrofunc `PyTypeObject.tp_setattro`

  Un puntero opcional a la función para configurar y eliminar atributos.

  La firma es la misma que para `PyObject_SetAttr()`:

      PyObject *tp_setattro(PyObject *self, PyObject *attr, PyObject *value);

  Además, se debe admitir la configuración de value en `NULL` para eliminar un atributo. Por lo general, es conveniente establecer este campo en `PyObject_GenericSetAttr()`, que implementa la forma normal de establecer los atributos del objeto.

  Herencia:

  Grupo: `tp_setattr`, `tp_setattro`

  Los subtipos heredan este campo junto con `tp_setattr`: un subtipo hereda ambos `tp_setattr` y `tp_setattro` de su base escriba cuando los subtipos `tp_setattr` y `tp_setattro` son ambos `NULL`.

  Por defecto:

  `PyBaseObject_Type` usa `PyObject_GenericSetAttr()`.

PyBufferProcs* `PyTypeObject.tp_as_buffer`

  Puntero a una estructura adicional que contiene campos relevantes solo para objetos que implementan la interfaz del búfer. Estos campos están documentados en Estructuras de Objetos Búfer.

  Herencia:

  El campo `tp_as_buffer` no se hereda, pero los campos contenidos se heredan individualmente.

unsigned long `PyTypeObject.tp_flags`

  Este campo es una máscara de bits de varias banderas. Algunas banderas indican semántica variante para ciertas situaciones; otros se utilizan para indicar que ciertos campos en el tipo de objeto (o en las estructuras de extensión a las que se hace referencia a través de `tp_as_number`, `tp_as_sequence`, `tp_as_mapping`, y `tp_as_buffer`) que históricamente no siempre estuvieron presentes son válidos; si dicho bit de bandera está claro, no se debe acceder a los campos de tipo que protege y se debe considerar que tienen un valor cero o `NULL`.

  Herencia:

  La herencia de este campo es complicada. La mayoría de los bits de bandera se heredan individualmente, es decir, si el tipo base tiene un conjunto de bits de bandera, el subtipo hereda este bit de bandera. Los bits de bandera que pertenecen a las estructuras de extensión se heredan estrictamente si la estructura de extensión se hereda, es decir, el valor del tipo base del bit de bandera se copia en el subtipo junto con un puntero a la estructura de extensión. El bit de bandera `Py_TPFLAGS_HAVE_GC` se hereda junto con `tp_traverse` y `tp_clear`, es decir, si el bit de bandera `Py_TPFLAGS_HAVE_GC` está claro en el subtipo y los campos `tp_traverse` y `tp_clear` en el subtipo existen y tienen valores `NULL`.

  Por defecto:

  `PyBaseObject_Type` usa `Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE`.

  Máscaras de bits:

  Las siguientes máscaras de bits están definidas actualmente; estos se pueden unidos por OR usando el operador `|` para formar el valor del campo `tp_flags`. El macro `PyType_HasFeature()` toma un tipo y un valor de banderas, tp y f, y comprueba si `tp->tp_flags & f` no es cero.

  `Py_TPFLAGS_HEAPTYPE`

    Este bit se establece cuando el objeto de tipo se asigna en el montón, por ejemplo, los tipos creados dinámicamente usando `PyType_FromSpec()`. En este caso, el campo `ob_type` de sus instancias se considera una referencia al tipo, y el objeto de tipo se llama INCREF cuando se crea una nueva instancia, y DECREF cuando se destruye una instancia (esto hace no se aplica a instancias de subtipos; solo el tipo al que hace referencia el ob_type de la instancia obtiene INCREF o DECREF).

    Herencia:

    ???

  `Py_TPFLAGS_BASETYPE`

    Este bit se establece cuando el tipo se puede usar como el tipo base de otro tipo. Si este bit es claro, el tipo no puede subtiparse (similar a una clase «final» en Java).

    Herencia:

    ???

  `Py_TPFLAGS_READY`

    Este bit se establece cuando el objeto tipo ha sido completamente inicializado por `PyType_Ready()`.

    Herencia:

    ???

  `Py_TPFLAGS_READYING`

    Este bit se establece mientras `PyType_Ready()` está en el proceso de inicialización del objeto tipo.

    Herencia:

    ???

  `Py_TPFLAGS_HAVE_GC`

    Este bit se establece cuando el objeto admite la recolección de elementos no utilizados. Si se establece este bit, las instancias deben crearse usando `PyObject_GC_New()` y destruirse usando `PyObject_GC_Del()`. Más información en la sección Apoyo a la recolección de basura cíclica. Este bit también implica que los campos relacionados con GC `tp_traverse` y `tp_clear` están presentes en el objeto de tipo.

    Herencia:

    Grupo: `Py_TPFLAGS_HAVE_GC`, `tp_traverse`, `tp_clear`

    El bit de indicador `Py_TPFLAGS_HAVE_GC` se hereda junto con los campos `tp_traverse` y `tp_clear`, es decir, si el bit de indicador `Py_TPFLAGS_HAVE_GC` está claro en el subtipo y los campos `tp_traverse` y `tp_clear` en el subtipo existen y tienen valores `NULL`.

  `Py_TPFLAGS_DEFAULT`

    Esta es una máscara de bits de todos los bits que pertenecen a la existencia de ciertos campos en el objeto tipo y sus estructuras de extensión. Actualmente, incluye los siguientes bits: `Py_TPFLAGS_HAVE_STACKLESS_EXTENSION`, `Py_TPFLAGS_HAVE_VERSION_TAG`.

    Herencia:

    ???

  `Py_TPFLAGS_METHOD_DESCRIPTOR`

    Este bit indica que los objetos se comportan como métodos independientes.

    Si este indicador está configurado para `type(meth)`, entonces:

    - `meth.__get__(obj, cls)(*args, **kwds)` (con `obj` no `None`) debe ser equivalente a `meth(obj, *args, **kwds)`.

    - `meth.__get__(None, cls)(*args, **kwds)` debe ser equivalente a `meth(*args, **kwds)`.

    Este indicador (flag) permite una optimización para llamadas a métodos típicos como `obj.meth()`: evita crear un objeto temporal de «método vinculado» para `obj.meth`.

    Nuevo en la versión 3.8.

    Herencia:

    Este indicador (flag) nunca es heredada por los tipos de montón. Para los tipos de extensión, se hereda siempre que `tp_descr_get` se hereda.

  `Py_TPFLAGS_LONG_SUBCLASS`
  `Py_TPFLAGS_LIST_SUBCLASS`
  `Py_TPFLAGS_TUPLE_SUBCLASS`
  `Py_TPFLAGS_BYTES_SUBCLASS`
  `Py_TPFLAGS_UNICODE_SUBCLASS`
  `Py_TPFLAGS_DICT_SUBCLASS`
  `Py_TPFLAGS_BASE_EXC_SUBCLASS`
  `Py_TPFLAGS_TYPE_SUBCLASS`

    Estas marcas son utilizadas por funciones como `PyLong_Check()` para determinar rápidamente si un tipo es una subclase de un tipo incorporado; dichos controles específicos son más rápidos que un control genérico, como `PyObject_IsInstance()`. Los tipos personalizados que heredan de los elementos integrados deben tener su `tp_flags` configurado correctamente, o el código que interactúa con dichos tipos se comportará de manera diferente dependiendo del tipo de verificación que se use.

  `Py_TPFLAGS_HAVE_FINALIZE`

    Este bit se establece cuando la ranura `tp_finalize` está presente en la estructura de tipo.

    Nuevo en la versión 3.4.

    Obsoleto desde la versión 3.8: Este indicador ya no es necesario, ya que el intérprete asume que: el espacio `tp_finalize` siempre está presente en la estructura de tipos.

  `_Py_TPFLAGS_HAVE_VECTORCALL`

    Este bit se establece cuando la clase implementa el protocolo vectorcall. Ver `tp_vectorcall_offset` para más detalles.

    Herencia:

    Este bit se establece en los subtipos static si `tp_flags` no se reemplaza: un subtipo hereda `_Py_TPFLAGS_HAVE_VECTORCALL` de su tipo base cuando el subtipo `tp_call` es `NULL` y el subtipo `Py_TPFLAGS_HEAPTYPE` no está establecido.

    «Tipos montículo» (Heap types) no heredan `_Py_TPFLAGS_HAVE_VECTORCALL`.

    Nota

    Este indicador (flag) es provisional y se espera que se haga pública en Python 3.9, con un nombre diferente y, posiblemente, una semántica cambiada. Si usa vectorcall, planifique actualizar su código para Python 3.9.

    Nuevo en la versión 3.8.

const char* `PyTypeObject.tp_doc`

  Un puntero opcional a una cadena de caracteres de C terminada en `NULL` que proporciona la cadena de documentación para este tipo de objeto. Esto se expone como el atributo `__doc__` en el tipo y las instancias del tipo.

  Herencia:

  Este campo es no heredado por los subtipos.

traverseproc `PyTypeObject.tp_traverse`

  Un puntero opcional a una función transversal para el recolector de basura. Esto solo se usa si se establece el bit de la bandera (flag) `Py_TPFLAGS_HAVE_GC`. La firma es:

      int tp_traverse(PyObject *self, visitproc visit, void *arg);

  Se puede encontrar más información sobre el esquema de recolección de basura de Python en la sección Apoyo a la recolección de basura cíclica.

  El puntero `tp_traverse` es utilizado por el recolector de basura para detectar ciclos de referencia. Una implementación típica de un `tp_traverse` simplemente llama a `Py_VISIT()` en cada uno de los miembros de la instancia que son objetos de Python que posee la instancia. Por ejemplo, esta es la función `local_traverse()` del módulo de extensión `_thread`:

      static int
      local_traverse(localobject *self, visitproc visit, void *arg)
      {
          Py_VISIT(self->args);
          Py_VISIT(self->kw);
          Py_VISIT(self->dict);
          return 0;
      }

  Tenga en cuenta que `Py_VISIT()` solo se llama a aquellos miembros que pueden participar en los ciclos de referencia. Aunque también hay un miembro `self->key`, solo puede ser `NULL` o una cadena de caracteres de Python y, por lo tanto, no puede ser parte de un ciclo de referencia.

  Por otro lado, incluso si sabe que un miembro nunca puede ser parte de un ciclo, como ayuda para la depuración puede visitarlo de todos modos solo para que la función `get_referents()` del módulo `gc` lo incluirá.

  Advertencia

  Al implementar `tp_traverse`, solo se deben visitar los miembros que posee la instancia (al tener fuertes referencias a ellos). Por ejemplo, si un objeto admite referencias débiles a través de la ranura `tp_weaklist`, el puntero que admite la lista vinculada (a lo que tp_weaklist señala) no debe ser visitado como la instancia no posee directamente las referencias débiles a sí mismo (la lista de referencias débiles está ahí para admitir la maquinaria de referencia débil, pero la instancia no tiene una referencia fuerte a los elementos dentro de ella, ya que se puede eliminar incluso si la instancia aún está viva).

  Tenga en cuenta que `Py_VISIT()` requiere los parámetros visit y arg para `local_traverse()` para tener estos nombres específicos; no les llames de ninguna manera.

  Herencia:

  Grupo: `Py_TPFLAGS_HAVE_GC`, `tp_traverse`, `tp_clear`

  Este campo es heredado por los subtipos junto con `tp_clear` y el `Py_TPFLAGS_HAVE_GC` bit de bandera: el bit de bandera, `tp_traverse`, y `tp_clear` se heredan todos del tipo base si todos son cero en el subtipo.

inquiry `PyTypeObject.tp_clear`

  Un puntero opcional a una función de limpieza (clear function) para el recolector de basura. Esto solo se usa si se establece el bit de bandera `Py_TPFLAGS_HAVE_GC`. La firma es:

      int tp_clear(PyObject *);

  La función miembro `tp_clear` se usa para romper los ciclos de referencia en la basura cíclica detectada por el recolector de basura. En conjunto, todas las funciones `tp_clear` en el sistema deben combinarse para romper todos los ciclos de referencia. Esto es sutil y, en caso de duda, proporcione una función `tp_clear`. Por ejemplo, el tipo de tupla no implementa una función `tp_clear`, porque es posible demostrar que ningún ciclo de referencia puede estar compuesto completamente de tuplas. Por lo tanto, las funciones `tp_clear` de otros tipos deben ser suficientes para romper cualquier ciclo que contenga una tupla. Esto no es inmediatamente obvio, y rara vez hay una buena razón para evitar la implementación de `tp_clear`.

  Las implementaciones de `tp_clear` deberían descartar las referencias de la instancia a las de sus miembros que pueden ser objetos de Python, y establecer sus punteros a esos miembros en `NULL`, como en el siguiente ejemplo:

      static int
      local_clear(localobject *self)
      {
          Py_CLEAR(self->key);
          Py_CLEAR(self->args);
          Py_CLEAR(self->kw);
          Py_CLEAR(self->dict);
          return 0;
      }

  Se debe utilizar el macro `Py_CLEAR()`, porque borrar las referencias es delicado: la referencia al objeto contenido no se debe disminuir hasta después de que el puntero al objeto contenido se establezca en `NULL`. Esto se debe a que la disminución del conteo de referencias puede hacer que el objeto contenido se convierta en basura, lo que desencadena una cadena de actividad de recuperación que puede incluir la invocación de código arbitrario de Python (debido a finalizadores o devoluciones de llamada de reflujo débil, asociadas con el objeto contenido). Si es posible que dicho código haga referencia a self nuevamente, es importante que el puntero al objeto contenido sea `NULL` en ese momento, de modo que self sepa que el objeto contenido ya no se puede usar. El macro `Py_CLEAR()` realiza las operaciones en un orden seguro.

  Debido a que el objetivo de `tp_clear` es romper los ciclos de referencia, no es necesario borrar objetos contenidos como cadenas de caracteres de Python o enteros de Python, que no pueden participar en los ciclos de referencia. Por otro lado, puede ser conveniente borrar todos los objetos Python contenidos y escribir la función `tp_dealloc` para invocar `tp_clear`.

  Se puede encontrar más información sobre el esquema de recolección de basura de Python en la sección Apoyo a la recolección de basura cíclica.

  Herencia:

  Grupo: `Py_TPFLAGS_HAVE_GC`, `tp_traverse`, `tp_clear`

  Este campo es heredado por subtipos junto con `tp_traverse` y el `Py_TPFLAGS_HAVE_GC` bit de bandera: el bit de bandera, `tp_traverse`, y `tp_clear` se heredan todos del tipo base si todos son cero en el subtipo.

richcmpfunc `PyTypeObject.tp_richcompare`

  Un puntero opcional a la función de comparación enriquecida, cuya firma es:

      PyObject *tp_richcompare(PyObject *self, PyObject *other, int op);

  Se garantiza que el primer parámetro será una instancia del tipo definido por `PyTypeObject`.

  La función debería retornar el resultado de la comparación (generalmente `Py_True` o `Py_False`). Si la comparación no está definida, debe retornar `Py_NotImplemented`, si se produce otro error, debe retornar `NULL` y establecer una condición de excepción.

  Las siguientes constantes se definen para ser utilizadas como el tercer argumento para `tp_richcompare` y para `PyObject_RichCompare()`:

  Constante | Comparación
  --- | ---
  `Py_LT` | `<`
  `Py_LE` | `<=`
  `Py_EQ` | `==`
  `Py_NE` | `!=`
  `Py_GT` | `>`
  `Py_GE` | `>=`

  El siguiente macro está definido para facilitar la escritura de funciones de comparación enriquecidas:

  `Py_RETURN_RICHCOMPARE`(VAL_A, VAL_B, op)

    Retorna `Py_True` o `Py_False` de la función, según el resultado de una comparación. `VAL_A` y `VAL_B` deben ser ordenados por operadores de comparación C (por ejemplo, pueden ser enteros o punto flotantes de C). El tercer argumento especifica la operación solicitada, como por ejemplo `PyObject_RichCompare()`.

    El conteo de referencia del valor de retorno se incrementa correctamente.

    En caso de error, establece una excepción y retorna `NULL` de la función.

    Nuevo en la versión 3.7.

  Herencia:

  Grupo: `tp_hash`, `tp_richcompare`

  Este campo es heredado por subtipos junto con `tp_hash`: un subtipo hereda `tp_richcompare` y `tp_hash` cuando el subtipo `tp_richcompare` y `tp_hash` son ambos `NULL`.

  Por defecto:

  `PyBaseObject_Type` proporciona una implementación `tp_richcompare`, que puede ser heredada. Sin embargo, si solo se define `tp_hash`, ni siquiera se utiliza la función heredada y las instancias del tipo no podrán participar en ninguna comparación.

Py_ssize_t `PyTypeObject.tp_weaklistoffset`

  If the instances of this type are weakly referenceable, this field is greater than zero and contains the offset in the instance structure of the weak reference list head (ignoring the GC header, if present); this offset is used by `PyObject_ClearWeakRefs()` and the `PyWeakref_*()` functions. The instance structure needs to include a field of type `PyObject*` which is initialized to `NULL`.

  No confunda este campo con `tp_weaklist`; ese es el encabezado de la lista para referencias débiles al objeto de tipo en sí.

  Herencia:

  Este campo es heredado por subtipos, pero consulte las reglas que se enumeran a continuación. Un subtipo puede anular este desplazamiento; Esto significa que el subtipo utiliza un encabezado de lista de referencia débil diferente que el tipo base. Dado que el encabezado de la lista siempre se encuentra a través de `tp_weaklistoffset`, esto no debería ser un problema.

  Cuando un tipo definido por una declaración de clase no tiene `__slots__` declaración, y ninguno de sus tipos base es débilmente referenciable, el tipo se hace débilmente referenciable al agregar una ranura de encabezado de lista de referencia débil al diseño de la instancia y configurando `tp_weaklistoffset` del desplazamiento de esa ranura.

  Cuando la declaración de un tipo `__slots__` contiene un espacio llamado `__weakref__`, ese espacio se convierte en el encabezado de la lista de referencia débil para las instancias del tipo, y el desplazamiento del espacio se almacena en el tipo `tp_weaklistoffset`.

  Cuando la declaración de un tipo `__slots__` no contiene un espacio llamado `__weakref__`, el tipo hereda su `tp_weaklistoffset` de su tipo base.

getiterfunc `PyTypeObject.tp_iter`

  Un puntero opcional a una función que retorna un iterador para el objeto. Su presencia normalmente indica que las instancias de este tipo son iterables (aunque las secuencias pueden ser iterables sin esta función).

  Esta función tiene la misma firma que `PyObject_GetIter()`:

      PyObject *tp_iter(PyObject *self);

  Herencia:

  Este campo es heredado por subtipos.

iternextfunc `PyTypeObject.tp_iternext`

  Un puntero opcional a una función que retorna el siguiente elemento en un iterador. La firma es:

      PyObject *tp_iternext(PyObject *self);

  Cuando el iterador está agotado, debe retornar `NULL`; a la excepción `StopIteration` puede o no establecerse. Cuando se produce otro error, también debe retornar `NULL`. Su presencia indica que las instancias de este tipo son iteradores.

  Los tipos de iterador también deberían definir la función `tp_iter`, y esa función debería retornar la instancia de iterador en sí (no una nueva instancia de iterador).

  Esta función tiene la misma firma que `PyIter_Next()`.

  Herencia:

  Este campo es heredado por subtipos.

struct PyMethodDef* `PyTypeObject.tp_methods`

  Un puntero opcional a un arreglo estático terminado en `NULL` de estructuras `PyMethodDef`, declarando métodos regulares de este tipo.

  Para cada entrada en el arreglo, se agrega una entrada al diccionario del tipo (ver `tp_dict` a continuación) que contiene un descriptor method.

  Herencia:

  Los subtipos no heredan este campo (los métodos se heredan mediante un mecanismo diferente).

struct PyMemberDef* `PyTypeObject.tp_members`

  Un puntero opcional a un arreglo estático terminado en `NULL` de estructuras `PyMemberDef`, declarando miembros de datos regulares (campos o ranuras) de instancias de este tipo.

  Para cada entrada en el arreglo, se agrega una entrada al diccionario del tipo (ver `tp_dict` a continuación) que contiene un descriptor member.

  Herencia:

  Los subtipos no heredan este campo (los miembros se heredan mediante un mecanismo diferente).

struct PyGetSetDef* `PyTypeObject.tp_getset`

  Un puntero opcional a un arreglo estático terminado en `NULL` de estructuras `PyGetSetDef`, declarando atributos calculados de instancias de este tipo.

  Para cada entrada en el arreglo, se agrega una entrada al diccionario del tipo (ver `tp_dict` a continuación) que contiene un descriptor getset.

  Herencia:

  Este campo no es heredado por los subtipos (los atributos computados se heredan a través de un mecanismo diferente).

PyTypeObject* `PyTypeObject.tp_base`

  Un puntero opcional a un tipo base del que se heredan las propiedades de tipo. En este nivel, solo se admite una herencia única; La herencia múltiple requiere la creación dinámica de un objeto tipo llamando al metatipo.

  Nota

  La inicialización de ranuras está sujeta a las reglas de inicialización de globales. C99 requiere que los inicializadores sean «constantes de dirección». Los designadores de funciones como `PyType_GenericNew()`, con conversión implícita a un puntero, son constantes de dirección C99 válidas.

  Sin embargo, el operador unario “&” aplicado a una variable no estática como `PyBaseObject_Type()` no es necesario para producir una dirección constante. Los compiladores pueden admitir esto (gcc lo hace), MSVC no. Ambos compiladores son estrictamente estándar conforme a este comportamiento particular.

  En consecuencia, `tp_base` debe establecerse en la función init del módulo de extensión.

  Herencia:

  Este campo no es heredado por los subtipos (obviamente).

  Por defecto:

  Este campo predeterminado es `&PyBaseObject_Type` (que para los programadores de Python se conoce como el tipo `objeto`).

PyObject* `PyTypeObject.tp_dict`

  El diccionario del tipo se almacena aquí por `PyType_Ready()`.

  Este campo normalmente debe inicializarse a `NULL` antes de llamar a `PyType_Ready`; también se puede inicializar en un diccionario que contiene atributos iniciales para el tipo. Una vez `PyType_Ready()` ha inicializado el tipo, los atributos adicionales para el tipo pueden agregarse a este diccionario solo si no corresponden a operaciones sobrecargadas (como `__add__()`).

  Herencia:

  Este campo no es heredado por los subtipos (aunque los atributos definidos aquí se heredan a través de un mecanismo diferente).

  Por defecto:

  Si este campo es `NULL`, `PyType_Ready()` le asignará un nuevo diccionario.

  Advertencia

  No es seguro usar `PyDict_SetItem()` en o modificar de otra manera a `tp_dict` con el diccionario C-API.

descrgetfunc `PyTypeObject.tp_descr_get`

  Un puntero opcional a una función «obtener descriptor» (descriptor ger).

  La firma de la función es:

      PyObject * tp_descr_get(PyObject *self, PyObject *obj, PyObject *type);

  Herencia:

  Este campo es heredado por subtipos.

descrsetfunc `PyTypeObject.tp_descr_set`

  Un puntero opcional a una función para configurar y eliminar el valor de un descriptor.

  La firma de la función es:

      int tp_descr_set(PyObject *self, PyObject *obj, PyObject *value);

  El argumento value se establece a `NULL` para borrar el valor.

  Herencia:

  Este campo es heredado por subtipos.

Py_ssize_t `PyTypeObject.tp_dictoffset`

  Si las instancias de este tipo tienen un diccionario que contiene variables de instancia, este campo no es cero y contiene el desplazamiento en las instancias del tipo del diccionario de variables de instancia; este desplazamiento es utilizado por `PyObject_GenericGetAttr()`.

  No confunda este campo con `tp_dict`; ese es el diccionario para los atributos del tipo de objeto en sí.

  Si el valor de este campo es mayor que cero, especifica el desplazamiento desde el inicio de la estructura de la instancia. Si el valor es menor que cero, especifica el desplazamiento desde el end de la estructura de la instancia. Un desplazamiento negativo es más costoso de usar y solo debe usarse cuando la estructura de la instancia contiene una parte de longitud variable. Esto se utiliza, por ejemplo, para agregar un diccionario de variables de instancia a los subtipos de `str` o `tuple`. Tenga en cuenta que el campo `tp_basicsize` debe tener en cuenta el diccionario agregado al final en ese caso, aunque el diccionario no esté incluido en el diseño básico del objeto. En un sistema con un tamaño de puntero de 4 bytes, `tp_dictoffset` debe establecerse en `-4` para indicar que el diccionario está al final de la estructura.

  El desplazamiento real del diccionario en una instancia se puede calcular a partir de un elemento negativo `tp_dictoffset` de la siguiente manera:

      dictoffset = tp_basicsize + abs(ob_size)*tp_itemsize + tp_dictoffset
      if dictoffset is not aligned on sizeof(void*):
          round up to sizeof(void*)

  donde `tp_basicsize`, `tp_itemsize` y `tp_dictoffset` se toman del objeto type, y `ob_size` está tomado de la instancia. Se toma el valor absoluto porque ints usa el signo de `ob_size` para almacenar el signo del número. (Nunca es necesario hacer este cálculo usted mismo; lo hace por usted la función `_PyObject_GetDictPtr()`.)

  Herencia:

  Este campo es heredado por subtipos, pero consulte las reglas que se enumeran a continuación. Un subtipo puede anular este desplazamiento; Esto significa que las instancias de subtipo almacenan el diccionario en un desplazamiento de diferencia que el tipo base. Dado que el diccionario siempre se encuentra a través de `tp_dictoffset`, esto no debería ser un problema.

  Cuando un tipo definido por una declaración de clase no tiene `__slots__` declaración, y ninguno de sus tipos base tiene un diccionario de variable de instancia, se agrega un espacio de diccionario al diseño de la instancia y el `tp_dictoffset` está configurado para el desplazamiento de esa ranura.

  Cuando un tipo definido por una declaración de clase tiene una declaración `__slots__`, el tipo hereda su `tp_dictoffset` de su tipo base.

  (Agrega un espacio llamado `__dict__` a la declaración `__slots__` no tiene el efecto esperado, solo causa confusión. Quizás esto debería agregarse como una característica como `__weakref__` aunque.)

  Por defecto:

  Esta ranura no tiene valor predeterminado. Para los tipos estáticos, si el campo es `NULL`, entonces no `__dict__` se crea para las instancias.

initproc `PyTypeObject.tp_init`

  Un puntero opcional a una función de inicialización de instancia.

  Esta función corresponde al método de clases `__init__()`. Como `__init__()`, es posible crear una instancia sin llamar a `__init__()`, y es posible reinicializar una instancia llamando de nuevo a su método `__init__()`.

  La firma de la función es:

      int tp_init(PyObject *self, PyObject *args, PyObject *kwds);

  El argumento propio es la instancia que se debe inicializar; los argumentos args y kwds representan argumentos posicionales y de palabras clave de la llamada a `__init__()`.

  La función `tp_init`, si no es `NULL`, se llama cuando una instancia se crea normalmente llamando a su tipo, después de la función `tp_new` del tipo ha retornado una instancia del tipo. Si la función `tp_new` retorna una instancia de otro tipo que no es un subtipo del tipo original, no se llama la función `tp_init`; if `tp_new` retorna una instancia de un subtipo del tipo original, se llama al subtipo `tp_init`.

  Retorna `0` en caso de éxito, `-1` y establece una excepción en caso de error.

  Herencia:

  Este campo es heredado por subtipos.

  Por defecto:

  Para los tipos estáticos, este campo no tiene un valor predeterminado.

allocfunc `PyTypeObject.tp_alloc`

  Un puntero opcional a una función de asignación de instancia.

  La firma de la función es:

      PyObject *tp_alloc(PyTypeObject *self, Py_ssize_t nitems);

  Herencia:

  Este campo es heredado por subtipos estáticos, pero no por subtipos dinámicos (subtipos creados por una declaración de clase).

  Por defecto:

  Para subtipos dinámicos, este campo siempre se establece en `PyType_GenericAlloc()`, para forzar una estrategia de asignación de montón estándar.

  Para subtipos estáticos, `PyBaseObject_Type` utiliza `PyType_GenericAlloc()`. Ese es el valor recomendado para todos los tipos definidos estáticamente.

newfunc `PyTypeObject.tp_new`

  Un puntero opcional a una función de creación de instancias.

  La firma de la función es:

      PyObject *tp_new(PyTypeObject *subtype, PyObject *args, PyObject *kwds);

  El argumento del subtipo es el tipo del objeto que se está creando; los argumentos args y kwds representan argumentos posicionales y de palabras clave de la llamada al tipo. Tenga en cuenta que el subtipo no tiene que ser igual al tipo cuya función `tp_new` se llama; puede ser un subtipo de ese tipo (pero no un tipo no relacionado).

  La función `tp_new` debería llamar a `subtype->tp_alloc(subtype, nitems)` para asignar espacio para el objeto, y luego hacer solo la inicialización adicional que sea absolutamente necesaria. La inicialización que se puede ignorar o repetir de forma segura debe colocarse en el controlador `tp_init`. Una buena regla general es que para los tipos inmutables, toda la inicialización debe tener lugar en `tp_new`, mientras que para los tipos mutables, la mayoría de las inicializaciones se deben diferir a `tp_init`.

  Herencia:

  Este campo es heredado por subtipos, excepto que no es heredado por tipos estáticos cuyo `tp_base` es `NULL` o `&PyBaseObject_Type`.

  Por defecto:

  Para los tipos estáticos, este campo no tiene valor predeterminado. Esto significa que si el espacio se define como `NULL`, no se puede llamar al tipo para crear nuevas instancias; presumiblemente hay otra forma de crear instancias, como una función de fábrica.

freefunc `PyTypeObject.tp_free`

  Un puntero opcional a una función de desasignación de instancia. Su firma es:

      void tp_free(void *self);

  Un inicializador que es compatible con esta firma es `PyObject_Free()`.

  Herencia:

  Este campo es heredado por subtipos estáticos, pero no por subtipos dinámicos (subtipos creados por una declaración de clase)

  Por defecto:

  En los subtipos dinámicos, este campo se establece en un desasignador adecuado para que coincida con `PyType_GenericAlloc()` y el valor del bit de bandera `Py_TPFLAGS_HAVE_GC`.

  Para subtipos estáticos, `PyBaseObject_Type` usa `PyObject_Del`.

inquiry `PyTypeObject.tp_is_gc`

  Un puntero opcional a una función llamada por el recolector de basura.

  El recolector de basura necesita saber si un objeto en particular es coleccionable o no. Normalmente, es suficiente mirar el el campo `tp_flags` del tipo objeto , y verificar el bit de bandera `Py_TPFLAGS_HAVE_GC`. Pero algunos tipos tienen una mezcla de instancias asignadas estáticamente y dinámicamente, y las instancias asignadas estáticamente no son coleccionables. Tales tipos deberían definir esta función; debería retornar `1` para una instancia coleccionable y `0` para una instancia no coleccionable. La firma es:

      int tp_is_gc(PyObject *self);

  (El único ejemplo de esto son los mismo tipos. El metatipo, `PyType_Type`, define esta función para distinguir entre tipos asignados estáticamente y dinámicamente.)

  Herencia:

  Este campo es heredado por subtipos.

  Por defecto:

  Esta ranura no tiene valor predeterminado. Si este campo es `NULL`, se utiliza `Py_TPFLAGS_HAVE_GC` como el equivalente funcional.

PyObject* `PyTypeObject.tp_bases`

  Tupla de tipos base.

  Esto se establece para los tipos creados por una declaración de clase. Debería ser `NULL` para los tipos estáticamente definidos.

  Herencia:

  Este campo no se hereda.

PyObject* `PyTypeObject.tp_mro`

  Tupla que contiene el conjunto expandido de tipos base, comenzando con el tipo en sí y terminando con `object`, en orden de resolución de método.

  Herencia:

  Este campo no se hereda; se calcula fresco por `PyType_Ready()`.

PyObject* `PyTypeObject.tp_cache`

  No usado. Solo para uso interno.

  Herencia:

  Este campo no se hereda.

PyObject* `PyTypeObject.tp_subclasses`

  Lista de referencias débiles a subclases. Solo para uso interno.

  Herencia:

  Este campo no se hereda.

PyObject* `PyTypeObject.tp_weaklist`

  Cabecera de lista de referencia débil, para referencias débiles a este tipo de objeto. No heredado Solo para uso interno.

  Herencia:

  Este campo no se hereda.

destructor `PyTypeObject.tp_del`

  Este campo está en desuso. Use `tp_finalize` en su lugar.

unsigned int `PyTypeObject.tp_version_tag`

  Se usa para indexar en el caché de métodos. Solo para uso interno.

  Herencia:

  Este campo no se hereda.

destructor `PyTypeObject.tp_finalize`

  Un puntero opcional a una función de finalización de instancia. Su firma es:

      void tp_finalize(PyObject *self);

  Si `tp_finalize` está configurado, el intérprete lo llama una vez cuando finaliza una instancia. Se llama desde el recolector de basura (si la instancia es parte de un ciclo de referencia aislado) o justo antes de que el objeto se desasigne. De cualquier manera, se garantiza que se invocará antes de intentar romper los ciclos de referencia, asegurando que encuentre el objeto en un estado sano.

  `tp_finalize` no debe mutar el estado de excepción actual; por lo tanto, una forma recomendada de escribir un finalizador no trivial es:

      static void
      local_finalize(PyObject *self)
      {
          PyObject *error_type, *error_value, *error_traceback;

          /* Save the current exception, if any. */
          PyErr_Fetch(&error_type, &error_value, &error_traceback);

          /* ... */

          /* Restore the saved exception. */
          PyErr_Restore(error_type, error_value, error_traceback);
      }

  Para que este campo se tenga en cuenta (incluso a través de la herencia), también debe establecer el bit de banderas `Py_TPFLAGS_HAVE_FINALIZE`.

  Herencia:

  Este campo es heredado por subtipos.

  Nuevo en la versión 3.4.

  Ver también

  «Finalización segura de objetos» (PEP 442)

Los campos restantes solo se definen si la macro de prueba de características `COUNT_ALLOCS` está definida, y son solo para uso interno. Se documentan aquí para completar. Ninguno de estos campos es heredado por subtipos.

Py_ssize_t `PyTypeObject.tp_allocs`

  Número de asignaciones.

Py_ssize_t `PyTypeObject.tp_frees`

  Número de liberaciones.

Py_ssize_t `PyTypeObject.tp_maxalloc`

  Máximo de objetos asignados simultáneamente.

PyTypeObject* `PyTypeObject.tp_prev`

  Puntero al objeto tipo anterior con un campo distinto de cero `tp_allocs`.

PyTypeObject* `PyTypeObject.tp_next`

  Puntero al siguiente objeto tipo con un campo distinto de cero `tp_allocs`.

Además, tenga en cuenta que, en un Python que ha recolectado basura, se puede llamar a `tp_dealloc` desde cualquier hilo de Python, no solo el hilo que creó el objeto (si el objeto se convierte en parte de un ciclo de conteo de referencias, ese ciclo puede ser recogido por una recolección de basura en cualquier hilo). Esto no es un problema para las llamadas a la API de Python, ya que el hilo en el que se llama `tp_dealloc` será el propietario del Bloqueo Global del Intérprete (GIL, por sus siglas en inglés Global Interpreter Lock). Sin embargo, si el objeto que se destruye a su vez destruye objetos de alguna otra biblioteca C o C++, se debe tener cuidado para garantizar que la destrucción de esos objetos en el hilo que se llama `tp_dealloc` no violará ningún supuesto de la biblioteca.

## Tipos Montículos (Heap Types)

Tradicionalmente, los tipos definidos en el código C son static, es decir, una estructura estática `PyTypeObject` se define directamente en el código y se inicializa usando `PyType_Ready()`.

Esto da como resultado tipos que están limitados en relación con los tipos definidos en Python:

- Los tipos estáticos están limitados a una base, es decir, no pueden usar herencia múltiple.

- Los objetos de tipo estático (pero no necesariamente sus instancias) son inmutables. No es posible agregar o modificar los atributos del objeto tipo desde Python.

- Los objetos de tipo estático se comparten en sub intérpretes, por lo que no deben incluir ningún estado específico del sub interpretador.

Además, dado que `PyTypeObject` no forma parte de stable ABI, cualquier módulo de extensión que use tipos estáticos debe compilarse para una versión menor específica de Python.

Una alternativa a los tipos estáticos es tipos asignados al montículo (heap-allocated types), o tipos montículo (heap types) para abreviar, que corresponden estrechamente a las clases creadas por la declaración `class` de Python.

Esto se hace completando una estructura `PyType_Spec` y llamando a `PyType_FromSpecWithBases()`.

# Estructuras de Objetos de Números

`PyNumberMethods`

  Esta estructura contiene punteros a las funciones que utiliza un objeto para implementar el protocolo numérico. Cada función es utilizada por la función de un nombre similar documentado en la sección Protocolo de números.

  Aquí está la definición de la estructura:

      typedef struct {
           binaryfunc nb_add;
           binaryfunc nb_subtract;
           binaryfunc nb_multiply;
           binaryfunc nb_remainder;
           binaryfunc nb_divmod;
           ternaryfunc nb_power;
           unaryfunc nb_negative;
           unaryfunc nb_positive;
           unaryfunc nb_absolute;
           inquiry nb_bool;
           unaryfunc nb_invert;
           binaryfunc nb_lshift;
           binaryfunc nb_rshift;
           binaryfunc nb_and;
           binaryfunc nb_xor;
           binaryfunc nb_or;
           unaryfunc nb_int;
           void *nb_reserved;
           unaryfunc nb_float;

           binaryfunc nb_inplace_add;
           binaryfunc nb_inplace_subtract;
           binaryfunc nb_inplace_multiply;
           binaryfunc nb_inplace_remainder;
           ternaryfunc nb_inplace_power;
           binaryfunc nb_inplace_lshift;
           binaryfunc nb_inplace_rshift;
           binaryfunc nb_inplace_and;
           binaryfunc nb_inplace_xor;
           binaryfunc nb_inplace_or;

           binaryfunc nb_floor_divide;
           binaryfunc nb_true_divide;
           binaryfunc nb_inplace_floor_divide;
           binaryfunc nb_inplace_true_divide;

           unaryfunc nb_index;

           binaryfunc nb_matrix_multiply;
           binaryfunc nb_inplace_matrix_multiply;
      } PyNumberMethods;

  Nota

  Las funciones binarias y ternarias deben verificar el tipo de todos sus operandos e implementar las conversiones necesarias (al menos uno de los operandos es una instancia del tipo definido). Si la operación no está definida para los operandos dados, las funciones binarias y ternarias deben retornar `Py_NotImplemented`, si se produce otro error, deben retornar `NULL` y establecer una excepción.

  Nota

  El campo `nb_reserved` siempre debe ser `NULL`. Anteriormente se llamaba `nb_long`, y se renombró en Python 3.0.1.

binaryfunc `PyNumberMethods.nb_add`

binaryfunc `PyNumberMethods.nb_subtract`

binaryfunc `PyNumberMethods.nb_multiply`

binaryfunc `PyNumberMethods.nb_remainder`

binaryfunc `PyNumberMethods.nb_divmod`

ternaryfunc `PyNumberMethods.nb_power`

unaryfunc `PyNumberMethods.nb_negative`

unaryfunc `PyNumberMethods.nb_positive`

unaryfunc `PyNumberMethods.nb_absolute`

inquiry `PyNumberMethods.nb_bool`

unaryfunc `PyNumberMethods.nb_invert`

binaryfunc `PyNumberMethods.nb_lshift`

binaryfunc `PyNumberMethods.nb_rshift`

binaryfunc `PyNumberMethods.nb_and`

binaryfunc `PyNumberMethods.nb_xor`

binaryfunc `PyNumberMethods.nb_or`

unaryfunc `PyNumberMethods.nb_int`

void *`PyNumberMethods.nb_reserved`

unaryfunc `PyNumberMethods.nb_float`

binaryfunc `PyNumberMethods.nb_inplace_add`

binaryfunc `PyNumberMethods.nb_inplace_subtract`

binaryfunc `PyNumberMethods.nb_inplace_multiply`

binaryfunc `PyNumberMethods.nb_inplace_remainder`

ternaryfunc `PyNumberMethods.nb_inplace_power`

binaryfunc `PyNumberMethods.nb_inplace_lshift`

binaryfunc `PyNumberMethods.nb_inplace_rshift`

binaryfunc `PyNumberMethods.nb_inplace_and`

binaryfunc `PyNumberMethods.nb_inplace_xor`

binaryfunc `PyNumberMethods.nb_inplace_or`

binaryfunc `PyNumberMethods.nb_floor_divide`

binaryfunc `PyNumberMethods.nb_true_divide`

binaryfunc `PyNumberMethods.nb_inplace_floor_divide`

binaryfunc `PyNumberMethods.nb_inplace_true_divide`

unaryfunc `PyNumberMethods.nb_index`

binaryfunc `PyNumberMethods.nb_matrix_multiply`

binaryfunc `PyNumberMethods.nb_inplace_matrix_multiply`

# Estructuras de Objetos Mapeo

`PyMappingMethods`

  Esta estructura contiene punteros a las funciones que utiliza un objeto para implementar el protocolo de mapeo. Tiene tres miembros:

lenfunc `PyMappingMethods.mp_length`

  Esta función es utilizada por `PyMapping_Size()` y `PyObject_Size()`, y tiene la misma firma. Esta ranura puede establecerse en `NULL` si el objeto no tiene una longitud definida.

binaryfunc `PyMappingMethods.mp_subscript`

  Esta función es utilizada por `PyObject_GetItem()` y `PySequence_GetSlice()`, y tiene la misma firma que `PyObject_GetItem()`. Este espacio debe llenarse para que la función `PyMapping_Check()` retorna `1`, de lo contrario puede ser `NULL`.

objobjargproc `PyMappingMethods.mp_ass_subscript`

  Esta función es utilizada por `PyObject_SetItem()`, `PyObject_DelItem()`, `PyObject_SetSlice()` y `PyObject_DelSlice()`. Tiene la misma firma que `PyObject_SetItem()`, pero v también se puede establecer en `NULL` para eliminar un elemento. Si este espacio es `NULL`, el objeto no admite la asignación y eliminación de elementos.

# Estructuras de objetos secuencia

`PySequenceMethods`

  Esta estructura contiene punteros a las funciones que utiliza un objeto para implementar el protocolo de secuencia.

lenfunc `PySequenceMethods.sq_length`

  Esta función es utilizada por `PySequence_Size()` y `PyObject_Size()`, y tiene la misma firma. También se usa para manejar índices negativos a través de los espacios `sq_item` y `sq_ass_item`.

binaryfunc `PySequenceMethods.sq_concat`

  Esta función es utilizada por `PySequence_Concat()` y tiene la misma firma. También es utilizado por el operador `+`, después de intentar la suma numérica a través de la ranura `nb_add`.

ssizeargfunc `PySequenceMethods.sq_repeat`

  Esta función es utilizada por `PySequence_Repeat()` y tiene la misma firma. También es utilizado por el operador `*`, después de intentar la multiplicación numérica a través de la ranura `nb_multiply`.

ssizeargfunc `PySequenceMethods.sq_item`

  Esta función es utilizada por `PySequence_GetItem()` y tiene la misma firma. También es utilizado por `PyObject_GetItem()`, después de intentar la suscripción a través de la ranura `mp_subscript`. Este espacio debe llenarse para que la función `PySequence_Check()` retorna `1`, de lo contrario puede ser `NULL`.

  Los índices negativos se manejan de la siguiente manera: si se llena el espacio `sq_length`, se llama y la longitud de la secuencia se usa para calcular un índice positivo que se pasa a `sq_item`. Si `sq_length` es `NULL`, el índice se pasa como es a la función.

ssizeobjargproc `PySequenceMethods.sq_ass_item`

  Esta función es utilizada por `PySequence_SetItem()` y tiene la misma firma. También lo usan `PyObject_SetItem()` y `PyObject_DelItem()`, después de intentar la asignación y eliminación del elemento a través de la ranura `mp_ass_subscript`. Este espacio puede dejarse en `NULL` si el objeto no admite la asignación y eliminación de elementos.

objobjproc `PySequenceMethods.sq_contains`

  Esta función puede ser utilizada por `PySequence_Contains()` y tiene la misma firma. Este espacio puede dejarse en `NULL`, en este caso `PySequence_Contains()` simplemente atraviesa la secuencia hasta que encuentra una coincidencia.

binaryfunc `PySequenceMethods.sq_inplace_concat`

  Esta función es utilizada por `PySequence_InPlaceConcat()` y tiene la misma firma. Debería modificar su primer operando y retornarlo. Este espacio puede dejarse en `NULL`, en este caso `PySequence_InPlaceConcat()` volverá a `PySequence_Concat()`. También es utilizado por la asignación aumentada `+=`, después de intentar la suma numérica en el lugar a través de la ranura `nb_inplace_add`.

ssizeargfunc `PySequenceMethods.sq_inplace_repeat`

  Esta función es utilizada por `PySequence_InPlaceRepeat()` y tiene la misma firma. Debería modificar su primer operando y retornarlo. Este espacio puede dejarse en `NULL`, en este caso `PySequence_InPlaceRepeat()` volverá a `PySequence_Repeat()`. También es utilizado por la asignación aumentada `*=`, después de intentar la multiplicación numérica en el lugar a través de la ranura `nb_inplace_multiply`.

# Estructuras de Objetos Búfer

`PyBufferProcs`

  Esta estructura contiene punteros a las funciones requeridas por Buffer protocol. El protocolo define cómo un objeto exportador puede exponer sus datos internos a objetos de consumo.

getbufferproc `PyBufferProcs.bf_getbuffer`

  La firma de esta función es:

      int (PyObject *exporter, Py_buffer *view, int flags);

  Maneja una solicitud a exporter para completar view según lo especificado por flags. Excepto por el punto (3), una implementación de esta función DEBE seguir estos pasos:

  1. Comprueba si se puede cumplir con la solicitud. Si no, lanza `PyExc_BufferError`, establece `view->obj` en `NULL` y retorna `-1`.

  2. Rellene los campos solicitados.

  3. Incrementa un contador interno para el número de exportaciones (exports).

  4. Establece `view->obj` en exporter e incremente `view->obj`.

  5. Retorna `0`.

  Si exporter es parte de una cadena o árbol de proveedores de búfer, se pueden usar dos esquemas principales:

  - Re-exportación: cada miembro del árbol actúa como el objeto exportador y establece `view->obj` en una nueva referencia a sí mismo.

  - Redirigir: la solicitud de búfer se redirige al objeto raíz del árbol. Aquí `view->obj` será una nueva referencia al objeto raíz.

  Los campos individuales de view se describen en la sección Estructura de búfer, las reglas sobre cómo debe reaccionar un exportador a solicitudes específicas se encuentran en la sección Tipos de solicitud de búfer.

  Toda la memoria señalada en la estructura `Py_buffer` pertenece al exportador y debe permanecer válida hasta que no queden consumidores. `format`, `shape`, `strides`, `suboffsets` y `internal` son de solo lectura para el consumidor.

  `PyBuffer_FillInfo()` proporciona una manera fácil de exponer un búfer de bytes simple mientras se trata correctamente con todos los tipos de solicitud.

  `PyObject_GetBuffer()` es la interfaz para el consumidor que envuelve esta función.

releasebufferproc `PyBufferProcs.bf_releasebuffer`

  La firma de esta función es:

      void (PyObject *exporter, Py_buffer *view);

  Maneja una solicitud para liberar los recursos del búfer. Si no es necesario liberar recursos, `PyBufferProcs.bf_releasebuffer` puede ser `NULL`. De lo contrario, una implementación estándar de esta función tomará estos pasos opcionales:

  1. Disminuir un contador interno para el número de exportaciones.

  2. Si el contador es `0`, libera toda la memoria asociada con view.

  El exportador DEBE utilizar el campo `internal` para realizar un seguimiento de los recursos específicos del búfer. Se garantiza que este campo permanecerá constante, mientras que un consumidor PUEDE pasar una copia del búfer original como argumento view.

  Esta función NO DEBE disminuir `view->obj`, ya que esto se hace automáticamente en `PyBuffer_Release()` (este esquema es útil para romper los ciclos de referencia).

  `PyBuffer_Release()` es la interfaz para el consumidor que envuelve esta función.

# Estructuras de objetos asíncronos

Nuevo en la versión 3.5.

`PyAsyncMethods`

  Esta estructura contiene punteros a las funciones requeridas para implementar objetos «esperable» (awaitable) y «iterador asincrónico» (asynchronous iterator).

  Aquí está la definición de la estructura:

      typedef struct {
          unaryfunc am_await;
          unaryfunc am_aiter;
          unaryfunc am_anext;
      } PyAsyncMethods;

unaryfunc `PyAsyncMethods.am_await`

  La firma de esta función es:

      PyObject *am_await(PyObject *self);

  El objeto retornado debe ser un iterador, es decir `PyIter_Check()` debe retornar `1` para ello.

  Este espacio puede establecerse en `NULL` si un objeto no es awaitable.

unaryfunc `PyAsyncMethods.am_aiter`

  La firma de esta función es:

      PyObject *am_aiter(PyObject *self);

  Debe retornar un objeto «esperable» (awaitable). Ver `__anext__()` para más detalles.

  Este espacio puede establecerse en `NULL` si un objeto no implementa el protocolo de iteración asincrónica.

unaryfunc `PyAsyncMethods.am_anext`

  La firma de esta función es:

      PyObject *am_anext(PyObject *self);

  Debe retornar un objeto «esperable» (awaitable). Ver `__anext__()` para más detalles. Esta ranura puede establecerse en `NULL`.

# Tipo Ranura typedefs

PyObject *`(*allocfunc)`(PyTypeObject *cls, Py_ssize_t nitems)

  El propósito de esta función es separar la asignación de memoria de la inicialización de memoria. Debería retornar un puntero a un bloque de memoria de longitud adecuada para la instancia, adecuadamente alineado e inicializado a ceros, pero con `ob_refcnt` establecido en `1` y `ob_type` establecido en argumento de tipo. Si el tipo `tp_itemsize` no es cero, el campo del objeto `ob_size` debe inicializarse en nitems y la longitud del bloque de memoria asignado debe ser `tp_basicsize + nitems*tp_itemsize`, redondeado a un múltiplo de `sizeof(void*)`; de lo contrario, nitems no se usa y la longitud del bloque debe ser `tp_basicsize`.

  Esta función no debe hacer ninguna otra instancia de inicialización, ni siquiera para asignar memoria adicional; eso debe ser realizado por `tp_new`.

void `(*destructor)`(PyObject *)

PyObject *`(*vectorcallfunc)`(PyObject *callable, PyObject *const *args, size_t nargsf, PyObject *kwnames)

  Consulte `tp_vectorcall_offset`.

  Los argumentos para `vectorcallfunc` son los mismos que para `_PyObject_Vectorcall()`.

  Nuevo en la versión 3.8.

void `(*freefunc)`(void *)

  Consulte `tp_free`.

PyObject *`(*newfunc)`(PyObject *, PyObject *, PyObject *)

  Consulte `tp_new`.

int `(*initproc)`(PyObject *, PyObject *, PyObject *)

  Consulte `tp_init`.

PyObject *`(*reprfunc)`(PyObject *)

  Consulte `tp_repr`.

PyObject *`(*getattrfunc)`(PyObject *self, char *attr)

  Retorna el valor del atributo nombrado para el objeto.

int `(*setattrfunc)`(PyObject *self, char *attr, PyObject *value)

  Establece el valor del atributo nombrado para el objeto. El argumento del valor se establece en `NULL` para eliminar el atributo.

PyObject *`(*getattrofunc)`(PyObject *self, PyObject *attr)

  Retorna el valor del atributo nombrado para el objeto.

  Consulte `tp_getattro`.

int `(*setattrofunc)`(PyObject *self, PyObject *attr, PyObject *value)

  Establece el valor del atributo nombrado para el objeto. El argumento del valor se establece en `NULL` para eliminar el atributo.

  Consulte `tp_setattro`.

PyObject *`(*descrgetfunc)`(PyObject *, PyObject *, PyObject *)

  Consulte `tp_descrget`.

int `(*descrsetfunc)`(PyObject *, PyObject *, PyObject *)

  Consulte `tp_descrset`.

Py_hash_t `(*hashfunc)`(PyObject *)

  Consulte `tp_hash`.

PyObject *`(*richcmpfunc)`(PyObject *, PyObject *, int)

  Consulte `tp_richcompare`.

PyObject *`(*getiterfunc)`(PyObject *)

  Consulte `tp_iter`.

PyObject *`(*iternextfunc)`(PyObject *)

  Consulte `tp_iternext`.

Py_ssize_t `(*lenfunc)`(PyObject *)

int `(*getbufferproc)`(PyObject *, Py_buffer *, int)

void `(*releasebufferproc)`(PyObject *, Py_buffer *)

PyObject *`(*unaryfunc)`(PyObject *)

PyObject *`(*binaryfunc)`(PyObject *, PyObject *)

PyObject *`(*ternaryfunc)`(PyObject *, PyObject *, PyObject *)

PyObject *`(*ssizeargfunc)`(PyObject *, Py_ssize_t)

int `(*ssizeobjargproc)`(PyObject *, Py_ssize_t)

int `(*objobjproc)`(PyObject *, PyObject *)

int `(*objobjargproc)`(PyObject *, PyObject *, PyObject *)

# Ejemplos

Los siguientes son ejemplos simples de definiciones de tipo Python. Incluyen el uso común que puede encontrar. Algunos demuestran casos difíciles de esquina (corner cases). Para obtener más ejemplos, información práctica y un tutorial, consulte «definiendo nuevos tipos» (Definición de tipos de extensión: Tutorial) y «tópicos de nuevos tipos (Definición de tipos de extensión: temas variados).

Un tipo estático básico:

    typedef struct {
        PyObject_HEAD
        const char *data;
    } MyObject;

    static PyTypeObject MyObject_Type = {
        PyVarObject_HEAD_INIT(NULL, 0)
        .tp_name = "mymod.MyObject",
        .tp_basicsize = sizeof(MyObject),
        .tp_doc = "My objects",
        .tp_new = myobj_new,
        .tp_dealloc = (destructor)myobj_dealloc,
        .tp_repr = (reprfunc)myobj_repr,
    };

También puede encontrar código más antiguo (especialmente en la base de código CPython) con un inicializador más detallado:

    static PyTypeObject MyObject_Type = {
        PyVarObject_HEAD_INIT(NULL, 0)
        "mymod.MyObject",               /* tp_name */
        sizeof(MyObject),               /* tp_basicsize */
        0,                              /* tp_itemsize */
        (destructor)myobj_dealloc,      /* tp_dealloc */
        0,                              /* tp_vectorcall_offset */
        0,                              /* tp_getattr */
        0,                              /* tp_setattr */
        0,                              /* tp_as_async */
        (reprfunc)myobj_repr,           /* tp_repr */
        0,                              /* tp_as_number */
        0,                              /* tp_as_sequence */
        0,                              /* tp_as_mapping */
        0,                              /* tp_hash */
        0,                              /* tp_call */
        0,                              /* tp_str */
        0,                              /* tp_getattro */
        0,                              /* tp_setattro */
        0,                              /* tp_as_buffer */
        0,                              /* tp_flags */
        "My objects",                   /* tp_doc */
        0,                              /* tp_traverse */
        0,                              /* tp_clear */
        0,                              /* tp_richcompare */
        0,                              /* tp_weaklistoffset */
        0,                              /* tp_iter */
        0,                              /* tp_iternext */
        0,                              /* tp_methods */
        0,                              /* tp_members */
        0,                              /* tp_getset */
        0,                              /* tp_base */
        0,                              /* tp_dict */
        0,                              /* tp_descr_get */
        0,                              /* tp_descr_set */
        0,                              /* tp_dictoffset */
        0,                              /* tp_init */
        0,                              /* tp_alloc */
        myobj_new,                      /* tp_new */
    };

Un tipo que admite referencias débiles, instancias de diccionarios (dicts) y hashing:

    typedef struct {
        PyObject_HEAD
        const char *data;
        PyObject *inst_dict;
        PyObject *weakreflist;
    } MyObject;

    static PyTypeObject MyObject_Type = {
        PyVarObject_HEAD_INIT(NULL, 0)
        .tp_name = "mymod.MyObject",
        .tp_basicsize = sizeof(MyObject),
        .tp_doc = "My objects",
        .tp_weaklistoffset = offsetof(MyObject, weakreflist),
        .tp_dictoffset = offsetof(MyObject, inst_dict),
        .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
        .tp_new = myobj_new,
        .tp_traverse = (traverseproc)myobj_traverse,
        .tp_clear = (inquiry)myobj_clear,
        .tp_alloc = PyType_GenericNew,
        .tp_dealloc = (destructor)myobj_dealloc,
        .tp_repr = (reprfunc)myobj_repr,
        .tp_hash = (hashfunc)myobj_hash,
        .tp_richcompare = PyBaseObject_Type.tp_richcompare,
    };

Una subclase de str que no se puede subclasificar (subclassed) y no se puede llamar para crear instancias (por ejemplo, utiliza una función de fábrica separada):

    typedef struct {
        PyUnicodeObject raw;
        char *extra;
    } MyStr;

    static PyTypeObject MyStr_Type = {
        PyVarObject_HEAD_INIT(NULL, 0)
        .tp_name = "mymod.MyStr",
        .tp_basicsize = sizeof(MyStr),
        .tp_base = NULL,  // set to &PyUnicode_Type in module init
        .tp_doc = "my custom str",
        .tp_flags = Py_TPFLAGS_DEFAULT,
        .tp_new = NULL,
        .tp_repr = (reprfunc)myobj_repr,
    };

El tipo estático más simple (con instancias de longitud fija):

    typedef struct {
        PyObject_HEAD
    } MyObject;

    static PyTypeObject MyObject_Type = {
        PyVarObject_HEAD_INIT(NULL, 0)
        .tp_name = "mymod.MyObject",
    };

El tipo estático más simple (con instancias de longitud variable):

    typedef struct {
        PyObject_VAR_HEAD
        const char *data[1];
    } MyObject;

    static PyTypeObject MyObject_Type = {
        PyVarObject_HEAD_INIT(NULL, 0)
        .tp_name = "mymod.MyObject",
        .tp_basicsize = sizeof(MyObject) - sizeof(char *),
        .tp_itemsize = sizeof(char *),
    };