Objectos Modulo
***************

PyTypeObject PyModule_Type

   Esta instancia de "PyTypeObject" representa el tipo de módulo
   Python. Esto está expuesto a los programas de Python como
   "types.ModuleType".

int PyModule_Check(PyObject *p)

   Retorna verdadero si *p* es un objeto de módulo o un subtipo de un
   objeto de módulo. Esta función siempre finaliza con éxito.

int PyModule_CheckExact(PyObject *p)

   Retorna verdadero si *p* es un objeto módulo, pero no un subtipo de
   "PyModule_Type". Esta función siempre finaliza con éxito.

PyObject* PyModule_NewObject(PyObject *name)
    *Return value: New reference.*

   Retorna un nuevo objeto módulo con el atributo "__name__"
   establecido en *name*. Los atributos del módulo "__name__",
   "__doc__", "__package__", y "__loader__" se completan (todos menos
   "__name__" están configurados en "None"); quien llama es
   responsable de proporcionar un atributo "__file__".

   Nuevo en la versión 3.3.

   Distinto en la versión 3.4: "__package__" y "__loader__" están
   configurados en "None".

PyObject* PyModule_New(const char *name)
    *Return value: New reference.*

   Similar a "PyModule_NewObject()", pero el nombre es una cadena de
   caracteres codificada UTF-8 en lugar de un objeto Unicode.

PyObject* PyModule_GetDict(PyObject *module)
    *Return value: Borrowed reference.*

   Retorna el objeto del diccionario que implementa el espacio de
   nombres de *module*; este objeto es el mismo que el atributo
   "__dict__" del objeto módulo. Si *module* no es un objeto módulo (o
   un subtipo de un objeto de módulo), "SystemError" se genera y se
   retorna "NULL".

   Se recomienda que las extensiones utilicen otras funciones
   "PyModule_*()" y "PyObject_*()" en lugar de manipular directamente
   el módulo "__dict__".

PyObject* PyModule_GetNameObject(PyObject *module)
    *Return value: New reference.*

   Retorna el valor "__name__" del *module*. Si el módulo no
   proporciona uno, o si no es una cadena de caracteres, "SystemError"
   se lanza y se retorna "NULL".

   Nuevo en la versión 3.3.

const char* PyModule_GetName(PyObject *module)

   Similar a "PyModule_GetNameObject()" pero retorna el nombre
   codificado a "'utf-8'".

void* PyModule_GetState(PyObject *module)

   Retorna el "estado" del módulo, es decir, un puntero al bloque de
   memoria asignado en el momento de la creación del módulo, o "NULL".
   Ver "PyModuleDef.m_size".

PyModuleDef* PyModule_GetDef(PyObject *module)

   Retorna un puntero a la estructura "PyModuleDef" a partir de la
   cual se creó el módulo, o "NULL" si el módulo no se creó a partir
   de una definición.

PyObject* PyModule_GetFilenameObject(PyObject *module)
    *Return value: New reference.*

   Retorna el nombre del archivo desde el cual *module* se cargó
   utilizando el atributo "__file__" del *module*. Si esto no está
   definido, o si no es una cadena de caracteres unicode, lanza
   "SystemError" y retornar "NULL"; de lo contrario, retorna una
   referencia a un objeto Unicode.

   Nuevo en la versión 3.2.

const char* PyModule_GetFilename(PyObject *module)

   Similar a "PyModule_GetFilenameObject()" pero retorna el nombre de
   archivo codificado a 'utf-8'.

   Obsoleto desde la versión 3.2: "PyModule_GetFilename()" lanza
   "UnicodeEncodeError" en nombres de archivo no codificables, use
   "PyModule_GetFilenameObject()" en su lugar.


Inicializando módulos en C
==========================

Los objetos módulos generalmente se crean a partir de módulos de
extensión (bibliotecas compartidas que exportan una función de
inicialización) o módulos compilados (donde la función de
inicialización se agrega usando "PyImport_AppendInittab()"). Consulte
Construyendo Extensiones C y C++ o Extendiendo Python Incrustado para
más detalles.

La función de inicialización puede pasar una instancia de definición
de módulo a "PyModule_Create()", y retornar el objeto módulo
resultante, o solicitar una "inicialización de múltiples fases"
retornando la estructura de definición.

PyModuleDef

   La estructura de definición de módulo, que contiene toda la
   información necesaria para crear un objeto módulo. Por lo general,
   solo hay una variable estáticamente inicializada de este tipo para
   cada módulo.

   PyModuleDef_Base m_base

      Siempre inicialice este miembro a "PyModuleDef_HEAD_INIT".

   const char *m_name

      Nombre para el nuevo módulo.

   const char *m_doc

      Docstring para el módulo; por lo general, se usa una variable
      docstring creada con "PyDoc_STRVAR".

   Py_ssize_t m_size

      El estado del módulo se puede mantener en un área de memoria por
      módulo que se puede recuperar con "PyModule_GetState()", en
      lugar de en globales estáticos. Esto hace que los módulos sean
      seguros para su uso en múltiples sub-interpretadores.

      Esta área de memoria se asigna en base a *m_size* en la creación
      del módulo, y se libera cuando el objeto del módulo se
      desasigna, después de que se haya llamado a la función "m_free",
      si está presente.

      Establecer "m_size" en "-1" significa que el módulo no admite
      sub-interpretadores, porque tiene un estado global.

      Establecerlo en un valor no negativo significa que el módulo se
      puede reinicializar y especifica la cantidad adicional de
      memoria que requiere para su estado. Se requiere "m_size" no
      negativo para la inicialización de múltiples fases.

      Ver **PEP 3121** para más detalles.

   PyMethodDef* m_methods

      Un puntero a una tabla de funciones de nivel de módulo, descrito
      por valores "PyMethodDef". Puede ser "NULL" si no hay funciones
      presentes.

   PyModuleDef_Slot* m_slots

      Un conjunto de definiciones de ranura para la inicialización de
      múltiples fases, terminadas por una entrada "{0, NULL}". Cuando
      se utiliza la inicialización monofásica, *m_slots* debe ser
      "NULL".

      Distinto en la versión 3.5: Antes de la versión 3.5, este
      miembro siempre estaba configurado en "NULL" y se definía como:

         inquiry m_reload

   traverseproc m_traverse

      Una función transversal para llamar durante el recorrido GC del
      objeto del módulo, o "NULL" si no es necesario.

      Esta función no se llama si se solicitó el estado del módulo
      pero aún no se asignó. Este es el caso inmediatamente después de
      que se crea el módulo y antes de que se ejecute (la función
      "Py_mod_exec"). Más precisamente, esta función no se llama si
      "m_size" es mayor que 0 y el estado del módulo (como lo retorna
      "PyModule_GetState()") es "NULL".

      Distinto en la versión 3.9: Ya no se llama antes de que se
      asigne el estado del módulo.

   inquiry m_clear

      Una función clara para llamar durante la limpieza GC del objeto
      del módulo, o "NULL" si no es necesario.

      Esta función no se llama si se solicitó el estado del módulo
      pero aún no se asignó. Este es el caso inmediatamente después de
      que se crea el módulo y antes de que se ejecute (la función
      "Py_mod_exec"). Más precisamente, esta función no se llama si
      "m_size" es mayor que 0 y el estado del módulo (como lo retorna
      "PyModule_GetState()") es "NULL".

      Like "PyTypeObject.tp_clear", this function is not *always*
      called before a module is deallocated. For example, when
      reference counting is enough to determine that an object is no
      longer used, the cyclic garbage collector is not involved and
      "m_free" is called directly.

      Distinto en la versión 3.9: Ya no se llama antes de que se
      asigne el estado del módulo.

   freefunc m_free

      Una función para llamar durante la desasignación del objeto del
      módulo, o "NULL" si no es necesario.

      Esta función no se llama si se solicitó el estado del módulo
      pero aún no se asignó. Este es el caso inmediatamente después de
      que se crea el módulo y antes de que se ejecute (la función
      "Py_mod_exec"). Más precisamente, esta función no se llama si
      "m_size" es mayor que 0 y el estado del módulo (como lo retorna
      "PyModule_GetState()") es "NULL".

      Distinto en la versión 3.9: Ya no se llama antes de que se
      asigne el estado del módulo.


Inicialización monofásica
-------------------------

La función de inicialización del módulo puede crear y retornar el
objeto módulo directamente. Esto se conoce como "inicialización
monofásica" y utiliza una de las siguientes funciones de creación de
dos módulos:

PyObject* PyModule_Create(PyModuleDef *def)
    *Return value: New reference.*

   Crea un nuevo objeto módulo, dada la definición en *def*. Esto se
   comporta como "PyModule_Create2()" con *module_api_version*
   establecido en "PYTHON_API_VERSION".

PyObject* PyModule_Create2(PyModuleDef *def, int module_api_version)
    *Return value: New reference.*

   Crea un nuevo objeto de módulo, dada la definición en *def*,
   asumiendo la versión de API *module_api_version*. Si esa versión no
   coincide con la versión del intérprete en ejecución, se emite un
   "RuntimeWarning".

   Nota:

     La mayoría de los usos de esta función deberían usar
     "PyModule_Create()" en su lugar; solo use esto si está seguro de
     que lo necesita.

Antes de que se retorne desde la función de inicialización, el objeto
del módulo resultante normalmente se llena utilizando funciones como
"PyModule_AddObject()".


Inicialización multifase
------------------------

Una forma alternativa de especificar extensiones es solicitar una
"inicialización de múltiples fases". Los módulos de extensión creados
de esta manera se comportan más como los módulos de Python: la
inicialización se divide entre la fase de creación (*creation phase*),
cuando se crea el objeto módulo, y la fase de ejecución (*execution
phase*), cuando se llena. La distinción es similar a los métodos de
clases "__new__()" y "__init__()".

A diferencia de los módulos creados con la inicialización monofásica,
estos módulos no son singletons: si se elimina la entrada
*sys.modules* y el módulo se vuelve a importar, se crea un nuevo
objeto módulo y el módulo anterior está sujeto a la recolección normal
de basura -- Al igual que con los módulos de Python. Por defecto, los
módulos múltiples creados a partir de la misma definición deberían ser
independientes: los cambios en uno no deberían afectar a los demás.
Esto significa que todo el estado debe ser específico para el objeto
del módulo (usando, por ejemplo, usando "PyModule_GetState()"), o su
contenido (como el módulo "__dict__" o clases individuales creadas con
"PyType_FromSpec()").

Se espera que todos los módulos creados mediante la inicialización de
múltiples fases admitan sub-interpretadores. Asegurándose de que
varios módulos sean independientes suele ser suficiente para lograr
esto.

Para solicitar la inicialización de múltiples fases, la función de
inicialización (*PyInit_modulename*) retorna una instancia de
"PyModuleDef" con un "m_slots" no vacío. Antes de que se retorna, la
instancia "PyModuleDef" debe inicializarse con la siguiente función:

PyObject* PyModuleDef_Init(PyModuleDef *def)
    *Return value: Borrowed reference.*

   Asegura que la definición de un módulo sea un objeto Python
   correctamente inicializado que informe correctamente su tipo y
   conteo de referencias.

   Retorna *def* convertido a "PyObject*" o "NULL" si se produjo un
   error.

   Nuevo en la versión 3.5.

El miembro *m_slots* de la definición del módulo debe apuntar a un
arreglo de estructuras "PyModuleDef_Slot":

PyModuleDef_Slot

   int slot

      Una ranura ID, elegida entre los valores disponibles que se
      explican a continuación.

   void* value

      Valor de la ranura, cuyo significado depende de la ID de la
      ranura.

   Nuevo en la versión 3.5.

El arreglo *m_slots* debe estar terminada por una ranura con id 0.

Los tipos de ranura disponibles son:

Py_mod_create

   Especifica una función que se llama para crear el objeto del módulo
   en sí. El puntero *value* de este espacio debe apuntar a una
   función de la firma:

   PyObject* create_module(PyObject *spec, PyModuleDef *def)

   La función recibe una instancia de "ModuleSpec", como se define en
   **PEP 451**, y la definición del módulo. Debería retornar un nuevo
   objeto de módulo, o establecer un error y retornar "NULL".

   Esta función debe mantenerse mínima. En particular, no debería
   llamar a código arbitrario de Python, ya que intentar importar el
   mismo módulo nuevamente puede dar como resultado un bucle infinito.

   Múltiples ranuras "Py_mod_create" no pueden especificarse en una
   definición de módulo.

   Si no se especifica "Py_mod_create", la maquinaria de importación
   creará un objeto de módulo normal usando "PyModule_New()". El
   nombre se toma de *spec*, no de la definición, para permitir que
   los módulos de extensión se ajusten dinámicamente a su lugar en la
   jerarquía de módulos y se importen bajo diferentes nombres a través
   de enlaces simbólicos, todo mientras se comparte una definición de
   módulo único.

   No es necesario que el objeto retornado sea una instancia de
   "PyModule_Type". Se puede usar cualquier tipo, siempre que admita
   la configuración y la obtención de atributos relacionados con la
   importación. Sin embargo, solo se pueden retornar instancias
   "PyModule_Type" si el "PyModuleDef" no tiene "NULL" "m_traverse",
   "m_clear", "m_free"; "m_size" distinto de cero; o ranuras que no
   sean "Py_mod_create".

Py_mod_exec

   Especifica una función que se llama para ejecutar (*execute*) el
   módulo. Esto es equivalente a ejecutar el código de un módulo
   Python: por lo general, esta función agrega clases y constantes al
   módulo. La firma de la función es:

   int exec_module(PyObject* module)

   Si se especifican varias ranuras "Py_mod_exec", se procesan en el
   orden en que aparecen en el arreglo *m_slots*.

Ver **PEP 489** para más detalles sobre la inicialización de múltiples
fases.


Funciones de creación de módulos de bajo nivel
----------------------------------------------

Las siguientes funciones se invocan en segundo plano cuando se utiliza
la inicialización de múltiples fases. Se pueden usar directamente, por
ejemplo, al crear objetos de módulo de forma dinámica. Tenga en cuenta
que tanto "PyModule_FromDefAndSpec" como "PyModule_ExecDef" deben
llamarse para inicializar completamente un módulo.

PyObject * PyModule_FromDefAndSpec(PyModuleDef *def, PyObject *spec)
    *Return value: New reference.*

   Cree un nuevo objeto módulo, dada la definición en *module* y
   ModuleSpec *spec*. Esto se comporta como
   "PyModule_FromDefAndSpec2()" con *module_api_version* establecido
   en "PYTHON_API_VERSION".

   Nuevo en la versión 3.5.

PyObject * PyModule_FromDefAndSpec2(PyModuleDef *def, PyObject *spec, int module_api_version)
    *Return value: New reference.*

   Cree un nuevo objeto módulo, dada la definición en *module* y
   ModuleSpec *spec*, asumiendo la versión de API
   *module_api_version*. Si esa versión no coincide con la versión del
   intérprete en ejecución, se emite un "RuntimeWarning".

   Nota:

     La mayoría de los usos de esta función deberían usar
     "PyModule_FromDefAndSpec()" en su lugar; solo use esto si está
     seguro de que lo necesita.

   Nuevo en la versión 3.5.

int PyModule_ExecDef(PyObject *module, PyModuleDef *def)

   Procesa cualquier ranura de ejecución ("Py_mod_exec") dado en
   *def*.

   Nuevo en la versión 3.5.

int PyModule_SetDocString(PyObject *module, const char *docstring)

   Establece la cadena de caracteres de documentación para *module* en
   *docstring*. Esta función se llama automáticamente cuando se crea
   un módulo desde "PyModuleDef", usando "PyModule_Create" o
   "PyModule_FromDefAndSpec".

   Nuevo en la versión 3.5.

int PyModule_AddFunctions(PyObject *module, PyMethodDef *functions)

   Agrega las funciones del arreglo *functions* terminadas en "NULL" a
   *module*. Consulte la documentación de "PyMethodDef" para obtener
   detalles sobre entradas individuales (debido a la falta de un
   espacio de nombres de módulo compartido, las "funciones" de nivel
   de módulo implementadas en C generalmente reciben el módulo como su
   primer parámetro, haciéndolos similares a la instancia métodos en
   clases de Python). Esta función se llama automáticamente cuando se
   crea un módulo desde "PyModuleDef", usando "PyModule_Create" o
   "PyModule_FromDefAndSpec".

   Nuevo en la versión 3.5.


Funciones de soporte
--------------------

La función de inicialización del módulo (si usa la inicialización de
fase única) o una función llamada desde un intervalo de ejecución del
módulo (si usa la inicialización de múltiples fases), puede usar las
siguientes funciones para ayudar a inicializar el estado del módulo:

int PyModule_AddObject(PyObject *module, const char *name, PyObject *value)

   Agrega un objeto a *module* como *name*. Esta es una función
   conveniente que se puede utilizar desde la función de
   inicialización del módulo. Esto roba una referencia al *value* en
   caso de éxito. Retorna "-1" en caso de error, "0" en caso de éxito.

   Nota:

     A diferencia de otras funciones que roban referencias,
     "PyModule_AddObject()" solo disminuye el conteo de referencias de
     *value* **en caso de éxito**.Esto significa que su valor de
     retorno debe ser verificado, y el código de llamada debe
     "Py_DECREF()" *value* manualmente en caso de error. Ejemplo de
     uso:

        Py_INCREF(spam);
        if (PyModule_AddObject(module, "spam", spam) < 0) {
            Py_DECREF(module);
            Py_DECREF(spam);
            return NULL;
        }

int PyModule_AddIntConstant(PyObject *module, const char *name, long value)

   Agrega una constante entera a *module* como *name*. Esta función de
   conveniencia se puede usar desde la función de inicialización del
   módulo. Retorna "-1" en caso de error, "0" en caso de éxito.

int PyModule_AddStringConstant(PyObject *module, const char *name, const char *value)

   Agrega una constante de cadena a *module* como *name*. Esta función
   de conveniencia se puede usar desde la función de inicialización
   del módulo. La cadena de caracteres *value* debe estar terminada en
   "NULL". Retorna "-1" en caso de error, "0" en caso de éxito.

int PyModule_AddIntMacro(PyObject *module, macro)

   Agrega una constante int a *module*. El nombre y el valor se toman
   de *macro*. Por ejemplo, "PyModule_AddIntMacro(module, AF_INET)"
   agrega la constante int *AF_INET* con el valor de *AF_INET* a
   *module*. Retorna "-1" en caso de error, "0" en caso de éxito.

int PyModule_AddStringMacro(PyObject *module, macro)

   Agrega una constante de cadena de caracteres a *module*.

int PyModule_AddType(PyObject *module, PyTypeObject *type)

   Agrega un objeto tipo a *module*. El objeto tipo se finaliza
   llamando internamente "PyType_Ready()". El nombre del objeto tipo
   se toma del último componente de "tp_name" después del punto.
   Retorna "-1" en caso de error, "0" en caso de éxito.

   Nuevo en la versión 3.9.


Búsqueda de módulos
===================

La inicialización monofásica crea módulos singleton que se pueden
buscar en el contexto del intérprete actual. Esto permite que el
objeto módulo se recupere más tarde con solo una referencia a la
definición del módulo.

Estas funciones no funcionarán en módulos creados mediante la
inicialización de múltiples fases, ya que se pueden crear múltiples
módulos de este tipo desde una sola definición.

PyObject* PyState_FindModule(PyModuleDef *def)
    *Return value: Borrowed reference.*

   Retorna el objeto módulo que se creó a partir de *def* para el
   intérprete actual. Este método requiere que el objeto módulo se
   haya adjuntado al estado del intérprete con "PyState_AddModule()"
   de antemano. En caso de que el objeto módulo correspondiente no se
   encuentre o no se haya adjuntado al estado del intérprete,
   retornará "NULL".

int PyState_AddModule(PyObject *module, PyModuleDef *def)

   Adjunta el objeto del módulo pasado a la función al estado del
   intérprete. Esto permite que se pueda acceder al objeto del módulo
   a través de "PyState_FindModule()".

   Solo es efectivo en módulos creados con la inicialización
   monofásica.

   Python llama a "PyState_AddModule" automáticamente después de
   importar un módulo, por lo que es innecesario (pero inofensivo)
   llamarlo desde el código de inicialización del módulo. Solo se
   necesita una llamada explícita si el propio código de inicio del
   módulo llama posteriormente "PyState_FindModule". La función está
   destinada principalmente a implementar mecanismos de importación
   alternativos (ya sea llamándolo directamente o refiriéndose a su
   implementación para obtener detalles de las actualizaciones de
   estado requeridas).

   La persona que llama debe retener el GIL.

   Retorna 0 en caso de éxito o -1 en caso de error.

   Nuevo en la versión 3.3.

int PyState_RemoveModule(PyModuleDef *def)

   Elimina el objeto del módulo creado a partir de *def* del estado
   del intérprete. Retorna 0 en caso de éxito o -1 en caso de error.

   La persona que llama debe retener el GIL.

   Nuevo en la versión 3.3.
