引入模組¶
- PyObject*PyImport_ImportModule(constchar*name)¶
- 回傳值:新的參照。 為穩定 ABI 的一部分.
This is a wrapper around
PyImport_Import()
which takes aconstchar* as an argument instead of aPyObject*.
- PyObject*PyImport_ImportModuleNoBlock(constchar*name)¶
- 回傳值:新的參照。 為穩定 ABI 的一部分.
This function is a deprecated alias of
PyImport_ImportModule()
.在 3.3 版的變更:This function used to fail immediately when the import lock was heldby another thread. In Python 3.3 though, the locking scheme switchedto per-module locks for most purposes, so this function's specialbehaviour isn't needed anymore.
Deprecated since version 3.13, will be removed in version 3.15:請改用
PyImport_ImportModule()
。
- PyObject*PyImport_ImportModuleEx(constchar*name,PyObject*globals,PyObject*locals,PyObject*fromlist)¶
- 回傳值:新的參照。
Import a module. This is best described by referring to the built-in Pythonfunction
__import__()
.The return value is a new reference to the imported module or top-levelpackage, or
NULL
with an exception set on failure. Like for__import__()
, the return value when a submodule of a package wasrequested is normally the top-level package, unless a non-emptyfromlistwas given.Failing imports remove incomplete module objects, like with
PyImport_ImportModule()
.
- PyObject*PyImport_ImportModuleLevelObject(PyObject*name,PyObject*globals,PyObject*locals,PyObject*fromlist,intlevel)¶
- 回傳值:新的參照。 為穩定 ABI 的一部分 自 3.7 版本開始.
Import a module. This is best described by referring to the built-in Pythonfunction
__import__()
, as the standard__import__()
function callsthis 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 thetop-level package, unless a non-emptyfromlist was given.在 3.3 版被加入.
- PyObject*PyImport_ImportModuleLevel(constchar*name,PyObject*globals,PyObject*locals,PyObject*fromlist,intlevel)¶
- 回傳值:新的參照。 為穩定 ABI 的一部分.
Similar to
PyImport_ImportModuleLevelObject()
, but the name is aUTF-8 encoded string instead of a Unicode object.在 3.3 版的變更:Negative values forlevel are no longer accepted.
- PyObject*PyImport_Import(PyObject*name)¶
- 回傳值:新的參照。 為穩定 ABI 的一部分.
This is a higher-level interface that calls the current "import hookfunction" (with an explicitlevel of 0, meaning absolute import). Itinvokes the
__import__()
function from the__builtins__
of thecurrent globals. This means that the import is done using whatever importhooks 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
withan exception set on failure (the module still exists in this case).
- PyObject*PyImport_AddModuleRef(constchar*name)¶
- 回傳值:新的參照。 為穩定 ABI 的一部分 自 3.13 版本開始.
Return the module object corresponding to a module name.
Thename argument may be of the form
package.module
. First check themodules dictionary if there's one there, and if not, create a new one andinsert it in the modules dictionary.Return astrong reference to the module on success. Return
NULL
with an exception set on failure.The module namename is decoded from UTF-8.
This function does not load or import the module; if the module wasn'talready 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 forname are not created ifnot already present.在 3.13 版被加入.
- PyObject*PyImport_AddModuleObject(PyObject*name)¶
- 回傳值:借用參照。 為穩定 ABI 的一部分 自 3.7 版本開始.
Similar to
PyImport_AddModuleRef()
, but return aborrowedreference andname is a Pythonstr
object.在 3.3 版被加入.
- PyObject*PyImport_AddModule(constchar*name)¶
- 回傳值:借用參照。 為穩定 ABI 的一部分.
Similar to
PyImport_AddModuleRef()
, but return aborrowedreference.
- PyObject*PyImport_ExecCodeModule(constchar*name,PyObject*co)¶
- 回傳值:新的參照。 為穩定 ABI 的一部分.
Given a module name (possibly of the form
package.module
) and a code objectread 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.nameis removed fromsys.modules
in error cases, even ifname was alreadyinsys.modules
on entry toPyImport_ExecCodeModule()
. Leavingincompletely initialized modules insys.modules
is dangerous, as imports ofsuch modules have no way to know that the module object is an unknown (andprobably damaged with respect to the module author's intents) state.The module's
__spec__
and__loader__
will beset, if not set already, with the appropriate values. The spec's loaderwill be set to the module's__loader__
(if set) and to an instanceofSourceFileLoader
otherwise.The module's
__file__
attribute will be set to the codeobject'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.Ifname points to a dotted name of the form
package.module
, any packagestructures 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
foralternatives.
- PyObject*PyImport_ExecCodeModuleEx(constchar*name,PyObject*co,constchar*pathname)¶
- 回傳值:新的參照。 為穩定 ABI 的一部分.
Like
PyImport_ExecCodeModule()
, but the__file__
attribute of the module object is set topathname 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 tocpathname if it isnon-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(constchar*name,PyObject*co,constchar*pathname,constchar*cpathname)¶
- 回傳值:新的參照。 為穩定 ABI 的一部分.
Like
PyImport_ExecCodeModuleObject()
, butname,pathname andcpathname are UTF-8 encoded strings. Attempts are also made to figure outwhat the value forpathname should be fromcpathname if the former isset toNULL
.在 3.2 版被加入.
在 3.3 版的變更:Uses
imp.source_from_cache()
in calculating the source path ifonly the bytecode path is provided.在 3.12 版的變更:不再使用已被移除的
imp
模組。
- longPyImport_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 bytecodefile, in little-endian byte order. Returns-1
on error.在 3.3 版的變更:當失敗時回傳
-1
。
- constchar*PyImport_GetMagicTag()¶
- 為穩定 ABI 的一部分.
Return the magic tag string forPEP 3147 format Python bytecode filenames. Keep in mind that the value at
sys.implementation.cache_tag
isauthoritative 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 themodule has not been imported yet then returns
NULL
but does not setan 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__
itempath, possibly by fetching it from thesys.path_importer_cache
dict. If it wasn't yet cached, traversesys.path_hooks
until a hookis found that can handle the path item. ReturnNone
if no hook could;this tells our caller that thepath based finder could not find afinder for this path item. Cache the result insys.path_importer_cache
.Return a new reference to the finder object.
- intPyImport_ImportFrozenModuleObject(PyObject*name)¶
- 為穩定 ABI 的一部分 自 3.7 版本開始.
Load a frozen module namedname. Return
1
for success,0
if themodule is not found, and-1
with an exception set if the initializationfailed. To access the imported module on a successful load, usePyImport_ImportModule()
. (Note the misnomer --- this function wouldreload the module if it was already imported.)在 3.3 版被加入.
在 3.4 版的變更:The
__file__
attribute is no longer set on the module.
- intPyImport_ImportFrozenModule(constchar*name)¶
- 為穩定 ABI 的一部分.
Similar to
PyImport_ImportFrozenModuleObject()
, but the name is aUTF-8 encoded string instead of a Unicode object.
- struct_frozen¶
This is the structure type definition for frozen module descriptors, asgenerated by thefreeze utility (see
Tools/freeze/
in thePython source distribution). Its definition, found inInclude/import.h
,is:struct_frozen{constchar*name;constunsignedchar*code;intsize;boolis_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.
- conststruct_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 frozenmodule is imported, it is searched in this table. Third-party code could playtricks with this to provide a dynamically created collection of frozen modules.
- intPyImport_AppendInittab(constchar*name,PyObject*(*initfunc)(void))¶
- 為穩定 ABI 的一部分.
Add a single module to the existing table of built-in modules. This is aconvenience wrapper around
PyImport_ExtendInittab()
, returning-1
ifthe table could not be extended. The new module can be imported by the namename, and uses the functioninitfunc as the initialization function calledon 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 whichembed 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:- constchar*name¶
The module name, as an ASCII encoded string.
- constchar*name¶
- intPyImport_ExtendInittab(struct_inittab*newtab)¶
Add a collection of modules to the table of built-in modules. Thenewtabarray 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 toextend the internal table. In the event of failure, no modules are added to theinternal table. This must be called beforePy_Initialize()
.If Python is initialized multiple times,
PyImport_AppendInittab()
orPyImport_ExtendInittab()
must be called before each Pythoninitialization.