导入模块

PyObject * PyImport_ImportModule ( const char * name )
返回值:新引用。 属于 稳定 ABI (应用程序二进制接口) .

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

PyObject * PyImport_ImportModuleNoBlock ( const char * name )
返回值:新引用。 属于 稳定 ABI (应用程序二进制接口) .

此函数是弃用别名化的 PyImport_ImportModule() .

3.3 版改变: This function used to fail immediately when the import lock was held by another thread. In Python 3.3 though, the locking scheme switched to per-module locks for most purposes, so this function’s special behaviour isn’t needed anymore.

PyObject * PyImport_ImportModuleEx ( const char * name , PyObject * globals , PyObject * locals , PyObject * fromlist )
返回值:新引用。

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 )
返回值:新引用。 属于 稳定 ABI (应用程序二进制接口) since 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.

Added in version 3.3.

PyObject * PyImport_ImportModuleLevel ( const char * name , PyObject * globals , PyObject * locals , PyObject * fromlist , int level )
返回值:新引用。 属于 稳定 ABI (应用程序二进制接口) .

类似于 PyImport_ImportModuleLevelObject() ,但名称是 UTF-8 编码字符串,而不是 Unicode 对象。

3.3 版改变: 负值 level 不再接受。

PyObject * PyImport_Import ( PyObject * name )
返回值:新引用。 属于 稳定 ABI (应用程序二进制接口) .

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__() 函数从 __builtins__ of the current globals. This means that the import is done using whatever import hooks are installed in the current environment.

此函数始终使用绝对导入。

PyObject * PyImport_ReloadModule ( PyObject * m )
返回值:新引用。 属于 稳定 ABI (应用程序二进制接口) .

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_AddModuleObject ( PyObject * name )
返回值:借位引用。 属于 稳定 ABI (应用程序二进制接口) since version 3.7.

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 NULL with an exception set on failure.

注意

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.

Added in version 3.3.

PyObject * PyImport_AddModule ( const char * name )
返回值:借位引用。 属于 稳定 ABI (应用程序二进制接口) .

类似于 PyImport_AddModuleObject() ,但名称是 UTF-8 编码字符串,而不是 Unicode 对象。

PyObject * PyImport_ExecCodeModule ( const char * name , PyObject * co )
返回值:新引用。 属于 稳定 ABI (应用程序二进制接口) .

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.

模块的 __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 否则。

模块的 __file__ attribute will be set to the code object’s co_filename . If applicable, __cached__ will also be set.

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

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

另请参阅 PyImport_ExecCodeModuleEx() and PyImport_ExecCodeModuleWithPathnames() .

Changed in version 3.12: The setting of __cached__ and __loader__ is deprecated. See ModuleSpec for alternatives.

PyObject * PyImport_ExecCodeModuleEx ( const char * name , PyObject * co , const char * pathname )
返回值:新引用。 属于 稳定 ABI (应用程序二进制接口) .

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

另请参阅 PyImport_ExecCodeModuleWithPathnames() .

PyObject * PyImport_ExecCodeModuleObject ( PyObject * name , PyObject * co , PyObject * pathname , PyObject * cpathname )
返回值:新引用。 属于 稳定 ABI (应用程序二进制接口) since version 3.7.

PyImport_ExecCodeModuleEx() ,但 __cached__ attribute of the module object is set to cpathname if it is non- NULL . Of the three functions, this is the preferred one to use.

Added in version 3.3.

Changed in version 3.12: 设置 __cached__ is deprecated. See ModuleSpec for alternatives.

PyObject * PyImport_ExecCodeModuleWithPathnames ( const char * name , PyObject * co , const char * pathname , const char * cpathname )
返回值:新引用。 属于 稳定 ABI (应用程序二进制接口) .

PyImport_ExecCodeModuleObject() ,但 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.

3.3 版改变: 使用 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 模块。

long PyImport_GetMagicNumber ( )
属于 稳定 ABI (应用程序二进制接口) .

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 当出错时。

3.3 版改变: 返回值 -1 当故障时。

const char * PyImport_GetMagicTag ( )
属于 稳定 ABI (应用程序二进制接口) .

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.

Added in version 3.2.

PyObject * PyImport_GetModuleDict ( )
返回值:借位引用。 属于 稳定 ABI (应用程序二进制接口) .

返回用于管理模块的字典 (也称为 sys.modules )。注意,这是每解释器变量。

PyObject * PyImport_GetModule ( PyObject * name )
返回值:新引用。 属于 稳定 ABI (应用程序二进制接口) 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.

PyObject * PyImport_GetImporter ( PyObject * path )
返回值:新引用。 属于 稳定 ABI (应用程序二进制接口) .

返回查找器对象对于 sys.path / pkg.__path__ item path ,可能通过抓取它从 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 基于路径的查找器 could not find a finder for this path item. Cache the result in sys.path_importer_cache 。返回查找器对象的新引用。

int PyImport_ImportFrozenModuleObject ( PyObject * name )
属于 稳定 ABI (应用程序二进制接口) since version 3.7.

加载的冻结模块名为 name 。返回 1 对于成功, 0 若找不到模块,和 -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.)

Added in version 3.3.

3.4 版改变: The __file__ 属性不再在模块中设置。

int PyImport_ImportFrozenModule ( const char * name )
属于 稳定 ABI (应用程序二进制接口) .

类似于 PyImport_ImportFrozenModuleObject() ,但名称是 UTF-8 编码字符串,而不是 Unicode 对象。

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;
};
							

3.11 版改变: 新的 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

此指针被初始化成指向数组为 _frozen 记录,被终止当其每一成员都是 NULL 或 0。当冻结模块被导入时,在此表中搜索它。第 3 方代码可以按此玩点技巧,以提供动态创建的冻结模块的集合。

int PyImport_AppendInittab ( const char * name , PyObject * ( * initfunc ) ( void ) )
属于 稳定 ABI (应用程序二进制接口) .

将单个模块添加到现有内置模块表。这是方便包裹器围绕 PyImport_ExtendInittab() ,返回 -1 若表无法被扩展。可以导入新模块通过名称 name ,和使用函数 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 )

将模块集合添加到内置模块表。 newtab array must end with a sentinel entry which contains NULL name field; failure to provide the sentinel value can result in a memory fault. Returns 0 当成功时或 -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.

上一话题

操作系统实用工具

下一话题

数据编组支持

本页