Objetos módulo

PyTypeObject PyModule_Type

Part of the Stable ABI.

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. Part of the Stable ABI since version 3.7.

Return a new module object with module.__name__ set to name. The module’s __name__, __doc__, __package__ and __loader__ attributes are filled in (all but __name__ are set to None). The caller is responsible for setting a __file__ attribute.

Return NULL with an exception set on error.

Added in version 3.3.

Distinto en la versión 3.4: __package__ and __loader__ are now set to None.

PyObject *PyModule_New(const char *name)

Return value: New reference. Part of the Stable ABI.

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. Part of the Stable ABI.

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), se lanza SystemError y se retorna NULL.

It is recommended extensions use other PyModule_* and PyObject_* functions rather than directly manipulate a module’s __dict__.

PyObject *PyModule_GetNameObject(PyObject *module)

Return value: New reference. Part of the Stable ABI since version 3.7.

Return module’s __name__ value. If the module does not provide one, or if it is not a string, SystemError is raised and NULL is returned.

Added in version 3.3.

const char *PyModule_GetName(PyObject *module)

Part of the Stable ABI.

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

void *PyModule_GetState(PyObject *module)

Part of the Stable ABI.

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)

Part of the Stable ABI.

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. Part of the Stable ABI.

Return the name of the file from which module was loaded using module’s __file__ attribute. If this is not defined, or if it is not a string, raise SystemError and return NULL; otherwise return a reference to a Unicode object.

Added in version 3.2.

const char *PyModule_GetFilename(PyObject *module)

Part of the Stable ABI.

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

Obsoleto desde la versión 3.2: PyModule_GetFilename() raises UnicodeEncodeError on unencodable filenames, use PyModule_GetFilenameObject() instead.

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 con incrustación 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.

type PyModuleDef

Part of the Stable ABI (including all members).

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

Always initialize this member to 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.

This memory area is allocated based on m_size on module creation, and freed when the module object is deallocated, after the m_free function has been called, if present.

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.

This function is not called if the module state was requested but is not allocated yet. This is the case immediately after the module is created and before the module is executed (Py_mod_exec function). More precisely, this function is not called if m_size is greater than 0 and the module state (as returned by PyModule_GetState()) is 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.

This function is not called if the module state was requested but is not allocated yet. This is the case immediately after the module is created and before the module is executed (Py_mod_exec function). More precisely, this function is not called if m_size is greater than 0 and the module state (as returned by PyModule_GetState()) is NULL.

Tal como PyTypeObject.tp_clear, esta función no siempre es llamada antes de la designación de un módulo. Por ejemplo, cuando el recuento de referencias está listo para determinar que un objeto no se usa más, la recolección de basura cíclica no se involucra y se llama a m_free directamente.

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.

This function is not called if the module state was requested but is not allocated yet. This is the case immediately after the module is created and before the module is executed (Py_mod_exec function). More precisely, this function is not called if m_size is greater than 0 and the module state (as returned by PyModule_GetState()) is 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.

Create a new module object, given the definition in def. This behaves like PyModule_Create2() with module_api_version set to PYTHON_API_VERSION.

PyObject *PyModule_Create2(PyModuleDef *def, int module_api_version)

Return value: New reference. Part of the Stable ABI.

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.

Return NULL with an exception set on error.

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_AddObjectRef().

Inicialización multifase

An alternate way to specify extensions is to request «multi-phase initialization». Extension modules created this way behave more like Python modules: the initialization is split between the creation phase, when the module object is created, and the execution phase, when it is populated. The distinction is similar to the __new__() and __init__() methods of classes.

Unlike modules created using single-phase initialization, these modules are not singletons: if the sys.modules entry is removed and the module is re-imported, a new module object is created, and the old module is subject to normal garbage collection – as with Python modules. By default, multiple modules created from the same definition should be independent: changes to one should not affect the others. This means that all state should be specific to the module object (using e.g. using PyModule_GetState()), or its contents (such as the module’s __dict__ or individual classes created with 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. Part of the Stable ABI since version 3.5.

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.

Added in version 3.5.

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

type 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.

Added in version 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.

Py_mod_multiple_interpreters

Specifies one of the following values:

Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED

The module does not support being imported in subinterpreters.

Py_MOD_MULTIPLE_INTERPRETERS_SUPPORTED

The module supports being imported in subinterpreters, but only when they share the main interpreter’s GIL. (See Aislamiento de módulos de extensión.)

Py_MOD_PER_INTERPRETER_GIL_SUPPORTED

The module supports being imported in subinterpreters, even when they have their own GIL. (See Aislamiento de módulos de extensión.)

This slot determines whether or not importing this module in a subinterpreter will fail.

Multiple Py_mod_multiple_interpreters slots may not be specified in one module definition.

If Py_mod_multiple_interpreters is not specified, the import machinery defaults to Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED.

Added in version 3.12.

Py_mod_gil

Specifies one of the following values:

Py_MOD_GIL_USED

The module depends on the presence of the global interpreter lock (GIL), and may access global state without synchronization.

Py_MOD_GIL_NOT_USED

The module is safe to run without an active GIL.

This slot is ignored by Python builds not configured with --disable-gil. Otherwise, it determines whether or not importing this module will cause the GIL to be automatically enabled. See Free-threaded CPython for more detail.

Multiple Py_mod_gil slots may not be specified in one module definition.

If Py_mod_gil is not specified, the import machinery defaults to Py_MOD_GIL_USED.

Added in version 3.13.

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.

Create a new module object, given the definition in def and the ModuleSpec spec. This behaves like PyModule_FromDefAndSpec2() with module_api_version set to PYTHON_API_VERSION.

Added in version 3.5.

PyObject *PyModule_FromDefAndSpec2(PyModuleDef *def, PyObject *spec, int module_api_version)

Return value: New reference. Part of the Stable ABI since version 3.7.

Create a new module object, given the definition in def and the ModuleSpec spec, assuming the API version module_api_version. If that version does not match the version of the running interpreter, a RuntimeWarning is emitted.

Return NULL with an exception set on error.

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.

Added in version 3.5.

int PyModule_ExecDef(PyObject *module, PyModuleDef *def)

Part of the Stable ABI since version 3.7.

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

Added in version 3.5.

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

Part of the Stable ABI since version 3.7.

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.

Added in version 3.5.

int PyModule_AddFunctions(PyObject *module, PyMethodDef *functions)

Part of the Stable ABI since version 3.7.

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.

Added in version 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_AddObjectRef(PyObject *module, const char *name, PyObject *value)

Part of the Stable ABI since version 3.10.

Agrega un objeto a module como name. Esta es una función de conveniencia que se puede usar desde la función de inicialización del módulo.

En caso de éxito, retorna 0. En caso de error, lanza una excepción y retorna -1.

Return -1 if value is NULL. It must be called with an exception raised in this case.

Ejemplo de uso

static int
add_spam(PyObject *module, int value)
{
    PyObject *obj = PyLong_FromLong(value);
    if (obj == NULL) {
        return -1;
    }
    int res = PyModule_AddObjectRef(module, "spam", obj);
    Py_DECREF(obj);
    return res;
 }

El ejemplo puede también ser escrito sin verificar explicitamente si obj es NULL:

static int
add_spam(PyObject *module, int value)
{
    PyObject *obj = PyLong_FromLong(value);
    int res = PyModule_AddObjectRef(module, "spam", obj);
    Py_XDECREF(obj);
    return res;
 }

Note que Py_XDECREF() debería ser usado en vez de Py_DECREF() en este caso, ya que obj puede ser NULL.

The number of different name strings passed to this function should be kept small, usually by only using statically allocated strings as name. For names that aren’t known at compile time, prefer calling PyUnicode_FromString() and PyObject_SetAttr() directly. For more details, see PyUnicode_InternFromString(), which may be used internally to create a key object.

Added in version 3.10.

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

Part of the Stable ABI since version 3.13.

Similar to PyModule_AddObjectRef(), but «steals» a reference to value. It can be called with a result of function that returns a new reference without bothering to check its result or even saving it to a variable.

Ejemplo de uso

if (PyModule_Add(module, "spam", PyBytes_FromString(value)) < 0) {
    goto error;
}

Added in version 3.13.

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

Part of the Stable ABI.

Similar a PyModule_AddObjectRef(), pero roba una referencia a value en caso de éxito (en este caso retorna 0).

The new PyModule_Add() or PyModule_AddObjectRef() functions are recommended, since it is easy to introduce reference leaks by misusing the PyModule_AddObject() function.

Nota

Unlike other functions that steal references, PyModule_AddObject() only releases the reference to value on success.

This means that its return value must be checked, and calling code must Py_XDECREF() value manually on error.

Ejemplo de uso

PyObject *obj = PyBytes_FromString(value);
if (PyModule_AddObject(module, "spam", obj) < 0) {
    // If 'obj' is not NULL and PyModule_AddObject() failed,
    // 'obj' strong reference must be deleted with Py_XDECREF().
    // If 'obj' is NULL, Py_XDECREF() does nothing.
    Py_XDECREF(obj);
    goto error;
}
// PyModule_AddObject() stole a reference to obj:
// Py_XDECREF(obj) is not needed here.

Obsoleto desde la versión 3.13: PyModule_AddObject() is soft deprecated.

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

Part of the Stable ABI.

Add an integer constant to module as name. This convenience function can be used from the module’s initialization function. Return -1 with an exception set on error, 0 on success.

This is a convenience function that calls PyLong_FromLong() and PyModule_AddObjectRef(); see their documentation for details.

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

Part of the Stable ABI.

Add a string constant to module as name. This convenience function can be used from the module’s initialization function. The string value must be NULL-terminated. Return -1 with an exception set on error, 0 on success.

This is a convenience function that calls PyUnicode_InternFromString() and PyModule_AddObjectRef(); see their documentation for details.

PyModule_AddIntMacro(module, macro)

Add an int constant to module. The name and the value are taken from macro. For example PyModule_AddIntMacro(module, AF_INET) adds the int constant AF_INET with the value of AF_INET to module. Return -1 with an exception set on error, 0 on success.

PyModule_AddStringMacro(module, macro)

Agrega una constante de cadena de caracteres a module.

int PyModule_AddType(PyObject *module, PyTypeObject *type)

Part of the Stable ABI since version 3.10.

Add a type object to module. The type object is finalized by calling internally PyType_Ready(). The name of the type object is taken from the last component of tp_name after dot. Return -1 with an exception set on error, 0 on success.

Added in version 3.9.

int PyUnstable_Module_SetGIL(PyObject *module, void *gil)

This is Unstable API. It may change without warning in minor releases.

Indicate that module does or does not support running without the global interpreter lock (GIL), using one of the values from Py_mod_gil. It must be called during module’s initialization function. If this function is not called during module initialization, the import machinery assumes the module does not support running without the GIL. This function is only available in Python builds configured with --disable-gil. Return -1 with an exception set on error, 0 on success.

Added in version 3.13.

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. Part of the Stable ABI.

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)

Part of the Stable ABI since version 3.3.

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.

Return -1 with an exception set on error, 0 on success.

Added in version 3.3.

int PyState_RemoveModule(PyModuleDef *def)

Part of the Stable ABI since version 3.3.

Removes the module object created from def from the interpreter state. Return -1 with an exception set on error, 0 on success.

La persona que llama debe retener el GIL.

Added in version 3.3.