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.

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.

PyObject

   Todos los tipos de objetos son extensiones de este tipo. Este es un
   tipo que contiene la información que Python necesita para tratar un
   puntero a un objeto como un objeto. En una construcción "*release*"
   normal, que contiene solo contador de referencia del objeto y un
   puntero al objeto de tipo correspondiente. En realidad nada es
   declarado como un "PyObject", pero cada puntero a un objeto de
   Python se puede convertir en una "PyObject*". El acceso a los
   miembros debe hacerse mediante el uso de las macros "Py_REFCNT" y
   "Py_TYPE".

PyVarObject

   Esta es una extensión de "PyObject" que se suma el campo "ob_size".
   Esto sólo se utiliza para objetos que tienen cierta noción de
   longitud (*length*). Este tipo no suele aparecer en la API
   Python/C. El acceso a los miembros debe hacerse mediante el uso de
   las macros "Py_REFCNT", "Py_TYPE", y "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.

Py_TYPE(o)

   Esta macro se utiliza para acceder al miembro "ob_type" de un
   objeto Python. Se expande a:

      (((PyObject*)(o))->ob_type)

Py_REFCNT(o)

   Esta macro se utiliza para acceder al miembro "ob_refcnt" de un
   objeto Python. Se expande a:

      (((PyObject*)(o))->ob_refcnt)

Py_SIZE(o)

   Esta macro se utiliza para acceder al miembro "ob_size" de un
   objeto Python. Se expande a:

      (((PyVarObject*)(o))->ob_size)

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)

   Esta es una macro que se expande para valores de inicialización
   para un nuevo tipo "PyVarObject", incluyendo el campo "ob_size".
   Esta macro se expande a:

      _PyObject_EXTRA_INIT
      1, type, size,

PyCFunction

   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.

PyCFunctionWithKeywords

   Tipo de las funciones que se utilizan para implementar invocables
   Python en C con la firma "METH_VARARGS | METH_KEYWORDS".

_PyCFunctionFast

   Tipo de las funciones que se utilizan para implementar invocables
   Python en C con la firma "METH_FASTCALL".

_PyCFunctionFastWithKeywords

   Tipo de las funciones que se utilizan para implementar invocables
   Python en C con la firma "METH_FASTCALL | METH_KEYWORDS".

PyMethodDef

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

   +--------------------+-----------------+---------------------------------+
   | Campo              | Tipo C          | Significado                     |
   |====================|=================|=================================|
   | "ml_name"          | const char *    | nombre del método               |
   +--------------------+-----------------+---------------------------------+
   | "ml_meth"          | PyCFunction     | puntero a la implementación en  |
   |                    |                 | C                               |
   +--------------------+-----------------+---------------------------------+
   | "ml_flags"         | int             | *flag* bits que indican cómo    |
   |                    |                 | debe ser construida la llamada  |
   +--------------------+-----------------+---------------------------------+
   | "ml_doc"           | const char *    | puntos a los contenidos del     |
   |                    |                 | 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.

El campo "ml_flags" es un campo de bits que puede incluir las
siguientes *flags*. Las *flags* individuales indican o bien una
convención de llamada o una convención vinculante.

Hay cuatro convenciones básicas de llamadas de argumentos posicionales
y dos de ellos se pueden combinar con "METH_KEYWORDS" para soportar
también argumentos de palabra clave (*keyword*). Así que hay un total
de 6 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_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).

   Esto no es parte de la API limitada.

   Nuevo en la versión 3.7.

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 or possibly
   "NULL" if there are no keywords.  The values of the keyword
   arguments are stored in the *args* array, after the positional
   arguments.

   Esto no es parte de la API limitada.

   Nuevo en la versión 3.7.

METH_NOARGS

   Métodos sin parámetros no tienen que comprobar si los argumentos se
   dan si están registrados con el *flag* "METH_NOARGS". Tienen que
   ser de tipo "PyCFunction". El primer parámetro normalmente se
   denomina *self* y llevará a cabo una referencia a la instancia
   módulo u objeto. En todos los casos el segundo parámetro será
   "NULL".

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

   El método se cargará en lugar de las definiciones existentes. Sin
   *METH_COEXIST*, el comportamiento predeterminado es saltarse las
   definiciones repetidas. Desde envolturas de ranura se cargan antes
   de la tabla de métodos, la existencia de una ranura *sq_contains*,
   por ejemplo, generaría un método envuelto llamado "__contains__()"
   e impediría la carga de una PyCFunction correspondiente con el
   mismo nombre. Con el *flag* definido, la PyCFunction se cargará en
   lugar del objeto envoltorio y coexistirá con la ranura. Esto es
   útil porque las llamadas a PyCFunctions se optimizan más que las
   llamadas a objetos envolvente.

PyMemberDef

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

PyGetSetDef

   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             | Función C para obtener el atributo  |
   +---------------+--------------------+-------------------------------------+
   | 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 *             | puntero de función opcional,        |
   | (*closure*)   |                    | proporcionar datos adicionales para |
   |               |                    | *getter* y *setter*                 |
   +---------------+--------------------+-------------------------------------+

   The "get" function takes one "PyObject*" parameter (the instance)
   and a function 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 function 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.
