*PyImport_ImportModule(constchar*name)
Return value: New reference. Part of the
.This is a wrapper around
which takes a constchar* as an argument instead of a
*.
*PyImport_ImportModuleEx(constchar*name,
*globals,
*locals,
*fromlist)
Return value: New reference.Import a module. This is best described by referring to the built-in Python function
.
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
, 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_ImportModuleLevelObject(
*name,
*globals,
*locals,
*fromlist, intlevel)
Return value: New reference. Part of the
since version 3.7.Import a module. This is best described by referring to the built-in Python function
, 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
, the return value when a submodule of a package was requested is normally the top-level package, unless a non-empty fromlist was given.
Added in version 3.3.
*PyImport_ImportModuleLevel(constchar*name,
*globals,
*locals,
*fromlist, intlevel)
Return value: New reference. Part of the
.Similar to
PyImport_ImportModuleLevelObject()
, but the name is a UTF-8 encoded string instead of a Unicode object.
Changed in version 3.3: Negative values for level are no longer accepted.
*PyImport_Import(
*name)
Return value: New reference. Part of the
.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
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.
*PyImport_ReloadModule(
*m)
Return value: New reference. Part of the
.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).
*PyImport_AddModuleRef(constchar*name)
Return value: New reference. Part of the
since 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
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
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.
Added in version 3.13.
*PyImport_AddModuleObject(
*name)
Return value: Borrowed reference. Part of the
since version 3.7.Similar to
, but return a
and name is a Python
object.
Added in version 3.3.
*PyImport_AddModule(constchar*name)
Return value: Borrowed reference. Part of the
.Similar to
, but return a
.
*PyImport_ExecCodeModule(constchar*name,
*co)
Return value: New reference. Part of the
.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
, 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
in error cases, even if name was already in sys.modules on entry to
. 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
and
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
otherwise.
The module’s
attribute will be set to the code object’s
.
This function will reload the module if it was already imported. See
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
and
PyImport_ExecCodeModuleWithPathnames()
.
Changed in version 3.12: The setting of __cached__ and
is deprecated. See
for alternatives.
Changed in version 3.15: The __cached__ attribute is no longer set.
*PyImport_ExecCodeModuleEx(constchar*name,
*co, constchar*pathname)
Return value: New reference. Part of the
.Like
, but the
attribute of the module object is set to pathname if it is non-NULL.
See also
PyImport_ExecCodeModuleWithPathnames()
.
*PyImport_ExecCodeModuleObject(
*name,
*co,
*pathname,
*cpathname)
Return value: New reference. Part of the
since version 3.7.Like
, 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.
Added in version 3.3.
Changed in version 3.12: Setting __cached__ is deprecated. See
for alternatives.
Changed in version 3.15: The __cached__ attribute no longer set.
*PyImport_ExecCodeModuleWithPathnames(constchar*name,
*co, constchar*pathname, constchar*cpathname)
Return value: New reference. Part of the
.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.
Added in version 3.2.
Changed in version 3.3: Uses imp.source_from_cache() in calculating the source path if only the bytecode path is provided.
Changed in version 3.12: No longer uses the removed imp module.
longPyImport_GetMagicNumber()
Part of the
.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.
Changed in version 3.3: Return value of -1 upon failure.
constchar*PyImport_GetMagicTag()
Part of the
.Return the magic tag string for
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.
Added in version 3.2.
*PyImport_GetModuleDict()
Return value: Borrowed reference. Part of the
.Return the dictionary used for the module administration (a.k.a. sys.modules). Note that this is a per-interpreter variable.
*PyImport_GetModule(
*name)
Return value: New reference. Part of the
since 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.
Added in version 3.7.
*PyImport_GetImporter(
*path)
Return value: New reference. Part of the
.Return a finder object for a
/pkg.__path__ item path, possibly by fetching it from the
dict. If it wasn’t yet cached, traverse
until a hook is found that can handle the path item. Return None if no hook could; this tells our caller that the
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.
intPyImport_ImportFrozenModuleObject(
*name)
Part of the
since 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
. (Note the misnomer — this function would reload the module if it was already imported.)
Added in version 3.3.
Changed in version 3.4: The __file__ attribute is no longer set on the module.
intPyImport_ImportFrozenModule(constchar*name)
Part of the
.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{constchar*name;constunsignedchar*code;intsize;boolis_package;};Changed in 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.
conststruct
*PyImport_FrozenModules
This pointer is initialized to point to an array of
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.
intPyImport_AppendInittab(constchar*name,
*(*initfunc)(void))
Part of the
.Add a single module to the existing table of built-in modules. This is a convenience wrapper around
, 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
.
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
to provide additional built-in modules. The structure consists of two members:
constchar*name
The module name, as an ASCII encoded string.
*(*initfunc)(void)
Initialization function for a module built into the interpreter.
Note that the inittab uses “PyInit”
; there is currently no way to include “PyModExport_”
.
intPyImport_ExtendInittab(struct
*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
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
.
If Python is initialized multiple times,
or
must be called before each Python initialization.
struct
*PyImport_Inittab
The table of built-in modules used by Python initialization. Do not use this directly; use
and
instead.
*PyImport_ImportModuleAttr(
*mod_name,
*attr_name)
Return value: New reference.Import the module mod_name and get its attribute attr_name.
Names must be Python
objects.
Helper function combining
and
. For example, it can raise
if the module is not found, and
if the attribute doesn’t exist.
Added in version 3.14.
*PyImport_ImportModuleAttrString(constchar*mod_name, constchar*attr_name)
Return value: New reference.Similar to
, but names are UTF-8 encoded strings instead of Python
objects.
Added in version 3.14.
PyImport_GetLazyImportsMode()
Gets the current lazy imports mode.
Added in version 3.15.
*PyImport_GetLazyImportsFilter()
Return a
to the current lazy imports filter, or NULL if none exists. This function always succeeds.
Added in version 3.15.
intPyImport_SetLazyImportsMode(
mode)
Similar to
, but names are UTF-8 encoded strings instead of Python
objects.
This function always returns 0.
Added in version 3.15.
intPyImport_SetLazyImportsFilter(
*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 lazyfrom.spamimporteggs 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.
Added in version 3.15.
typePyImport_LazyImportsMode
Enumeration of possible lazy import modes.
enumeratorPyImport_LAZY_NORMAL
Respect the lazy keyword in source code. This is the default mode.
enumeratorPyImport_LAZY_ALL
Make all imports lazy by default.
Added in version 3.15.
*PyImport_CreateModuleFromInitfunc(
*spec,
*(*initfunc)(void))
This function is a building block that enables embedders to implement the
step of custom static extension importers (e.g. of statically-linked extensions).
spec must be a
object.
initfunc must be an
, the same as for
.
On success, create and return a module object. This module will not be initialized; call
to initialize it. (Custom importers should do this in their
method.)
On error, return NULL with an exception set.
Added in version 3.15.