# Importer des modules — Documentation Python 3.16.0a0

# Importer des modules

PyObject *PyImport_ImportModule(const char *name)
  Valeur de retour : nouvelle référence. Fait partie de l' ABI stable.

  This is a wrapper around `PyImport_Import()` which takes a const char* as an argument instead of a PyObject *.

PyObject *PyImport_ImportModuleEx(const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist)
  Valeur de retour : nouvelle référence.

  Import a module. This is best described by referring to the built-in Python function `__import__()`.

  The return value is a new reference to the imported module or top-level package, or `NULL` with an exception set on failure. Like for `__import__()`, the return value when a submodule of a package was requested is normally the top-level package, unless a non-empty fromlist was given.

  Failing imports remove incomplete module objects, like with `PyImport_ImportModule()`.

PyObject *PyImport_ImportModuleLevelObject( PyObject *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level)
  Valeur de retour : nouvelle référence. Fait partie de l' ABI stable depuis la version 3.7.

  Import a module. This is best described by referring to the built-in Python function `__import__()`, as the standard `__import__()` function calls this function directly.

  The return value is a new reference to the imported module or top-level package, or `NULL` with an exception set on failure. Like for `__import__()`, the return value when a submodule of a package was requested is normally the top-level package, unless a non-empty fromlist was given.

  Ajouté dans la version 3.3.

PyObject *PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level)
  Valeur de retour : nouvelle référence. Fait partie de l' ABI stable.

  Similar to `PyImport_ImportModuleLevelObject()`, but the name is a UTF-8 encoded string instead of a Unicode object.

  Modifié dans la version 3.3: Negative values for level are no longer accepted.

PyObject *PyImport_Import( PyObject *name)
  Valeur de retour : nouvelle référence. Fait partie de l' ABI stable.

  This is a higher-level interface that calls the current "import hook function" (with an explicit level of 0, meaning absolute import). It invokes the `__import__()` function from the `__builtins__` of the current globals. This means that the import is done using whatever import hooks are installed in the current environment.

  This function always uses absolute imports.

PyObject *PyImport_ReloadModule( PyObject *m)
  Valeur de retour : nouvelle référence. Fait partie de l' ABI stable.

  Reload a module. Return a new reference to the reloaded module, or `NULL` with an exception set on failure (the module still exists in this case).

PyObject *PyImport_AddModuleRef(const char *name)
  Valeur de retour : nouvelle référence. Fait partie de l' ABI stable depuis la version 3.13.

  Return the module object corresponding to a module name.

  The name argument may be of the form `package.module`. First check the modules dictionary if there's one there, and if not, create a new one and insert it in the modules dictionary.

  Return a strong reference to the module on success. Return `NULL` with an exception set on failure.

  The module name name is decoded from UTF-8.

  This function does not load or import the module; if the module wasn't already loaded, you will get an empty module object. Use `PyImport_ImportModule()` or one of its variants to import a module. Package structures implied by a dotted name for name are not created if not already present.

  Ajouté dans la version 3.13.

PyObject *PyImport_AddModuleObject( PyObject *name)
  Valeur de retour : référence empruntée. Fait partie de l' ABI stable depuis la version 3.7.

  Similar to `PyImport_AddModuleRef()`, but return a borrowed reference and name is a Python `str` object.

  Ajouté dans la version 3.3.

PyObject *PyImport_AddModule(const char *name)
  Valeur de retour : référence empruntée. Fait partie de l' ABI stable.

  Similar to `PyImport_AddModuleRef()`, but return a borrowed reference.

PyObject *PyImport_ExecCodeModule(const char *name, PyObject *co)
  Valeur de retour : nouvelle référence. Fait partie de l' ABI stable.

  Given a module name (possibly of the form `package.module`) and a code object read from a Python bytecode file or obtained from the built-in function `compile()`, load the module. Return a new reference to the module object, or `NULL` with an exception set if an error occurred. name is removed from `sys.modules` in error cases, even if name was already in `sys.modules` on entry to `PyImport_ExecCodeModule()`. Leaving incompletely initialized modules in `sys.modules` is dangerous, as imports of such modules have no way to know that the module object is an unknown (and probably damaged with respect to the module author's intents) state.

  The module's `__spec__` and `__loader__` will be set, if not set already, with the appropriate values. The spec's loader will be set to the module's `__loader__` (if set) and to an instance of `SourceFileLoader` otherwise.

  The module's `__file__` attribute will be set to the code object's `co_filename`.

  This function will reload the module if it was already imported. See `PyImport_ReloadModule()` for the intended way to reload a module.

  If name points to a dotted name of the form `package.module`, any package structures not already created will still not be created.

  See also `PyImport_ExecCodeModuleEx()` and `PyImport_ExecCodeModuleWithPathnames()`.

  Modifié dans la version 3.12: The setting of `__cached__` and `__loader__` is deprecated. See `ModuleSpec` for alternatives.

  Modifié dans la version 3.15: `__cached__` is no longer set.

PyObject *PyImport_ExecCodeModuleEx(const char *name, PyObject *co, const char *pathname)
  Valeur de retour : nouvelle référence. Fait partie de l' ABI stable.

  Like `PyImport_ExecCodeModule()`, but the `__file__` attribute of the module object is set to pathname if it is non-`NULL`.

  See also `PyImport_ExecCodeModuleWithPathnames()`.

PyObject *PyImport_ExecCodeModuleObject( PyObject *name, PyObject *co, PyObject *pathname, PyObject *cpathname)
  Valeur de retour : nouvelle référence. Fait partie de l' ABI stable depuis la version 3.7.

  Like `PyImport_ExecCodeModuleEx()`, but the path to any compiled file via cpathname is used appropriately when non-`NULL`. Of the three functions, this is the preferred one to use.

  Ajouté dans la version 3.3.

  Modifié dans la version 3.12: Setting `__cached__` is deprecated. See `ModuleSpec` for alternatives.

  Modifié dans la version 3.15: `__cached__` no longer set.

PyObject *PyImport_ExecCodeModuleWithPathnames(const char *name, PyObject *co, const char *pathname, const char *cpathname)
  Valeur de retour : nouvelle référence. Fait partie de l' ABI stable.

  Like `PyImport_ExecCodeModuleObject()`, but name, pathname and cpathname are UTF-8 encoded strings. Attempts are also made to figure out what the value for pathname should be from cpathname if the former is set to `NULL`.

  Ajouté dans la version 3.2.

  Modifié dans la version 3.3: Uses `imp.source_from_cache()` in calculating the source path if only the bytecode path is provided.

  Modifié dans la version 3.12: No longer uses the removed `imp` module.

long PyImport_GetMagicNumber()
  Fait partie de l' ABI stable.

  Return the magic number for Python bytecode files (a.k.a. `.pyc` file). The magic number should be present in the first four bytes of the bytecode file, in little-endian byte order. Returns `-1` on error.

  Modifié dans la version 3.3: Return value of `-1` upon failure.

const char *PyImport_GetMagicTag()
  Fait partie de l' ABI stable.

  Return the magic tag string for PEP 3147 format Python bytecode file names. Keep in mind that the value at `sys.implementation.cache_tag` is authoritative and should be used instead of this function.

  Ajouté dans la version 3.2.

PyObject *PyImport_GetModuleDict()
  Valeur de retour : référence empruntée. Fait partie de l' ABI stable.

  Return the dictionary used for the module administration (a.k.a. `sys.modules`). Note that this is a per-interpreter variable.

PyObject *PyImport_GetModule( PyObject *name)
  Valeur de retour : nouvelle référence. Fait partie de l' ABI stable depuis la version 3.8.

  Return the already imported module with the given name. If the module has not been imported yet then returns `NULL` but does not set an error. Returns `NULL` and sets an error if the lookup failed.

  Ajouté dans la version 3.7.

PyObject *PyImport_GetImporter( PyObject *path)
  Valeur de retour : nouvelle référence. Fait partie de l' ABI stable.

  Return a finder object for a `sys.path`/`pkg.__path__` item path, possibly by fetching it from the `sys.path_importer_cache` dict. If it wasn't yet cached, traverse `sys.path_hooks` until a hook is found that can handle the path item. Return `None` if no hook could; this tells our caller that the path based finder could not find a finder for this path item. Cache the result in `sys.path_importer_cache`. Return a new reference to the finder object.

int PyImport_ImportFrozenModuleObject( PyObject *name)
  Fait partie de l' ABI stable depuis la version 3.7.

  Load a frozen module named name. Return `1` for success, `0` if the module is not found, and `-1` with an exception set if the initialization failed. To access the imported module on a successful load, use `PyImport_ImportModule()`. (Note the misnomer --- this function would reload the module if it was already imported.)

  Ajouté dans la version 3.3.

  Modifié dans la version 3.4: The `__file__` attribute is no longer set on the module.

int PyImport_ImportFrozenModule(const char *name)
  Fait partie de l' ABI stable.

  Similar to `PyImport_ImportFrozenModuleObject()`, but the name is a UTF-8 encoded string instead of a Unicode object.

struct _frozen

  This is the structure type definition for frozen module descriptors, as generated by the freeze utility (see `Tools/freeze/` in the Python source distribution). Its definition, found in `Include/import.h`, is:

      struct _frozen {
          const char *name;
          const unsigned char *code;
          int size;
          bool is_package;
      };

  Modifié dans la version 3.11: The new `is_package` field indicates whether the module is a package or not. This replaces setting the `size` field to a negative value.

const struct _frozen *PyImport_FrozenModules

  This pointer is initialized to point to an array of `_frozen` records, terminated by one whose members are all `NULL` or zero. When a frozen module is imported, it is searched in this table. Third-party code could play tricks with this to provide a dynamically created collection of frozen modules.

int PyImport_AppendInittab(const char *name, PyObject *(*initfunc)(void))
  Fait partie de l' ABI stable.

  Add a single module to the existing table of built-in modules. This is a convenience wrapper around `PyImport_ExtendInittab()`, returning `-1` if the table could not be extended. The new module can be imported by the name name, and uses the function initfunc as the initialization function called on the first attempted import. This should be called before `Py_Initialize()`.

struct _inittab

  Structure describing a single entry in the list of built-in modules. Programs which embed Python may use an array of these structures in conjunction with `PyImport_ExtendInittab()` to provide additional built-in modules. The structure consists of two members:

  const char *name

    The module name, as an ASCII encoded string.

  PyObject *(*initfunc)(void)

    Initialization function for a module built into the interpreter.

int PyImport_ExtendInittab(struct _inittab *newtab)

  Add a collection of modules to the table of built-in modules. The newtab array must end with a sentinel entry which contains `NULL` for the `name` field; failure to provide the sentinel value can result in a memory fault. Returns `0` on success or `-1` if insufficient memory could be allocated to extend the internal table. In the event of failure, no modules are added to the internal table. This must be called before `Py_Initialize()`.

  If Python is initialized multiple times, `PyImport_AppendInittab()` or `PyImport_ExtendInittab()` must be called before each Python initialization.

struct _inittab *PyImport_Inittab

  The table of built-in modules used by Python initialization. Do not use this directly; use `PyImport_AppendInittab()` and `PyImport_ExtendInittab()` instead.

PyObject *PyImport_ImportModuleAttr( PyObject *mod_name, PyObject *attr_name)
  Valeur de retour : nouvelle référence.

  Import the module mod_name and get its attribute attr_name.

  Names must be Python `str` objects.

  Helper function combining `PyImport_Import()` and `PyObject_GetAttr()`. For example, it can raise `ImportError` if the module is not found, and `AttributeError` if the attribute doesn't exist.

  Ajouté dans la version 3.14.

PyObject *PyImport_ImportModuleAttrString(const char *mod_name, const char *attr_name)
  Valeur de retour : nouvelle référence.

  Similar to `PyImport_ImportModuleAttr()`, but names are UTF-8 encoded strings instead of Python `str` objects.

  Ajouté dans la version 3.14.

PyImport_LazyImportsMode PyImport_GetLazyImportsMode()

  Gets the current lazy imports mode.

  Ajouté dans la version 3.15.

PyObject *PyImport_GetLazyImportsFilter()

  Return a strong reference to the current lazy imports filter, or `NULL` if none exists. This function always succeeds.

  Ajouté dans la version 3.15.

int PyImport_SetLazyImportsMode( PyImport_LazyImportsMode mode)

  Similar to `PyImport_ImportModuleAttr()`, but names are UTF-8 encoded strings instead of Python `str` objects.

  This function always returns `0`.

  Ajouté dans la version 3.15.

int PyImport_SetLazyImportsFilter( PyObject *filter)

  Sets the current lazy imports filter. The filter should be a callable that will receive `(importing_module_name, imported_module_name, [fromlist])` when an import can potentially be lazy. The `imported_module_name` value is the resolved module name, so `lazy from .spam import eggs` passes `package.spam`. The callable must return `True` if the import should be lazy and `False` otherwise.

  Return `0` on success and `-1` with an exception set otherwise.

  Ajouté dans la version 3.15.

type PyImport_LazyImportsMode

  Enumeration of possible lazy import modes.

  enumerator PyImport_LAZY_NORMAL

    Respect the `lazy` keyword in source code. This is the default mode.

  enumerator PyImport_LAZY_ALL

    Make all imports lazy by default.

  Ajouté dans la version 3.15.

PyObject *PyImport_CreateModuleFromInitfunc( PyObject *spec, PyObject *(*initfunc)(void))

  This function is a building block that enables embedders to implement the `create_module()` step of custom static extension importers (e.g. of statically-linked extensions).

  spec must be a `ModuleSpec` object.

  initfunc must be an initialization function, the same as for `PyImport_AppendInittab()`.

  On success, create and return a module object. This module will not be initialized; call `PyModule_Exec()` to initialize it. (Custom importers should do this in their `exec_module()` method.)

  On error, return NULL with an exception set.

  Ajouté dans la version 3.15.