引入模組¶
-
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 的一部分.
This function is a deprecated alias of
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 的一部分 自 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.在 3.3 版被加入.
-
PyObject *PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level)¶
- 回傳值:新的參照。 為 穩定 ABI 的一部分.
Similar to
PyImport_ImportModuleLevelObject()
, but the name is a UTF-8 encoded string instead of a Unicode object.在 3.3 版的變更: Negative values for level are no longer accepted.
-
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__()
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)¶
- 回傳值:新的參照。 為 穩定 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 的一部分 自 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. ReturnNULL
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.在 3.3 版被加入.
-
PyObject *PyImport_AddModule(const char *name)¶
- 回傳值:借用參照。 為 穩定 ABI 的一部分.
Similar to
PyImport_AddModuleObject()
, but the name is a UTF-8 encoded string instead of a Unicode object.
-
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 functioncompile()
, load the module. Return a new reference to the module object, orNULL
with an exception set if an error occurred. name is removed fromsys.modules
in error cases, even if name was already insys.modules
on entry toPyImport_ExecCodeModule()
. Leaving incompletely initialized modules insys.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 ofSourceFileLoader
otherwise.The module's
__file__
attribute will be set to the code object'sco_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.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()
andPyImport_ExecCodeModuleWithPathnames()
.在 3.12 版的變更: The setting of
__cached__
and__loader__
is deprecated. SeeModuleSpec
for alternatives.
-
PyObject *PyImport_ExecCodeModuleEx(const char *name, PyObject *co, const char *pathname)¶
- 回傳值:新的參照。 為 穩定 ABI 的一部分.
Like
PyImport_ExecCodeModule()
, but the__file__
attribute of the module object is set to pathname if it is non-NULL
.
-
PyObject *PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname, PyObject *cpathname)¶
- 回傳值:新的參照。 為 穩定 ABI 的一部分 自 3.7 版本開始.
Like
PyImport_ExecCodeModuleEx()
, but the__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.在 3.3 版被加入.
在 3.12 版的變更: Setting
__cached__
is deprecated. SeeModuleSpec
for alternatives.
-
PyObject *PyImport_ExecCodeModuleWithPathnames(const char *name, PyObject *co, const char *pathname, const char *cpathname)¶
- 回傳值:新的參照。 為 穩定 ABI 的一部分.
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 toNULL
.在 3.2 版被加入.
在 3.3 版的變更: Uses
imp.source_from_cache()
in calculating the source path if only the bytecode path is provided.在 3.12 版的變更: 不再使用已被移除的
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
on error.在 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.在 3.2 版被加入.
-
PyObject *PyImport_GetModuleDict()¶
- 回傳值:借用參照。 為 穩定 ABI 的一部分.
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)¶
- 回傳值:新的參照。 為 穩定 ABI 的一部分 自 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. ReturnsNULL
and sets an error if the lookup failed.在 3.7 版被加入.
-
PyObject *PyImport_GetImporter(PyObject *path)¶
- 回傳值:新的參照。 為 穩定 ABI 的一部分.
Return a finder object for a
sys.path
/pkg.__path__
item path, possibly by fetching it from thesys.path_importer_cache
dict. If it wasn't yet cached, traversesys.path_hooks
until a hook is found that can handle the path item. ReturnNone
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 insys.path_importer_cache
. Return a new reference to the finder object.
-
int PyImport_ImportFrozenModuleObject(PyObject *name)¶
- 為 穩定 ABI 的一部分 自 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, usePyImport_ImportModule()
. (Note the misnomer --- this function would reload the module if it was already imported.)在 3.3 版被加入.
在 3.4 版的變更: The
__file__
attribute is no longer set on the module.
-
int PyImport_ImportFrozenModule(const char *name)¶
- 為 穩定 ABI 的一部分.
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 inInclude/import.h
, is:struct _frozen { const char *name; const unsigned char *code; int size; bool is_package; };
在 3.11 版的變更: The new
is_package
field indicates whether the module is a package or not. This replaces setting thesize
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 allNULL
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))¶
- 為 穩定 ABI 的一部分.
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 beforePy_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.
-
const char *name¶
-
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 thename
field; failure to provide the sentinel value can result in a memory fault. Returns0
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 beforePy_Initialize()
.If Python is initialized multiple times,
PyImport_AppendInittab()
orPyImport_ExtendInittab()
must be called before each Python initialization.