Estructuras de objetos comunes
******************************

Hay un gran número de estructuras que se utilizan en la definición de
los tipos de objetos de Python. Esta sección describe estas
estructuras y la forma en que se utilizan.


Tipos objeto base y macros
==========================

En última instancia, todos los objetos de Python comparten un pequeño
número de campos en el comienzo de la representación del objeto en la
memoria. Estos están representados por la "PyObject" y
"PyVarObject",que se definen, a su vez, por las expansiones de algunos
macros también se utilizan, ya sea directa o indirectamente, en la
definición de todos otros objetos de Python.

type PyObject
    * Part of the Limited API. (Only some members are part of the
   stable ABI.)*

   All object types are extensions of this type.  This is a type which
   contains the information Python needs to treat a pointer to an
   object as an object.  In a normal "release" build, it contains only
   the object's reference count and a pointer to the corresponding
   type object. Nothing is actually declared to be a "PyObject", but
   every pointer to a Python object can be cast to a PyObject*.
   Access to the members must be done by using the macros "Py_REFCNT"
   and "Py_TYPE".

type PyVarObject
    * Part of the Limited API. (Only some members are part of the
   stable ABI.)*

   This is an extension of "PyObject" that adds the "ob_size" field.
   This is only used for objects that have some notion of *length*.
   This type does not often appear in the Python/C API. Access to the
   members must be done by using the macros "Py_REFCNT", "Py_TYPE",
   and "Py_SIZE".

PyObject_HEAD

   Esta es una macro utilizado cuando se declara nuevos tipos que
   representan objetos sin una longitud variable. La macro
   PyObject_HEAD se expande a:

      PyObject ob_base;

   Consulte la documentación de "PyObject" en secciones anteriores.

PyObject_VAR_HEAD

   Esta es una macro utilizado cuando se declara nuevos tipos que
   representan objetos con una longitud que varía de una instancia a
   otra instancia. La macro PyObject_VAR_HEAD se expande a:

      PyVarObject ob_base;

   Consulte la documentación de "PyVarObject" anteriormente.

int Py_Is(PyObject *x, PyObject *y)
    * Part of the Stable ABI since version 3.10.*

   Prueba si el objeto *x* es el objeto *y*, lo mismo que "x is y" en
   Python.

   Nuevo en la versión 3.10.

int Py_IsNone(PyObject *x)
    * Part of the Stable ABI since version 3.10.*

   Prueba si un objeto es la instancia única "None", lo mismo que "x
   is None" en Python.

   Nuevo en la versión 3.10.

int Py_IsTrue(PyObject *x)
    * Part of the Stable ABI since version 3.10.*

   Prueba si un objeto es la instancia única "True", lo mismo que "x
   is True" en Python.

   Nuevo en la versión 3.10.

int Py_IsFalse(PyObject *x)
    * Part of the Stable ABI since version 3.10.*

   Prueba si un objeto es la instancia única "False", lo mismo que "x
   is False" en Python.

   Nuevo en la versión 3.10.

PyTypeObject *Py_TYPE(PyObject *o)

   Obtiene el tipo de objeto Python *o*.

   Retorna una referencia prestada (*borrowed reference*).

   Use the "Py_SET_TYPE()" function to set an object type.

   Distinto en la versión 3.11: "Py_TYPE()" se cambia a una función
   estática inline. El tipo de parámetro ya no es const PyObject*.

int Py_IS_TYPE(PyObject *o, PyTypeObject *type)

   Retorna un valor distinto de cero si el objeto *o* tipo es *type*.
   Retorna cero en caso contrario. Equivalente a: "Py_TYPE(o) ==
   type".

   Nuevo en la versión 3.9.

void Py_SET_TYPE(PyObject *o, PyTypeObject *type)

   Establece el tipo del objeto *o* a *type*.

   Nuevo en la versión 3.9.

Py_ssize_t Py_REFCNT(PyObject *o)

   Obtiene la cuenta de referencias del objeto Python *o*.

   Use the "Py_SET_REFCNT()" function to set an object reference
   count.

   Distinto en la versión 3.11: El tipo de parámetro ya no es const
   PyObject*.

   Distinto en la versión 3.10: "Py_REFCNT()" se cambia a la función
   estática inline.

void Py_SET_REFCNT(PyObject *o, Py_ssize_t refcnt)

   Establece el conteo de referencia del objeto *o* a *refcnt*.

   Nuevo en la versión 3.9.

Py_ssize_t Py_SIZE(PyVarObject *o)

   Obtiene el tamaño del objeto Python *o*.

   Use the "Py_SET_SIZE()" function to set an object size.

   Distinto en la versión 3.11: "Py_SIZE()" se cambia a una función
   estática inline. El tipo de parámetro ya no es const PyVarObject*.

void Py_SET_SIZE(PyVarObject *o, Py_ssize_t size)

   Establece el tamaño del objeto *o* a *size*.

   Nuevo en la versión 3.9.

PyObject_HEAD_INIT(type)

   Esta es una macro que se expande para valores de inicialización
   para un nuevo tipo "PyObject". Esta macro expande:

      _PyObject_EXTRA_INIT
      1, type,

PyVarObject_HEAD_INIT(type, size)

   This is a macro which expands to initialization values for a new
   "PyVarObject" type, including the "ob_size" field. This macro
   expands to:

      _PyObject_EXTRA_INIT
      1, type, size,


Implementando funciones y métodos
=================================

type PyCFunction
    * Part of the Stable ABI.*

   Type of the functions used to implement most Python callables in C.
   Functions of this type take two PyObject* parameters and return one
   such value.  If the return value is "NULL", an exception shall have
   been set.  If not "NULL", the return value is interpreted as the
   return value of the function as exposed in Python.  The function
   must return a new reference.

   La firma de la función es:

      PyObject *PyCFunction(PyObject *self,
                            PyObject *args);

type PyCFunctionWithKeywords
    * Part of the Stable ABI.*

   Type of the functions used to implement Python callables in C with
   signature METH_VARARGS | METH_KEYWORDS. The function signature is:

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

type _PyCFunctionFast

   Type of the functions used to implement Python callables in C with
   signature "METH_FASTCALL". The function signature is:

      PyObject *_PyCFunctionFast(PyObject *self,
                                 PyObject *const *args,
                                 Py_ssize_t nargs);

type _PyCFunctionFastWithKeywords

   Type of the functions used to implement Python callables in C with
   signature METH_FASTCALL | METH_KEYWORDS. The function signature is:

      PyObject *_PyCFunctionFastWithKeywords(PyObject *self,
                                             PyObject *const *args,
                                             Py_ssize_t nargs,
                                             PyObject *kwnames);

type PyCMethod

   Type of the functions used to implement Python callables in C with
   signature METH_METHOD | METH_FASTCALL | METH_KEYWORDS. The function
   signature is:

      PyObject *PyCMethod(PyObject *self,
                          PyTypeObject *defining_class,
                          PyObject *const *args,
                          Py_ssize_t nargs,
                          PyObject *kwnames)

   Nuevo en la versión 3.9.

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

   Estructura utiliza para describir un método de un tipo de
   extensión. Esta estructura tiene cuatro campos:

   const char *ml_name

      Name of the method.

   PyCFunction ml_meth

      Pointer to the C implementation.

   int ml_flags

      Flags bits indicating how the call should be constructed.

   const char *ml_doc

      Points to the contents of the docstring.

The "ml_meth" is a C function pointer. The functions may be of
different types, but they always return PyObject*.  If the function is
not of the "PyCFunction", the compiler will require a cast in the
method table. Even though "PyCFunction" defines the first parameter as
PyObject*, it is common that the method implementation uses the
specific C type of the *self* object.

The "ml_flags" field is a bitfield which can include the following
flags. The individual flags indicate either a calling convention or a
binding convention.

Existen estas convenciones de llamada:

METH_VARARGS

   This is the typical calling convention, where the methods have the
   type "PyCFunction". The function expects two PyObject* values. The
   first one is the *self* object for methods; for module functions,
   it is the module object.  The second parameter (often called
   *args*) is a tuple object representing all arguments. This
   parameter is typically processed using "PyArg_ParseTuple()" or
   "PyArg_UnpackTuple()".

METH_KEYWORDS

   Can only be used in certain combinations with other flags:
   METH_VARARGS | METH_KEYWORDS, METH_FASTCALL | METH_KEYWORDS and
   METH_METHOD | METH_FASTCALL | METH_KEYWORDS.

METH_VARARGS | METH_KEYWORDS
   Los métodos con estas *flags* deben ser del tipo
   "PyCFunctionWithKeywords". La función espera tres parámetros:
   *self*, *args*, *kwargs* donde *kwargs* es un diccionario de todos
   los argumentos de palabras clave o, posiblemente, "NULL" si no hay
   argumentos de palabra clave. Los parámetros se procesan típicamente
   usando "PyArg_ParseTupleAndKeywords()".

METH_FASTCALL

   Fast calling convention supporting only positional arguments. The
   methods have the type "_PyCFunctionFast". The first parameter is
   *self*, the second parameter is a C array of PyObject* values
   indicating the arguments and the third parameter is the number of
   arguments (the length of the array).

   Nuevo en la versión 3.7.

   Distinto en la versión 3.10: "METH_FASTCALL" is now part of the
   stable ABI.

METH_FASTCALL | METH_KEYWORDS
   Extension of "METH_FASTCALL" supporting also keyword arguments,
   with methods of type "_PyCFunctionFastWithKeywords". Keyword
   arguments are passed the same way as in the vectorcall protocol:
   there is an additional fourth PyObject* parameter which is a tuple
   representing the names of the keyword arguments (which are
   guaranteed to be strings) or possibly "NULL" if there are no
   keywords.  The values of the keyword arguments are stored in the
   *args* array, after the positional arguments.

   Nuevo en la versión 3.7.

METH_METHOD

   Can only be used in the combination with other flags: METH_METHOD |
   METH_FASTCALL | METH_KEYWORDS.

METH_METHOD | METH_FASTCALL | METH_KEYWORDS
   Extension of METH_FASTCALL | METH_KEYWORDS supporting the *defining
   class*, that is, the class that contains the method in question.
   The defining class might be a superclass of "Py_TYPE(self)".

   El método debe ser de tipo "PyCMethod", lo mismo que para
   "METH_FASTCALL | METH_KEYWORDS" con el argumento "defining_clase"
   añadido después de "self".

   Nuevo en la versión 3.9.

METH_NOARGS

   Methods without parameters don't need to check whether arguments
   are given if they are listed with the "METH_NOARGS" flag.  They
   need to be of type "PyCFunction".  The first parameter is typically
   named *self* and will hold a reference to the module or object
   instance.  In all cases the second parameter will be "NULL".

   La función debe tener 2 parámetros. Dado que el segundo parámetro
   no se usa, "Py_UNUSED" se puede usar para evitar una advertencia
   del compilador.

METH_O

   Methods with a single object argument can be listed with the
   "METH_O" flag, instead of invoking "PyArg_ParseTuple()" with a
   ""O"" argument. They have the type "PyCFunction", with the *self*
   parameter, and a PyObject* parameter representing the single
   argument.

Estas dos constantes no se utilizan para indicar la convención de
llamada si no la vinculación cuando su usan con métodos de las clases.
Estos no se pueden usar para funciones definidas para módulos. A lo
sumo uno de estos *flags* puede establecerse en un método dado.

METH_CLASS

   Al método se le pasará el objeto tipo como primer parámetro, en
   lugar de una instancia del tipo. Esto se utiliza para crear métodos
   de clase (*class methods*), similar a lo que se crea cuando se
   utiliza la función "classmethod()" incorporada.

METH_STATIC

   El método pasará "NULL" como el primer parámetro en lugar de una
   instancia del tipo. Esto se utiliza para crear métodos estáticos
   (*static methods*), similar a lo que se crea cuando se utiliza la
   función "staticmethod()" incorporada.

En otros controles constantes dependiendo si se carga un método en su
lugar (*in place*) de otra definición con el mismo nombre del método.

METH_COEXIST

   The method will be loaded in place of existing definitions.
   Without *METH_COEXIST*, the default is to skip repeated
   definitions.  Since slot wrappers are loaded before the method
   table, the existence of a *sq_contains* slot, for example, would
   generate a wrapped method named "__contains__()" and preclude the
   loading of a corresponding PyCFunction with the same name.  With
   the flag defined, the PyCFunction will be loaded in place of the
   wrapper object and will co-exist with the slot.  This is helpful
   because calls to PyCFunctions are optimized more than wrapper
   object calls.

PyObject *PyCMethod_New(PyMethodDef *ml, PyObject *self, PyObject *module, PyTypeObject *cls)
    *Return value: New reference.** Part of the Stable ABI since
   version 3.9.*

   Turn *ml* into a Python *callable* object. The caller must ensure
   that *ml* outlives the *callable*. Typically, *ml* is defined as a
   static variable.

   The *self* parameter will be passed as the *self* argument to the C
   function in "ml->ml_meth" when invoked. *self* can be "NULL".

   The *callable* object's "__module__" attribute can be set from the
   given *module* argument. *module* should be a Python string, which
   will be used as name of the module the function is defined in. If
   unavailable, it can be set to "None" or "NULL".

   Ver también: "function.__module__"

   The *cls* parameter will be passed as the *defining_class* argument
   to the C function. Must be set if "METH_METHOD" is set on
   "ml->ml_flags".

   Nuevo en la versión 3.9.

PyObject *PyCFunction_NewEx(PyMethodDef *ml, PyObject *self, PyObject *module)
    *Return value: New reference.** Part of the Stable ABI.*

   Equivalent to "PyCMethod_New(ml, self, module, NULL)".

PyObject *PyCFunction_New(PyMethodDef *ml, PyObject *self)
    *Return value: New reference.** Part of the Stable ABI since
   version 3.4.*

   Equivalent to "PyCMethod_New(ml, self, NULL, NULL)".


Acceder a atributos de tipos de extensión
=========================================

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

   Estructura que describe un atributo de un tipo que corresponde a un
   miembro de la estructura de C. Sus campos son:

   +--------------------+-----------------+---------------------------------+
   | Campo              | Tipo C          | Significado                     |
   |====================|=================|=================================|
   | "name"             | const char *    | nombre del miembro              |
   +--------------------+-----------------+---------------------------------+
   | "type"             | int             | el tipo de miembro en la        |
   |                    |                 | estructura de C                 |
   +--------------------+-----------------+---------------------------------+
   | "offset"           | Py_ssize_t      | el desplazamiento en bytes que  |
   |                    |                 | el miembro se encuentra en la   |
   |                    |                 | estructura de objetos tipo      |
   +--------------------+-----------------+---------------------------------+
   | "flags"            | int             | *flags* bits que indican si el  |
   |                    |                 | campo debe ser de sólo lectura  |
   |                    |                 | o de escritura                  |
   +--------------------+-----------------+---------------------------------+
   | "doc"              | const char *    | puntos a los contenidos del     |
   |                    |                 | docstring                       |
   +--------------------+-----------------+---------------------------------+

   "type" puede ser uno de muchos macros "T_" correspondientes a
   diversos tipos C. Cuando se accede al miembro en Python, será
   convertida al tipo Python equivalente.

   +-----------------+--------------------+
   | Nombre de la    | Tipo C             |
   | macro           |                    |
   |=================|====================|
   | T_SHORT         | short              |
   +-----------------+--------------------+
   | T_INT           | int                |
   +-----------------+--------------------+
   | T_LONG          | long               |
   +-----------------+--------------------+
   | T_FLOAT         | float              |
   +-----------------+--------------------+
   | T_DOUBLE        | double             |
   +-----------------+--------------------+
   | T_STRING        | const char *       |
   +-----------------+--------------------+
   | T_OBJECT        | PyObject *         |
   +-----------------+--------------------+
   | T_OBJECT_EX     | PyObject *         |
   +-----------------+--------------------+
   | T_CHAR          | char               |
   +-----------------+--------------------+
   | T_BYTE          | char               |
   +-----------------+--------------------+
   | T_UBYTE         | unsigned char      |
   +-----------------+--------------------+
   | T_UINT          | unsigned int       |
   +-----------------+--------------------+
   | T_USHORT        | unsigned short     |
   +-----------------+--------------------+
   | T_ULONG         | unsigned long      |
   +-----------------+--------------------+
   | T_BOOL          | char               |
   +-----------------+--------------------+
   | T_LONGLONG      | long long          |
   +-----------------+--------------------+
   | T_ULONGLONG     | unsigned long long |
   +-----------------+--------------------+
   | T_PYSSIZET      | Py_ssize_t         |
   +-----------------+--------------------+

   "T_OBJECT" y "T_OBJECT_EX" se diferencian en que "T_OBJECT" retorna
   "None" si el miembro es "NULL" y "T_OBJECT_EX" lanza un
   "AttributeError". Trate de usar "T_OBJECT_EX" sobre "T_OBJECT"
   porque "T_OBJECT_EX" maneja el uso de la declaración "del" en ese
   atributo más correctamente que "T_OBJECT".

   "flags" puede ser "0" para el acceso de escritura y lectura o
   "READONLY" para el acceso de sólo lectura. El uso de "T_STRING"
   para "type" implica "READONLY". Los datos "T_STRING" se interpretan
   como UTF-8. Sólo se pueden eliminar "T_OBJECT" y miembros
   "T_OBJECT_EX". (Se establecen a "NULL").

   Los tipos asignados al heap (creados usando "PyType_FromSpec()" o
   similar), "PyMemberDef" pueden contener definiciones para los
   miembros especiales "__dictoffset__", "__weaklistoffset__" y
   "__vectorcalloffset__", correspondientes a "tp_dictoffset",
   "tp_weaklistoffset" y "tp_vectorcall_offset" en objetos de tipo.
   Estos deben definirse con "T_PYSSIZET" y "READONLY", por ejemplo:

      static PyMemberDef spam_type_members[] = {
          {"__dictoffset__", T_PYSSIZET, offsetof(Spam_object, dict), READONLY},
          {NULL}  /* Sentinel */
      };

PyObject *PyMember_GetOne(const char *obj_addr, struct PyMemberDef *m)

   Obtiene un atributo que pertenece al objeto en la dirección
   *obj_addr*. El atributo se describe por "PyMemberDef" *m*. Retorna
   "NULL" en caso de error.

int PyMember_SetOne(char *obj_addr, struct PyMemberDef *m, PyObject *o)

   Establece un atributo que pertenece al objeto en la dirección
   *obj_addr* al objeto *o*. El atributo a establecer se describe por
   "PyMemberDef" *m*. Retorna "0" si tiene éxito y un valor negativo
   si falla.

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

   Estructura para definir el acceso para un tipo como el de una
   propiedad. Véase también la descripción de la ranura
   "PyTypeObject.tp_getset".

   +---------------+--------------------+-------------------------------------+
   | Campo         | Tipo C             | Significado                         |
   |===============|====================|=====================================|
   | nombre        | const char *       | nombre del atributo                 |
   +---------------+--------------------+-------------------------------------+
   | get           | getter             | C function to get the attribute     |
   +---------------+--------------------+-------------------------------------+
   | set           | setter             | función opcional C para establecer  |
   |               |                    | o eliminar el atributo, si se omite |
   |               |                    | el atributo es de sólo lectura      |
   +---------------+--------------------+-------------------------------------+
   | doc           | const char *       | docstring opcional                  |
   +---------------+--------------------+-------------------------------------+
   | clausura      | void *             | optional user data pointer,         |
   | (*closure*)   |                    | providing additional data for       |
   |               |                    | getter and setter                   |
   +---------------+--------------------+-------------------------------------+

   The "get" function takes one PyObject* parameter (the instance) and
   a user data pointer (the associated "closure"):

      typedef PyObject *(*getter)(PyObject *, void *);

   Debe retornar una nueva referencia en caso de éxito o "NULL" con
   una excepción establecida en caso de error.

   "set" functions take two PyObject* parameters (the instance and the
   value to be set) and a user data pointer (the associated
   "closure"):

      typedef int (*setter)(PyObject *, PyObject *, void *);

   En caso de que el atributo deba suprimirse el segundo parámetro es
   "NULL". Debe retornar "0" en caso de éxito o "-1" con una excepción
   explícita en caso de fallo.
