Using the C API: Assorted topics
********************************

The tutorial walked you through creating a C API extension module, but
left many areas unexplained. This document looks at several concepts
that you'll need to learn in order to write more complex extensions.


Errors and Exceptions
=====================

Una convención importante en todo el intérprete de Python es la
siguiente: cuando una función falla, debe establecer una condición de
excepción y retornar un valor de error (generalmente "-1" o un puntero
"NULL"). La información de excepción se almacena en tres miembros del
estado del subproceso del intérprete. Estos son "NULL" si no hay
excepción. De lo contrario, son los equivalentes en C de los miembros
de la tupla Python retornada por "sys.exc_info()". Estos son el tipo
de excepción, la instancia de excepción y un objeto de rastreo. Es
importante conocerlos para comprender cómo se transmiten los errores.

La API de Python define una serie de funciones para establecer varios
tipos de excepciones.

El más común es "PyErr_SetString()". Sus argumentos son un objeto de
excepción y una cadena C. El objeto de excepción suele ser un objeto
predefinido como "PyExc_ZeroDivisionError". La cadena C indica la
causa del error y se convierte en un objeto de cadena Python y se
almacena como el "valor asociado" de la excepción.

Otra función útil es "PyErr_SetFromErrno()", que solo toma un
argumento de excepción y construye el valor asociado mediante la
inspección de la variable global "errno". La función más general es
"PyErr_SetObject()", que toma dos argumentos de objeto, la excepción y
su valor asociado. No necesita "Py_INCREF()" los objetos pasados a
cualquiera de estas funciones.

Puede probar de forma no destructiva si se ha establecido una
excepción con "PyErr_Occurred()". Esto retorna el objeto de excepción
actual o "NULL" si no se ha producido ninguna excepción. Normalmente
no necesita llamar a "PyErr_Occurred()" para ver si se produjo un
error en una llamada a la función, ya que debería poder distinguir el
valor de retorno.

Cuando una función *f* que llama a otra función *g* detecta que esta
última falla, *f* debería retornar un valor de error (normalmente
"NULL" o "-1"). Debería *no* llamar a una de las funciones "PyErr_*"
--- *g* ya ha llamado a una. Se supone que la persona que llama a *f*
también retornará una indicación de error a *su* persona que la llama,
nuevamente *sin* llama a "PyErr_*", y así sucesivamente --- la función
que lo detectó primero ya informó la causa más detallada del error.
Una vez que el error llega al bucle principal del intérprete de
Python, este aborta el código de Python que se está ejecutando
actualmente e intenta encontrar un controlador de excepciones
especificado por el programador de Python.

(Hay situaciones en las que un módulo puede dar un mensaje de error
más detallado llamando a otra función "PyErr_*", y en tales casos está
bien hacerlo. Sin embargo, como regla general, esto no es necesario y
puede causar que se pierda información sobre la causa del error: la
mayoría de las operaciones pueden fallar por una variedad de razones).

Para ignorar una excepción establecida por una llamada de función que
falló, la condición de excepción debe borrarse explícitamente llamando
a "PyErr_Clear()". La única vez que el código C debe llamar
"PyErr_Clear()" es si no quiere pasar el error al intérprete pero
quiere manejarlo completamente por sí mismo (posiblemente probando
algo más o pretendiendo que nada salió mal) )

Cada llamada fallida a "malloc()" debe convertirse en una excepción
--- la persona que llama directamente de "malloc()" (o "realloc()")
debe llamar "PyErr_NoMemory()" y retorna un indicador de falla en sí
mismo. Todas las funciones de creación de objetos (por ejemplo,
"PyLong_FromLong()") ya hacen esto, por lo que esta nota solo es
relevante para aquellos que llaman "malloc()" directamente.

También tenga en cuenta que, con la importante excepción de
"PyArg_ParseTuple()" y sus amigos, las funciones que retornan un
estado entero generalmente retornan un valor positivo o cero para el
éxito y "-1" para el fracaso, como las llamadas al sistema Unix.

Finalmente, tenga cuidado de limpiar la basura (haciendo
"Py_XDECREF()" o "Py_DECREF()" requiere objetos que ya ha creado)
cuando retorna un indicador de error!

The choice of which exception to raise is entirely yours.  There are
predeclared C objects corresponding to all built-in Python exceptions,
such as "PyExc_ZeroDivisionError", which you can use directly. Of
course, you should choose exceptions wisely --- don't use
"PyExc_TypeError" to mean that a file couldn't be opened (that should
probably be "PyExc_OSError"). If something's wrong with the argument
list, the "PyArg_ParseTuple()" function usually raises
"PyExc_TypeError".  If you have an argument whose value must be in a
particular range or must satisfy other conditions, "PyExc_ValueError"
is appropriate.

You can also define a new exception that is unique to your module. The
simplest way to do this is to declare a static global object variable
at the beginning of the file:

   static PyObject *SpamError = NULL;

and initialize it by calling "PyErr_NewException()" in the module's
"Py_mod_exec" function ("spam_module_exec()"):

   SpamError = PyErr_NewException("spam.error", NULL, NULL);

Since "SpamError" is a global variable, it will be overwritten every
time the module is reinitialized, when the "Py_mod_exec" function is
called.

For now, let's avoid the issue: we will block repeated initialization
by raising an "ImportError":

   static PyObject *SpamError = NULL;

   static int
   spam_module_exec(PyObject *m)
   {
       if (SpamError != NULL) {
           PyErr_SetString(PyExc_ImportError,
                           "cannot initialize spam module more than once");
           return -1;
       }
       SpamError = PyErr_NewException("spam.error", NULL, NULL);
       if (PyModule_AddObjectRef(m, "SpamError", SpamError) < 0) {
           return -1;
       }

       return 0;
   }

   static PyModuleDef_Slot spam_module_slots[] = {
       {Py_mod_exec, spam_module_exec},
       {0, NULL}
   };

   static struct PyModuleDef spam_module = {
       .m_base = PyModuleDef_HEAD_INIT,
       .m_name = "spam",
       .m_size = 0,  // non-negative
       .m_slots = spam_module_slots,
   };

   PyMODINIT_FUNC
   PyInit_spam(void)
   {
       return PyModuleDef_Init(&spam_module);
   }

Note that the Python name for the exception object is "spam.error".
The "PyErr_NewException()" function may create a class with the base
class being "Exception" (unless another class is passed in instead of
"NULL"), described in Excepciones incorporadas.

Note also that the "SpamError" variable retains a reference to the
newly created exception class; this is intentional!  Since the
exception could be removed from the module by external code, an owned
reference to the class is needed to ensure that it will not be
discarded, causing "SpamError" to become a dangling pointer. Should it
become a dangling pointer, C code which raises the exception could
cause a core dump or other unintended side effects.

For now, the "Py_DECREF()" call to remove this reference is missing.
Even when the Python interpreter shuts down, the global "SpamError"
variable will not be garbage-collected. It will "leak". We did,
however, ensure that this will happen at most once per process.

We discuss the use of "PyMODINIT_FUNC" as a function return type later
in this sample.

The "spam.error" exception can be raised in your extension module
using a call to "PyErr_SetString()" as shown below:

   static PyObject *
   spam_system(PyObject *self, PyObject *args)
   {
       const char *command;
       int sts;

       if (!PyArg_ParseTuple(args, "s", &command))
           return NULL;
       sts = system(command);
       if (sts < 0) {
           PyErr_SetString(SpamError, "System command failed");
           return NULL;
       }
       return PyLong_FromLong(sts);
   }


Embedding an extension
======================

If you want to make your module a permanent part of the Python
interpreter, you will have to change the configuration setup and
rebuild the interpreter.  On Unix, place your file ("spammodule.c" for
example) in the "Modules/" directory of an unpacked source
distribution, add a line to the file "Modules/Setup.local" describing
your file:

   spam spammodule.o

y reconstruya el intérprete ejecutando **make** en el directorio de
nivel superior. También puede ejecutar **make** en el subdirectorio
"Modules/", pero primero debe reconstruir "Makefile" ejecutando
'**make** Makefile'. (Esto es necesario cada vez que cambia el archivo
"Configuración").

Si su módulo requiere bibliotecas adicionales para vincular, también
se pueden enumerar en la línea del archivo de configuración, por
ejemplo:

   spam spammodule.o -lX11


Llamando funciones Python desde C
=================================

The tutorial concentrated on making C functions callable from Python.
The reverse is also useful: calling Python functions from C. This is
especially the case for libraries that support so-called "callback"
functions.  If a C interface makes use of callbacks, the equivalent
Python often needs to provide a callback mechanism to the Python
programmer; the implementation will require calling the Python
callback functions from a C callback.  Other uses are also imaginable.

Afortunadamente, el intérprete de Python se llama fácilmente de forma
recursiva, y hay una interfaz estándar para llamar a una función de
Python. (No me detendré en cómo llamar al analizador Python con una
cadena particular como entrada --- si está interesado, eche un vistazo
a la implementación de la opción de línea de comando "-c" en
"Modules/main.c" del código fuente de Python.)

Llamar a una función de Python es fácil. Primero, el programa Python
debe de alguna manera pasar el objeto de función Python. Debe
proporcionar una función (o alguna otra interfaz) para hacer esto.
Cuando se llama a esta función, guarde un puntero en el objeto de la
función Python (tenga cuidado de usar "Py_INCREF()") En una variable
global --- o donde mejor le parezca. Por ejemplo, la siguiente función
podría ser parte de una definición de módulo:

   static PyObject *my_callback = NULL;

   static PyObject *
   my_set_callback(PyObject *dummy, PyObject *args)
   {
       PyObject *result = NULL;
       PyObject *temp;

       if (PyArg_ParseTuple(args, "O:set_callback", &temp)) {
           if (!PyCallable_Check(temp)) {
               PyErr_SetString(PyExc_TypeError, "parameter must be callable");
               return NULL;
           }
           Py_XINCREF(temp);         /* Add a reference to new callback */
           Py_XDECREF(my_callback);  /* Dispose of previous callback */
           my_callback = temp;       /* Remember new callback */
           /* Boilerplate to return "None" */
           Py_INCREF(Py_None);
           result = Py_None;
       }
       return result;
   }

This function must be registered with the interpreter using the
"METH_VARARGS" flag in "PyMethodDef.ml_flags".  The
"PyArg_ParseTuple()" function and its arguments are documented in
section Extracción de parámetros en funciones de extensión.

Las macros "Py_XINCREF()" y "Py_XDECREF()" incrementan/disminuyen el
recuento de referencia de un objeto y son seguros en presencia de
punteros "NULL" (pero tenga en cuenta que *temp* no lo hará ser "NULL"
en este contexto). Más información sobre ellos en la sección Conteo de
referencias.

Más tarde, cuando es hora de llamar a la función, llama a la función C
"PyObject_CallObject()". Esta función tiene dos argumentos, ambos
punteros a objetos arbitrarios de Python: la función Python y la lista
de argumentos. La lista de argumentos siempre debe ser un objeto de
tupla, cuya longitud es el número de argumentos. Para llamar a la
función Python sin argumentos, pase "NULL" o una tupla vacía; para
llamarlo con un argumento, pasa una tupla singleton. "Py_BuildValue()"
retorna una tupla cuando su cadena de formato consta de cero o más
códigos de formato entre paréntesis. Por ejemplo:

   int arg;
   PyObject *arglist;
   PyObject *result;
   ...
   arg = 123;
   ...
   /* Time to call the callback */
   arglist = Py_BuildValue("(i)", arg);
   result = PyObject_CallObject(my_callback, arglist);
   Py_DECREF(arglist);

"PyObject_CallObject()" retorna un puntero de objeto Python: este es
el valor de retorno de la función Python. "PyObject_CallObject()" es
"recuento-referencia-neutral" con respecto a sus argumentos. En el
ejemplo, se creó una nueva tupla para servir como lista de argumentos,
a la cual se le llama "Py_DECREF()" inmediatamente después de la
llamada "PyObject_CallObject()".

El valor de retorno de "PyObject_CallObject()" es "nuevo": o bien es
un objeto nuevo o es un objeto existente cuyo recuento de referencias
se ha incrementado. Por lo tanto, a menos que desee guardarlo en una
variable global, debería de alguna manera "Py_DECREF()" el resultado,
incluso (¡especialmente!) Si no está interesado en su valor.

Sin embargo, antes de hacer esto, es importante verificar que el valor
de retorno no sea "NULL". Si es así, la función de Python terminó
generando una excepción. Si el código C que llamó
"PyObject_CallObject()" se llama desde Python, ahora debería retornar
una indicación de error a su llamador de Python, para que el
intérprete pueda imprimir un seguimiento de la pila, o el código de
Python que llama puede manejar la excepción. Si esto no es posible o
deseable, la excepción se debe eliminar llamando a "PyErr_Clear()".
Por ejemplo:

   if (result == NULL)
       return NULL; /* Pass error back */
   ...use result...
   Py_DECREF(result);

Dependiendo de la interfaz deseada para la función de retrollamada de
Python, es posible que también deba proporcionar una lista de
argumentos para "PyObject_CallObject()". En algunos casos, el programa
Python también proporciona la lista de argumentos, a través de la
misma interfaz que especificó la función de retrollamada. Luego se
puede guardar y usar de la misma manera que el objeto de función. En
otros casos, puede que tenga que construir una nueva tupla para
pasarla como lista de argumentos. La forma más sencilla de hacer esto
es llamar a "Py_BuildValue()". Por ejemplo, si desea pasar un código
de evento integral, puede usar el siguiente código:

   PyObject *arglist;
   ...
   arglist = Py_BuildValue("(l)", eventcode);
   result = PyObject_CallObject(my_callback, arglist);
   Py_DECREF(arglist);
   if (result == NULL)
       return NULL; /* Pass error back */
   /* Here maybe use the result */
   Py_DECREF(result);

¡Observe la ubicación de "Py_DECREF(arglist)" inmediatamente después
de la llamada, antes de la verificación de errores! También tenga en
cuenta que, estrictamente hablando, este código no está completo:
"Py_BuildValue()" puede quedarse sin memoria, y esto debe verificarse.

También puede llamar a una función con argumentos de palabras clave
utilizando "PyObject_Call()", que admite argumentos y argumentos de
palabras clave. Como en el ejemplo anterior, usamos "Py_BuildValue()"
para construir el diccionario.

   PyObject *dict;
   ...
   dict = Py_BuildValue("{s:i}", "name", val);
   result = PyObject_Call(my_callback, NULL, dict);
   Py_DECREF(dict);
   if (result == NULL)
       return NULL; /* Pass error back */
   /* Here maybe use the result */
   Py_DECREF(result);


Extracción de parámetros en funciones de extensión
==================================================

The tutorial uses a ""METH_O"" function, which is limited to a single
Python argument. If you want more, you can use "METH_VARARGS" instead.
With this flag, the C function will receive a "tuple" of arguments
instead of a single object.

For unpacking the tuple, CPython provides the "PyArg_ParseTuple()"
function, declared as follows:

   int PyArg_ParseTuple(PyObject *arg, const char *format, ...);

El argumento *arg* debe ser un objeto de tupla que contenga una lista
de argumentos pasada de Python a una función C. El argumento *format*
debe ser una cadena de formato, cuya sintaxis se explica en Analizando
argumentos y construyendo valores en el Manual de referencia de la API
de Python/C. Los argumentos restantes deben ser direcciones de
variables cuyo tipo está determinado por la cadena de formato.

For example, to receive a single Python "str" object and turn it into
a C buffer, you would use ""s"" as the format string:

   const char *command;
   if (!PyArg_ParseTuple(args, "s", &command)) {
       return NULL;
   }

If an error is detected in the argument list, "PyArg_ParseTuple()"
returns "NULL" (the error indicator for functions returning object
pointers); your function may return "NULL", relying on the exception
set by "PyArg_ParseTuple()".

Tenga en cuenta que si bien "PyArg_ParseTuple()" verifica que los
argumentos de Python tengan los tipos requeridos, no puede verificar
la validez de las direcciones de las variables C pasadas a la llamada:
si comete errores allí, su código probablemente se bloqueará o al
menos sobrescribir bits aleatorios en la memoria. ¡Así que ten
cuidado!

Tenga en cuenta que las referencias de objetos de Python que se
proporcionan a quien llama son referencias prestadas (*borrowed*); ¡no
disminuya su recuento de referencias!

Algunas llamadas de ejemplo:

   #include <Python.h>

   int ok;
   int i, j;
   long k, l;
   const char *s;
   Py_ssize_t size;

   ok = PyArg_ParseTuple(args, ""); /* No arguments */
       /* Python call: f() */

   ok = PyArg_ParseTuple(args, "s", &s); /* A string */
       /* Possible Python call: f('whoops!') */

   ok = PyArg_ParseTuple(args, "lls", &k, &l, &s); /* Two longs and a string */
       /* Possible Python call: f(1, 2, 'three') */

   ok = PyArg_ParseTuple(args, "(ii)s#", &i, &j, &s, &size);
       /* A pair of ints and a string, whose size is also returned */
       /* Possible Python call: f((1, 2), 'three') */

   {
       const char *file;
       const char *mode = "r";
       int bufsize = 0;
       ok = PyArg_ParseTuple(args, "s|si", &file, &mode, &bufsize);
       /* A string, and optionally another string and an integer */
       /* Possible Python calls:
          f('spam')
          f('spam', 'w')
          f('spam', 'wb', 100000) */
   }

   {
       int left, top, right, bottom, h, v;
       ok = PyArg_ParseTuple(args, "((ii)(ii))(ii)",
                &left, &top, &right, &bottom, &h, &v);
       /* A rectangle and a point */
       /* Possible Python call:
          f(((0, 0), (400, 300)), (10, 10)) */
   }

   {
       Py_complex c;
       ok = PyArg_ParseTuple(args, "D:myfunction", &c);
       /* a complex, also providing a function name for errors */
       /* Possible Python call: myfunction(1+2j) */
   }


Parámetros de palabras clave para funciones de extensión
========================================================

If you also want your function to accept *keyword arguments*, use the
"METH_KEYWORDS" flag in combination with "METH_VARARGS".
("METH_KEYWORDS" can also be used with other flags; see its
documentation for the allowed combinations.)

In this case, the C function should accept a third "PyObject *"
parameter which will be a dictionary of keywords. Use
"PyArg_ParseTupleAndKeywords()" to parse the arguments to such a
function.

La función "PyArg_ParseTupleAndKeywords()" se declara de la siguiente
manera:

   int PyArg_ParseTupleAndKeywords(PyObject *arg, PyObject *kwdict,
                                   const char *format, char * const *kwlist, ...);

Los parámetros *arg* y *format* son idénticos a los de la función
"PyArg_ParseTuple()". El parámetro *kwdict* es el diccionario de
palabras clave recibidas como tercer parámetro del tiempo de ejecución
de Python. El parámetro *kwlist* es una lista de cadenas terminadas en
"NULL" que identifican los parámetros; los nombres se corresponden con
la información de tipo de *format* de izquierda a derecha. En caso de
éxito, "PyArg_ParseTupleAndKeywords()" retorna verdadero; de lo
contrario, retorna falso y genera una excepción apropiada.

Nota:

  ¡Las tuplas anidadas no se pueden analizar al usar argumentos de
  palabras clave! Los parámetros de palabras clave pasados que no
  están presentes en la *kwlist* provocarán que se genere "TypeError".

Aquí hay un módulo de ejemplo que usa palabras clave, basado en un
ejemplo de *Geoff Philbrick (philbrick@hks.com)*:

   #define PY_SSIZE_T_CLEAN
   #include <Python.h>

   static PyObject *
   keywdarg_parrot(PyObject *self, PyObject *args, PyObject *keywds)
   {
       int voltage;
       const char *state = "a stiff";
       const char *action = "voom";
       const char *type = "Norwegian Blue";

       static char *kwlist[] = {"voltage", "state", "action", "type", NULL};

       if (!PyArg_ParseTupleAndKeywords(args, keywds, "i|sss", kwlist,
                                        &voltage, &state, &action, &type))
           return NULL;

       printf("-- This parrot wouldn't %s if you put %i Volts through it.\n",
              action, voltage);
       printf("-- Lovely plumage, the %s -- It's %s!\n", type, state);

       Py_RETURN_NONE;
   }

   static PyMethodDef keywdarg_methods[] = {
       /* The cast of the function is necessary since PyCFunction values
        * only take two PyObject* parameters, and keywdarg_parrot() takes
        * three.
        */
       {"parrot", (PyCFunction)(void(*)(void))keywdarg_parrot, METH_VARARGS | METH_KEYWORDS,
        "Print a lovely skit to standard output."},
       {NULL, NULL, 0, NULL}   /* sentinel */
   };


Construyendo valores arbitrarios
================================

Esta función es la contraparte de "PyArg_ParseTuple()". Se declara de
la siguiente manera:

   PyObject *Py_BuildValue(const char *format, ...);

Reconoce un conjunto de unidades de formato similares a las
reconocidas por "PyArg_ParseTuple()", pero los argumentos (que son de
entrada a la función, no de salida) no deben ser punteros, solo
valores. Retorna un nuevo objeto Python, adecuado para regresar de una
función C llamada desde Python.

Una diferencia con "PyArg_ParseTuple()": mientras que este último
requiere que su primer argumento sea una tupla (ya que las listas de
argumentos de Python siempre se representan como tuplas internamente),
"Py_BuildValue()" no siempre construye una tupla . Construye una tupla
solo si su cadena de formato contiene dos o más unidades de formato.
Si la cadena de formato está vacía, retorna "None"; si contiene
exactamente una unidad de formato, retorna el objeto que describa esa
unidad de formato. Para forzarlo a retornar una tupla de tamaño 0 o
uno, agregar paréntesis a la cadena de formato.

Ejemplos (a la izquierda la llamada, a la derecha el valor de Python
resultante):

   Py_BuildValue("")                        None
   Py_BuildValue("i", 123)                  123
   Py_BuildValue("iii", 123, 456, 789)      (123, 456, 789)
   Py_BuildValue("s", "hello")              'hello'
   Py_BuildValue("y", "hello")              b'hello'
   Py_BuildValue("ss", "hello", "world")    ('hello', 'world')
   Py_BuildValue("s#", "hello", 4)          'hell'
   Py_BuildValue("y#", "hello", 4)          b'hell'
   Py_BuildValue("()")                      ()
   Py_BuildValue("(i)", 123)                (123,)
   Py_BuildValue("(ii)", 123, 456)          (123, 456)
   Py_BuildValue("(i,i)", 123, 456)         (123, 456)
   Py_BuildValue("[i,i]", 123, 456)         [123, 456]
   Py_BuildValue("{s:i,s:i}",
                 "abc", 123, "def", 456)    {'abc': 123, 'def': 456}
   Py_BuildValue("((ii)(ii)) (ii)",
                 1, 2, 3, 4, 5, 6)          (((1, 2), (3, 4)), (5, 6))


Conteo de referencias
=====================

En lenguajes como C o C++, el programador es responsable de la
asignación dinámica y la desasignación de memoria en el montón. En C,
esto se hace usando las funciones "malloc()" y "free()". En C++, los
operadores "new" y "delete" se usan esencialmente con el mismo
significado y restringiremos la siguiente discusión al caso C.

Every block of memory allocated with "malloc()" should eventually be
returned to the pool of available memory by exactly one call to
"free()". It is important to call "free()" at the right time.  If a
block's address is forgotten but "free()" is not called for it, the
memory it occupies cannot be reused until the program terminates.
This is called a *memory leak*.  On the other hand, if a program calls
"free()" for a block and then continues to use the block, it creates a
conflict with reuse of the block through another "malloc()" call.
This is called *using freed memory*. It has the same bad consequences
as referencing uninitialized data --- core dumps, wrong results,
mysterious crashes.

Las causas comunes de pérdidas de memoria son rutas inusuales a través
del código. Por ejemplo, una función puede asignar un bloque de
memoria, hacer algunos cálculos y luego liberar el bloque nuevamente.
Ahora, un cambio en los requisitos de la función puede agregar una
prueba al cálculo que detecta una condición de error y puede regresar
prematuramente de la función. Es fácil olvidar liberar el bloque de
memoria asignado al tomar esta salida prematura, especialmente cuando
se agrega más tarde al código. Tales filtraciones, una vez
introducidas, a menudo pasan desapercibidas durante mucho tiempo: la
salida del error se toma solo en una pequeña fracción de todas las
llamadas, y la mayoría de las máquinas modernas tienen mucha memoria
virtual, por lo que la filtración solo se hace evidente en un proceso
de larga ejecución que usa la función de fugas con frecuencia. Por lo
tanto, es importante evitar que se produzcan fugas mediante una
convención o estrategia de codificación que minimice este tipo de
errores.

Dado que Python hace un uso intensivo de "malloc()" y "free()",
necesita una estrategia para evitar pérdidas de memoria, así como el
uso de memoria liberada. El método elegido se llama *recuento de
referencias*. El principio es simple: cada objeto contiene un
contador, que se incrementa cuando se almacena una referencia al
objeto en algún lugar, y que se reduce cuando se elimina una
referencia al mismo. Cuando el contador llega a cero, la última
referencia al objeto se ha eliminado y el objeto se libera.

Una estrategia alternativa se llama *recolección automática de
basura*. (A veces, el recuento de referencias también se conoce como
una estrategia de recolección de basura, de ahí mi uso de "automático"
para distinguir los dos). La gran ventaja de la recolección automática
de basura es que el usuario no necesita llamar a "free()"
explícitamente. (Otra ventaja afirmada es una mejora en la velocidad o
el uso de la memoria; sin embargo, esto no es un hecho difícil). La
desventaja es que para C, no hay un recolector de basura automático
verdaderamente portátil, mientras que el conteo de referencias se
puede implementar de forma portátil (siempre que las funciones
"malloc()" y "free()" están disponibles --- que garantiza el estándar
C). Tal vez algún día un recolector de basura automático lo
suficientemente portátil estará disponible para C. Hasta entonces,
tendremos que vivir con recuentos de referencia.

Si bien Python utiliza la implementación tradicional de conteo de
referencias, también ofrece un detector de ciclos que funciona para
detectar ciclos de referencia. Esto permite que las aplicaciones no se
preocupen por crear referencias circulares directas o indirectas;
Estas son las debilidades de la recolección de basura implementada
utilizando solo el conteo de referencias. Los ciclos de referencia
consisten en objetos que contienen referencias (posiblemente
indirectas) a sí mismos, de modo que cada objeto en el ciclo tiene un
recuento de referencias que no es cero. Las implementaciones típicas
de recuento de referencias no pueden recuperar la memoria que
pertenece a algún objeto en un ciclo de referencia, o referenciada a
partir de los objetos en el ciclo, a pesar de que no hay más
referencias al ciclo en sí.

El detector de ciclos es capaz de detectar ciclos basura y puede
recuperarlos. El módulo "gc" expone una forma de ejecutar el detector
(la función "collect()"), así como interfaces de configuración y la
posibilidad de desactivar el detector en tiempo de ejecución.


Conteo de referencias en Python
-------------------------------

Hay dos macros, "Py_INCREF(x)" y "Py_DECREF(x)", que manejan el
incremento y la disminución del recuento de referencias. "Py_DECREF()"
también libera el objeto cuando el recuento llega a cero. Por
flexibilidad, no llama a "free()" directamente --- más bien, realiza
una llamada a través de un puntero de función en el objeto *type
object*. Para este propósito (y otros), cada objeto también contiene
un puntero a su objeto de tipo.

La gran pregunta ahora permanece: ¿cuándo usar "Py_INCREF(x)" y
"Py_DECREF(x)"? Primero introduzcamos algunos términos. Nadie "posee"
un objeto; sin embargo, puede *poseer una referencia* a un objeto. El
recuento de referencias de un objeto ahora se define como el número de
referencias que posee. El propietario de una referencia es responsable
de llamar a "Py_DECREF()" cuando la referencia ya no es necesaria. La
propiedad de una referencia puede ser transferida. Hay tres formas de
deshacerse de una referencia de propiedad: pasarla, almacenarla o
llamar a "Py_DECREF()". Olvidar deshacerse de una referencia de
propiedad crea una pérdida de memoria.

It is also possible to *borrow* [1] a reference to an object.  The
borrower of a reference should not call "Py_DECREF()".  The borrower
must not hold on to the object longer than the owner from which it was
borrowed. Using a borrowed reference after the owner has disposed of
it risks using freed memory and should be avoided completely [2].

La ventaja de pedir prestado sobre tener una referencia es que no
necesita ocuparse de disponer de la referencia en todas las rutas
posibles a través del código --- en otras palabras, con una referencia
prestada no corre el riesgo de fugas cuando se toma una salida
prematura. La desventaja de pedir prestado sobre la posesión es que
hay algunas situaciones sutiles en las que, en un código aparentemente
correcto, una referencia prestada se puede usar después de que el
propietario del que se tomó prestado la haya eliminado.

Una referencia prestada se puede cambiar en una referencia de
propiedad llamando a "Py_INCREF()". Esto no afecta el estado del
propietario del cual se tomó prestada la referencia: crea una nueva
referencia de propiedad y otorga responsabilidades completas al
propietario (el nuevo propietario debe disponer de la referencia
correctamente, así como el propietario anterior).


Reglas de propiedad
-------------------

Cuando una referencia de objeto se pasa dentro o fuera de una función,
es parte de la especificación de la interfaz de la función si la
propiedad se transfiere con la referencia o no.

La mayoría de las funciones que retornan una referencia a un objeto
pasan de propiedad con la referencia. En particular, todas las
funciones cuya función es crear un nuevo objeto, como
"PyLong_FromLong()" y "Py_BuildValue()", pasan la propiedad al
receptor. Incluso si el objeto no es realmente nuevo, aún recibirá la
propiedad de una nueva referencia a ese objeto. Por ejemplo,
"PyLong_FromLong()" mantiene un caché de valores populares y puede
retornar una referencia a un elemento en caché.

Muchas funciones que extraen objetos de otros objetos también
transfieren la propiedad con la referencia, por ejemplo
"PyObject_GetAttrString()". Sin embargo, la imagen es menos clara
aquí, ya que algunas rutinas comunes son excepciones:
"PyTuple_GetItem()", "PyList_GetItem()", "PyDict_GetItem()", y
"PyDict_GetItemString()" todas las referencias retornadas que tomaste
prestadas de la tupla, lista o diccionario.

La función "PyImport_AddModule()" también retorna una referencia
prestada, aunque en realidad puede crear el objeto que retorna: esto
es posible porque una referencia de propiedad del objeto se almacena
en "sys.modules".

Cuando pasa una referencia de objeto a otra función, en general, la
función toma prestada la referencia de usted --- si necesita
almacenarla, usará "Py_INCREF()" para convertirse en un propietario
independiente. Hay exactamente dos excepciones importantes a esta
regla: "PyTuple_SetItem()" y "PyList_SetItem()". Estas funciones se
hacen cargo de la propiedad del artículo que se les pasa, ¡incluso si
fallan! (Tenga en cuenta que "PyDict_SetItem()" y sus amigos no se
hacen cargo de la propiedad --- son "normales")

Cuando se llama a una función C desde Python, toma de la persona que
llama referencias a sus argumentos. Quien llama posee una referencia
al objeto, por lo que la vida útil de la referencia prestada está
garantizada hasta que la función regrese. Solo cuando dicha referencia
prestada debe almacenarse o transmitirse, debe convertirse en una
referencia propia llamando a "Py_INCREF()".

La referencia de objeto retornada desde una función C que se llama
desde Python debe ser una referencia de propiedad: la propiedad se
transfiere de la función a su llamador.


Hielo delgado
-------------

Hay algunas situaciones en las que el uso aparentemente inofensivo de
una referencia prestada puede generar problemas. Todo esto tiene que
ver con invocaciones implícitas del intérprete, lo que puede hacer que
el propietario de una referencia se deshaga de él.

El primer y más importante caso que debe conocer es el uso de
"Py_DECREF()" en un objeto no relacionado mientras toma prestada una
referencia a un elemento de la lista. Por ejemplo:

   void
   bug(PyObject *list)
   {
       PyObject *item = PyList_GetItem(list, 0);

       PyList_SetItem(list, 1, PyLong_FromLong(0L));
       PyObject_Print(item, stdout, 0); /* BUG! */
   }

Esta función primero toma prestada una referencia a "list[0]", luego
reemplaza "list[1]" con el valor "0", y finalmente imprime la
referencia prestada. Parece inofensivo, ¿verdad? ¡Pero no lo es!

Let's follow the control flow into "PyList_SetItem()".  The list owns
references to all its items, so when item 1 is replaced, it has to
dispose of the original item 1.  Now let's suppose the original item 1
was an instance of a user-defined class, and let's further suppose
that the class defined a "__del__()" method.  If this class instance
has a reference count of 1, disposing of it will call its "__del__()"
method. Internally, "PyList_SetItem()" calls "Py_DECREF()" on the
replaced item, which invokes replaced item's corresponding
"tp_dealloc" function. During deallocation, "tp_dealloc" calls
"tp_finalize", which is mapped to the "__del__()" method for class
instances (see **PEP 442**). This entire sequence happens
synchronously within the "PyList_SetItem()" call.

Since it is written in Python, the "__del__()" method can execute
arbitrary Python code.  Could it perhaps do something to invalidate
the reference to "item" in "bug()"?  You bet!  Assuming that the list
passed into "bug()" is accessible to the "__del__()" method, it could
execute a statement to the effect of "del list[0]", and assuming this
was the last reference to that object, it would free the memory
associated with it, thereby invalidating "item".

La solución, una vez que conoce el origen del problema, es fácil:
incremente temporalmente el recuento de referencia. La versión
correcta de la función dice:

   void
   no_bug(PyObject *list)
   {
       PyObject *item = PyList_GetItem(list, 0);

       Py_INCREF(item);
       PyList_SetItem(list, 1, PyLong_FromLong(0L));
       PyObject_Print(item, stdout, 0);
       Py_DECREF(item);
   }

This is a true story.  An older version of Python contained variants
of this bug and someone spent a considerable amount of time in a C
debugger to figure out why his "__del__()" methods would fail...

The second case of problems with a borrowed reference is a variant
involving threads.  Normally, multiple threads in the Python
interpreter can't get in each other's way, because there is a *global
lock* protecting Python's entire object space. However, it is possible
to temporarily release this lock using the macro
"Py_BEGIN_ALLOW_THREADS", and to re-acquire it using
"Py_END_ALLOW_THREADS".  This is common around blocking I/O calls, to
let other threads use the processor while waiting for the I/O to
complete. Obviously, the following function has the same problem as
the previous one:

   void
   bug(PyObject *list)
   {
       PyObject *item = PyList_GetItem(list, 0);
       Py_BEGIN_ALLOW_THREADS
       ...some blocking I/O call...
       Py_END_ALLOW_THREADS
       PyObject_Print(item, stdout, 0); /* BUG! */
   }


Punteros NULL
-------------

En general, las funciones que toman referencias de objetos como
argumentos no esperan que les pase los punteros "NULL", y volcará el
núcleo (o causará volcados de núcleo posteriores) si lo hace. Las
funciones que retornan referencias a objetos generalmente retornan
"NULL" solo para indicar que ocurrió una excepción. La razón para no
probar los argumentos "NULL" es que las funciones a menudo pasan los
objetos que reciben a otra función --- si cada función probara "NULL",
habría muchas pruebas redundantes y el código correría más lentamente.

Es mejor probar "NULL" solo en "source:" cuando se recibe un puntero
que puede ser "NULL", por ejemplo, de "malloc()" o de una función que
puede plantear una excepción.

Las macros "Py_INCREF()" y "Py_DECREF()" no comprueban los punteros
"NULL" --- sin embargo, sus variantes "Py_XINCREF()" y "Py_XDECREF()"
lo hacen.

Las macros para verificar un tipo de objeto en particular
("Pytype_Check()") no verifican los punteros "NULL" --- nuevamente,
hay mucho código que llama a varios de estos en una fila para probar
un objeto contra varios tipos esperados diferentes, y esto generaría
pruebas redundantes. No hay variantes con comprobación "NULL".

The C function calling mechanism guarantees that the argument list
passed to C functions ("args" in the examples) is never "NULL" --- in
fact it guarantees that it is always a tuple [3].

Es un error grave dejar que un puntero "NULL" "escape" al usuario de
Python.


Escribiendo extensiones en C++
==============================

Es posible escribir módulos de extensión en C++. Se aplican algunas
restricciones. Si el compilador de C compila y vincula el programa
principal (el intérprete de Python), no se pueden usar objetos
globales o estáticos con constructores. Esto no es un problema si el
programa principal está vinculado por el compilador de C++. Las
funciones que serán llamadas por el intérprete de Python (en
particular, las funciones de inicialización del módulo) deben
declararse usando "extern "C"". No es necesario encerrar los archivos
de encabezado de Python en "extern "C" {...}" --- ya usan este
formulario si el símbolo "__cplusplus" está definido (todos los
compiladores recientes de C++ definen este símbolo) .


Proporcionar una API C para un módulo de extensión
==================================================

Muchos módulos de extensión solo proporcionan nuevas funciones y tipos
para ser utilizados desde Python, pero a veces el código en un módulo
de extensión puede ser útil para otros módulos de extensión. Por
ejemplo, un módulo de extensión podría implementar un tipo de
"colección" que funciona como listas sin orden. Al igual que el tipo
de lista Python estándar tiene una API C que permite a los módulos de
extensión crear y manipular listas, este nuevo tipo de colección debe
tener un conjunto de funciones C para la manipulación directa desde
otros módulos de extensión.

A primera vista, esto parece fácil: simplemente escriba las funciones
(sin declararlas "static", por supuesto), proporcione un archivo de
encabezado apropiado y documente la API de C. Y, de hecho, esto
funcionaría si todos los módulos de extensión siempre estuvieran
vinculados estáticamente con el intérprete de Python. Sin embargo,
cuando los módulos se usan como bibliotecas compartidas, los símbolos
definidos en un módulo pueden no ser visibles para otro módulo. Los
detalles de visibilidad dependen del sistema operativo; algunos
sistemas usan un espacio de nombres global para el intérprete de
Python y todos los módulos de extensión (Windows, por ejemplo),
mientras que otros requieren una lista explícita de símbolos
importados en el momento del enlace del módulo (AIX es un ejemplo) u
ofrecen una variedad de estrategias diferentes (la mayoría Unices). E
incluso si los símbolos son visibles a nivel mundial, ¡el módulo cuyas
funciones uno desea llamar podría no haberse cargado todavía!

Portability therefore requires not to make any assumptions about
symbol visibility. This means that all symbols in extension modules
should be declared "static", except for the module's initialization
function, in order to avoid name clashes with other extension modules.
And it means that symbols that *should* be accessible from other
extension modules must be exported in a different way.

Python proporciona un mecanismo especial para pasar información de
nivel C (punteros) de un módulo de extensión a otro: cápsulas. Una
cápsula es un tipo de datos de Python que almacena un puntero (void*).
Solo se puede crear y acceder a las cápsulas a través de su API C,
pero se pueden pasar como cualquier otro objeto de Python. En
particular, se pueden asignar a un nombre en el espacio de nombres de
un módulo de extensión. Otros módulos de extensión pueden importar
este módulo, recuperar el valor de este nombre y luego recuperar el
puntero de la Cápsula.

Hay muchas formas en que las Cápsulas se pueden usar para exportar la
API de C de un módulo de extensión. Cada función podría tener su
propia cápsula, o todos los punteros de API C podrían almacenarse en
una matriz cuya dirección se publica en una cápsula. Y las diversas
tareas de almacenamiento y recuperación de los punteros se pueden
distribuir de diferentes maneras entre el módulo que proporciona el
código y los módulos del cliente.

Cualquiera que sea el método que elija, es importante nombrar
correctamente sus Cápsulas. La función "PyCapsule_New()" toma un
parámetro de nombre (const char*); se le permite pasar un nombre
"NULL", pero le recomendamos encarecidamente que especifique un
nombre. Las Cápsulas correctamente nombradas brindan un grado de
seguridad de tipo de tiempo de ejecución; no hay una forma factible de
distinguir una Cápsula sin nombre de otra.

En particular, las cápsulas utilizadas para exponer las API de C deben
recibir un nombre siguiendo esta convención:

   modulename.attributename

La función de conveniencia "PyCapsule_Import()" facilita la carga de
una API C proporcionada a través de una cápsula, pero solo si el
nombre de la cápsula coincide con esta convención. Este comportamiento
brinda a los usuarios de C API un alto grado de certeza de que la
Cápsula que cargan contiene la API de C correcta.

El siguiente ejemplo demuestra un enfoque que pone la mayor parte de
la carga sobre el escritor del módulo de exportación, que es apropiado
para los módulos de biblioteca de uso común. Almacena todos los
punteros de la API de C (¡solo uno en el ejemplo!) en un arreglo de
punteros void que se convierte en el valor de una Cápsula. El archivo
de encabezado correspondiente al módulo proporciona una macro que se
encarga de importar el módulo y recuperar sus punteros C API; los
módulos de cliente solo tienen que llamar a esta macro antes de
acceder a la API de C.

The exporting module is a modification of the "spam" module from the
tutorial. The function "spam.system()" does not call the C library
function "system()" directly, but a function "PySpam_System()", which
would of course do something more complicated in reality (such as
adding "spam" to every command). This function "PySpam_System()" is
also exported to other extension modules.

The function "PySpam_System()" is a plain C function, declared
"static" like everything else:

   static int
   PySpam_System(const char *command)
   {
       return system(command);
   }

The function "spam_system()" is modified in a trivial way:

   static PyObject *
   spam_system(PyObject *self, PyObject *args)
   {
       const char *command;
       int sts;

       if (!PyArg_ParseTuple(args, "s", &command))
           return NULL;
       sts = PySpam_System(command);
       return PyLong_FromLong(sts);
   }

Al comienzo del módulo, justo después de la línea:

   #include <Python.h>

se deben agregar dos líneas más:

   #define SPAM_MODULE
   #include "spammodule.h"

The "#define" is used to tell the header file that it is being
included in the exporting module, not a client module. Finally, the
module's "mod_exec" function must take care of initializing the C API
pointer array:

   static int
   spam_module_exec(PyObject *m)
   {
       static void *PySpam_API[PySpam_API_pointers];
       PyObject *c_api_object;

       /* Initialize the C API pointer array */
       PySpam_API[PySpam_System_NUM] = (void *)PySpam_System;

       /* Create a Capsule containing the API pointer array's address */
       c_api_object = PyCapsule_New((void *)PySpam_API, "spam._C_API", NULL);

       if (PyModule_Add(m, "_C_API", c_api_object) < 0) {
           return -1;
       }

       return 0;
   }

Note that "PySpam_API" is declared "static"; otherwise the pointer
array would disappear when "PyInit_spam()" terminates!

La mayor parte del trabajo está en el archivo de encabezado
"spammodule.h", que se ve así:

   #ifndef Py_SPAMMODULE_H
   #define Py_SPAMMODULE_H
   #ifdef __cplusplus
   extern "C" {
   #endif

   /* Header file for spammodule */

   /* C API functions */
   #define PySpam_System_NUM 0
   #define PySpam_System_RETURN int
   #define PySpam_System_PROTO (const char *command)

   /* Total number of C API pointers */
   #define PySpam_API_pointers 1


   #ifdef SPAM_MODULE
   /* This section is used when compiling spammodule.c */

   static PySpam_System_RETURN PySpam_System PySpam_System_PROTO;

   #else
   /* This section is used in modules that use spammodule's API */

   static void **PySpam_API;

   #define PySpam_System \
    (*(PySpam_System_RETURN (*)PySpam_System_PROTO) PySpam_API[PySpam_System_NUM])

   /* Return -1 on error, 0 on success.
    * PyCapsule_Import will set an exception if there's an error.
    */
   static int
   import_spam(void)
   {
       PySpam_API = (void **)PyCapsule_Import("spam._C_API", 0);
       return (PySpam_API != NULL) ? 0 : -1;
   }

   #endif

   #ifdef __cplusplus
   }
   #endif

   #endif /* !defined(Py_SPAMMODULE_H) */

All that a client module must do in order to have access to the
function "PySpam_System()" is to call the function (or rather macro)
"import_spam()" in its "mod_exec" function:

   static int
   client_module_exec(PyObject *m)
   {
       if (import_spam() < 0) {
           return -1;
       }
       /* additional initialization can happen here */
       return 0;
   }

La principal desventaja de este enfoque es que el archivo
"spammodule.h" es bastante complicado. Sin embargo, la estructura
básica es la misma para cada función que se exporta, por lo que solo
se debe aprender una vez.

Finalmente, debe mencionarse que las cápsulas ofrecen una
funcionalidad adicional, que es especialmente útil para la asignación
de memoria y la desasignación del puntero almacenado en una cápsula.
Los detalles se describen en el Manual de referencia de Python/C API
en la sección Cápsulas y en la implementación de Capsules (archivos
"Include/pycapsule.h" y "Objects/pycapsule.c" en la distribución del
código fuente de Python).

-[ Notas al pie de página ]-

[1] La metáfora de "pedir prestado" una referencia no es completamente
    correcta: el propietario todavía tiene una copia de la referencia.

[2] ¡Comprobar que el recuento de referencia es al menos 1 **no
    funciona** --- el recuento de referencia en sí podría estar en la
    memoria liberada y, por lo tanto, puede reutilizarse para otro
    objeto!

[3] Estas garantías no se cumplen cuando utiliza la convención de
    llamadas de estilo "antiguo", que todavía se encuentra en muchos
    códigos existentes.
