importlib --- import 的实现

在 3.1 版新加入.

原始碼：Lib/importlib/__init__.py

簡介

importlib 包具有三重目标。

一是在 Python 源代码中提供 import 语句的实现（并且因此而扩展 __import__() 函数）。 这提供了一个可移植到任何 Python 解释器的 import 实现。 与使用 Python 以外的编程语言实现的方式相比这一实现也更易于理解。

第二个目的是实现 import 的部分被公开在这个包中，使得用户更容易创建他们自己的自定义对象 (通常被称为 importer) 来参与到导入过程中。

三，这个包也包含了对外公开用于管理 Python 包的各个方面的附加功能的模块:

也參考

import 语句

import 语句的语言参考

包规格说明

包的初始规范。自从编写这个文档开始，一些语义已经发生改变了（比如基于 sys.modules 中 None 的重定向）。

__import__() 函数

import 语句是这个函数的语法糖。

sys.path 模块搜索路径的初始化

sys.path 的初始化。

PEP 235

在忽略大小写的平台上进行导入

PEP 263

定义 Python 源代码编码

PEP 302

新导入钩子

PEP 328

导入：多行和绝对/相对

PEP 366

主模块显式相对导入

PEP 420

隐式命名空间包

PEP 451

导入系统的一个模块规范类型

PEP 488

消除PYO文件

PEP 489

多阶段扩展模块初始化

PEP 552

确定性的 pyc 文件

PEP 3120

使用 UTF-8 作为默认的源编码

PEP 3147

PYC 仓库目录

函式

importlib.__import__(name, globals=None, locals=None, fromlist=(), level=0)

内置 __import__() 函数的实现。

備註

程序式地导入模块应该使用 import_module() 而不是这个函数。

importlib.import_module(name, package=None)

导入一个模块。 参数 name 指定了以绝对或相对导入方式导入什么模块 (比如要么像这样 pkg.mod 或者这样 ..mod)。 如果参数 name 使用相对导入的方式来指定，那么 package 参数必须设置为那个包名，这个包名作为解析这个包名的锚点 (比如 import_module('..mod', 'pkg.subpkg') 将会导入 pkg.mod)。

import_module() 函数是一个对 importlib.__import__() 进行简化的包装器。 这意味着该函数的所有语义都来自于 importlib.__import__()。 这两个函数之间最重要的不同点在于 import_module() 返回指定的包或模块 (例如 pkg.mod)，而 __import__() 返回最高层级的包或模块 (例如 pkg)。

如果动态导入一个自解释器开始执行以来被创建的模块（即创建了一个 Python 源代码文件），为了让导入系统知道这个新模块，可能需要调用 invalidate_caches()。

在 3.3 版的變更: 父包会被自动导入。

importlib.find_loader(name, path=None)

Find the loader for a module, optionally within the specified path. If the module is in sys.modules, then sys.modules[name].__loader__ is returned (unless the loader would be None or is not set, in which case ValueError is raised). Otherwise a search using sys.meta_path is done. None is returned if no loader is found.

A dotted name does not have its parents implicitly imported as that requires loading them and that may not be desired. To properly import a submodule you will need to import all parent packages of the submodule and use the correct argument to path.

在 3.3 版新加入.

在 3.4 版的變更: If __loader__ is not set, raise ValueError, just like when the attribute is set to None.

在 3.4 版之後被棄用: 使用 importlib.util.find_spec() 来代替。

importlib.invalidate_caches()

使查找器存储在 sys.meta_path 中的内部缓存无效。如果一个查找器实现了 invalidate_caches()，那么它会被调用来执行那个无效过程。 如果创建/安装任何模块，同时正在运行的程序是为了保证所有的查找器知道新模块的存在，那么应该调用这个函数。

在 3.3 版新加入.

在 3.10 版的變更: 当注意到相同命名空间已被导入之后在不同 sys.path 位置中创建/安装的命名空间包。

importlib.reload(module)

重新加载之前导入的 module。 那个参数必须是一个模块对象，所以它之前必须已经成功导入了。 这在你已经使用外部编辑器编辑过了那个模块的源代码文件并且想在退出 Python 解释器之前试验这个新版本的模块的时候将很适用。 函数的返回值是那个模块对象（如果重新导入导致一个不同的对象放置在 sys.modules 中，那么那个模块对象是有可能会不同）。

当执行 reload() 的时候：

  • Python 模块的代码会被重新编译并且那个模块级的代码被重新执行，通过重新使用一开始加载那个模块的 loader，定义一个新的绑定在那个模块字典中的名称的对象集合。扩展模块的 init 函数不会被调用第二次。

  • 与Python中的所有的其它对象一样，旧的对象只有在它们的引用计数为0之后才会被回收。

  • 模块命名空间中的名称重新指向任何新的或更改后的对象。

  • 其他旧对象的引用（例如那个模块的外部名称）不会被重新绑定到引用的新对象的，并且如果有需要，必须在出现的每个命名空间中进行更新。

有一些其他注意事项：

当一个模块被重新加载的时候，它的字典（包含了那个模块的全区变量）会被保留。名称的重新定义会覆盖旧的定义，所以通常来说这不是问题。如果一个新模块没有定义在旧版本模块中定义的名称，则将保留旧版本中的定义。这一特性可用于作为那个模块的优点，如果它维护一个全局表或者对象的缓存 —— 使用 try 语句，就可以测试表的存在并且跳过它的初始化，如果有需要的话:

try:
    cache
except NameError:
    cache = {}

重新加载内置的或者动态加载模块，通常来说不是很有用处。不推荐重新加载"sys，__main__，builtins 和其它关键模块。在很多例子中，扩展模块并不是设计为不止一次的初始化，并且当重新加载时，可能会以任意方式失败。

如果一个模块使用 from ... import ... 导入的对象来自另外一个模块，给其它模块调用 reload() 不会重新定义来自这个模块的对象 —— 解决这个问题的一种方式是重新执行 from 语句，另一种方式是使用 import 和限定名称(module.name)来代替。

如果一个模块创建一个类的实例，重新加载定义那个类的模块不影响那些实例的方法定义———它们继续使用旧类中的定义。对于子类来说同样是正确的。

在 3.4 版新加入.

在 3.7 版的變更: 如果重新加载的模块缺少 ModuleSpec ，则会触发 ModuleNotFoundError 。

importlib.abc —— 关于导入的抽象基类

原始碼：Lib/importlib/abc.py

importlib.abc 模块包含了 import 使用到的所有核心抽象基类。在实现核心的 ABCs 中，核心抽象基类的一些子类也提供了帮助。

ABC 类的层次结构：

object
 +-- Finder (deprecated)
 +-- MetaPathFinder
 +-- PathEntryFinder
 +-- Loader
      +-- ResourceLoader --------+
      +-- InspectLoader          |
           +-- ExecutionLoader --+
                                 +-- FileLoader
                                 +-- SourceLoader
class importlib.abc.Finder

An abstract base class representing a finder.

在 3.3 版之後被棄用: Use MetaPathFinder or PathEntryFinder instead.

abstractmethod find_module(fullname, path=None)

An abstract method for finding a loader for the specified module. Originally specified in PEP 302, this method was meant for use in sys.meta_path and in the path-based import subsystem.

在 3.4 版的變更: Returns None when called instead of raising NotImplementedError.

在 3.10 版之後被棄用: Implement MetaPathFinder.find_spec() or PathEntryFinder.find_spec() instead.

class importlib.abc.MetaPathFinder

一个代表 meta path finder 的抽象基类。

在 3.3 版新加入.

在 3.10 版的變更: 不再是 Finder 的子类。

find_spec(fullname, path, target=None)

一个抽象方法，用于查找指定模块的 spec 。若是顶层导入，path 将为 None。 否则就是查找子包或模块，path 将是父级包的 __path__ 值。找不到则会返回 None。传入的 target 是一个模块对象，查找器可以用来对返回的规格进行更有依据的猜测。在实现具体的 MetaPathFinders 代码时，可能会用到 importlib.util.spec_from_loader() 。

在 3.4 版新加入.

find_module(fullname, path)

A legacy method for finding a loader for the specified module. If this is a top-level import, path will be None. Otherwise, this is a search for a subpackage or module and path will be the value of __path__ from the parent package. If a loader cannot be found, None is returned.

If find_spec() is defined, backwards-compatible functionality is provided.

在 3.4 版的變更: Returns None when called instead of raising NotImplementedError. Can use find_spec() to provide functionality.

在 3.4 版之後被棄用: 使用 find_spec() 代替。

invalidate_caches()

当被调用的时候，一个可选的方法应该将查找器使用的任何内部缓存进行无效。将在 sys.meta_path 上的所有查找器的缓存进行无效的时候，这个函数被 importlib.invalidate_caches() 所使用。

在 3.4 版的變更: 当被调用时将返回 None 而不是 NotImplemented。

class importlib.abc.PathEntryFinder

一个抽象基类，代表 path entry finder。虽然与 MetaPathFinder 有些相似之处，但 PathEntryFinder 仅用于 importlib.machinery.PathFinder 提供的基于路径的导入子系统中。

在 3.3 版新加入.

在 3.10 版的變更: 不再是 Finder 的子类。

find_spec(fullname, target=None)

一个抽象方法，用于查找指定模块的 spec。搜索器将只在指定的 path entry 内搜索该模块。找不到则会返回 None。在实现具体的 PathEntryFinders 代码时，可能会用到 importlib.util.spec_from_loader() 。

在 3.4 版新加入.

find_loader(fullname)

A legacy method for finding a loader for the specified module. Returns a 2-tuple of (loader, portion) where portion is a sequence of file system locations contributing to part of a namespace package. The loader may be None while specifying portion to signify the contribution of the file system locations to a namespace package. An empty list can be used for portion to signify the loader is not part of a namespace package. If loader is None and portion is the empty list then no loader or location for a namespace package were found (i.e. failure to find anything for the module).

If find_spec() is defined then backwards-compatible functionality is provided.

在 3.4 版的變更: Returns (None, []) instead of raising NotImplementedError. Uses find_spec() when available to provide functionality.

在 3.4 版之後被棄用: 使用 find_spec() 代替。

find_module(fullname)

A concrete implementation of Finder.find_module() which is equivalent to self.find_loader(fullname)[0].

在 3.4 版之後被棄用: 使用 find_spec() 代替。

invalidate_caches()

可选方法，调用后应让查找器用到的所有内部缓存失效。要让所有缓存的查找器的缓存无效时，可供 importlib.machinery.PathFinder.invalidate_caches() 调用。

class importlib.abc.Loader

loader 的抽象基类。 关于一个加载器的实际定义请查看 PEP 302。

想要支持资源读取的加载器应当实现 importlib.resources.abc.ResourceReader 所规定的 get_resource_reader() 方法。

在 3.7 版的變更: 引入了可选的 get_resource_reader() 方法。

create_module(spec)

当导入一个模块的时候，一个返回将要使用的那个模块对象的方法。这个方法可能返回 None ，这暗示着应该发生默认的模块创建语义。"

在 3.4 版新加入.

在 3.6 版的變更: 当 exec_module() 已定义时此方法将不再是可选项。

exec_module(module)

当一个模块被导入或重新加载时在自己的命名空间中执行该模块的的抽象方法。 该模块在 exec_module() 被调用时应该已经被初始化了。 当此方法存在时，必须要定义 create_module()。

在 3.4 版新加入.

在 3.6 版的變更: create_module() 也必須被定義。

load_module(fullname)

用于加载模块的传统方法。 如果模块无法被导入，则会引发 ImportError，在其他情况下将返回被加载的模块。

If the requested module already exists in sys.modules, that module should be used and reloaded. Otherwise the loader should create a new module and insert it into sys.modules before any loading begins, to prevent recursion from the import. If the loader inserted a module and the load fails, it must be removed by the loader from sys.modules; modules already in sys.modules before the loader began execution should be left alone (see importlib.util.module_for_loader()).

加载器应当在模块上设置几个属性（请注意在模块被重新加载时这些属性有几个可能发生改变）:

  • __name__

    模块的完整限定名称。 对于被执行的模块来说是 '__main__'。

  • __file__

    被 loader 用于加载指定模块的位置。 例如，对于从一个 .py 文件加载的模块来说即文件名。 这不一定会在所有模块上设置（例如内置模块就不会设置）。

  • __cached__

    模块代码的编译版本的文件名。 这不一定会在所有模块上设置（例如内置模块就不会设置）。

  • __path__

    用于查找指定包的子模块的位置列表。 在大多数时候这将为单个目录。 导入系统会以与 sys.path 相同但专门针对指定包的方式将此属性传给 __import__() 和查找器。 这不会在非包模块上设置因此它可以被用作确定模块是否为包的指示器。

  • __package__

    指定模块所在包的完整限定名称（或者对于最高层级模块来说则为空字符串）。 如果模块是包则它将与 __name__ 相同。

  • __loader__

    用于加载模块的 loader。

当 exec_module() 可用的时候，那么则提供了向后兼容的功能。

在 3.4 版的變更: 当被调用时将引发 ImportError 而不是 NotImplementedError。 在 exec_module() 可用时提供的功能。

在 3.4 版之後被棄用: 用于加载模块的推荐 API 是 exec_module() (和 create_module())。 加载器应该实现它而不是 load_module()。 当实现了 exec_module() 时导入机制将会承担 load_module() 的所有其他责任。

module_repr(module)

A legacy method which when implemented calculates and returns the given module's representation, as a string. The module type's default __repr__() will use the result of this method as appropriate.

在 3.3 版新加入.

在 3.4 版的變更: Made optional instead of an abstractmethod.

在 3.4 版之後被棄用: The import machinery now takes care of this automatically.

class importlib.abc.ResourceLoader

一个 loader 的抽象基类，它实现了可选的 PEP 302 协议用于从存储后端加载任意资源。

在 3.7 版之後被棄用: 这个 ABC 已被弃用并转为通过 importlib.resources.abc.ResourceReader 来支持资源加载。

abstractmethod get_data(path)

一个用于返回位于 path 的字节数据的抽象方法。有一个允许存储任意数据的类文件存储后端的加载器能够实现这个抽象方法来直接访问这些被存储的数据。如果不能够找到 path，则会引发 OSError 异常。path 被希望使用一个模块的 __file 属性或来自一个包的 __path__ 来构建。

在 3.4 版的變更: 引发 OSError 异常而不是 NotImplementedError 异常。

class importlib.abc.InspectLoader

一个实现加载器检查模块可选的 PEP 302 协议的 loader 的抽象基类。

get_code(fullname)

返回一个模块的代码对象，或如果模块没有一个代码对象（例如，对于内置的模块来说，这会是这种情况），则为 None。 如果加载器不能找到请求的模块，则引发 ImportError 异常。

備註

当这个方法有一个默认的实现的时候，出于性能方面的考虑，如果有可能的话，建议覆盖它。

在 3.4 版的變更: 不再抽象并且提供一个具体的实现。

abstractmethod get_source(fullname)

一个返回模块源的抽象方法。使用 universal newlines 作为文本字符串被返回，将所有可识别行分割符翻译成 '\n' 字符。 如果没有可用的源（例如，一个内置模块），则返回 None。 如果加载器不能找到指定的模块，则引发 ImportError 异常。

在 3.4 版的變更: 引发 ImportError 而不是 NotImplementedError。

is_package(fullname)

可选方法，如果模块为包，则返回 True，否则返回 False。 如果 loader 找不到模块，则会触发 ImportError。

在 3.4 版的變更: 引发 ImportError 而不是 NotImplementedError。

static source_to_code(data, path='<string>')

创建一个来自Python源码的代码对象。

参数 data 可以是任意 compile() 函数支持的类型（例如字符串或字节串）。 参数 path 应该是源代码来源的路径，这可能是一个抽象概念（例如位于一个 zip 文件中）。

在有后续代码对象的情况下，可以在一个模块中通过运行 exec(code, module.__dict__) 来执行它。

在 3.4 版新加入.

在 3.5 版的變更: 使得这个方法变成静态的。

exec_module(module)

Loader.exec_module() 的实现。

在 3.4 版新加入.

load_module(fullname)

Loader.load_module() 的实现。

在 3.4 版之後被棄用: 使用 exec_module() 来代替。

class importlib.abc.ExecutionLoader

一个继承自 InspectLoader 的抽象基类，当被实现时，帮助一个模块作为脚本来执行。 这个抽象基类表示可选的 PEP 302 协议。

abstractmethod get_filename(fullname)

一个用来为指定模块返回 __file__ 的值的抽象方法。如果无路径可用，则引发 ImportError。

如果源代码可用，那么这个方法返回源文件的路径，不管是否是用来加载模块的字节码。

在 3.4 版的變更: 引发 ImportError 而不是 NotImplementedError。

class importlib.abc.FileLoader(fullname, path)

一个继承自 ResourceLoader 和 ExecutionLoader，提供 ResourceLoader.get_data() 和 ExecutionLoader.get_filename() 具体实现的抽象基类。

参数 fullname 是加载器要处理的模块的完全解析的名字。参数 path 是模块文件的路径。

在 3.3 版新加入.

name

加载器可以处理的模块的名字。

path

模块的文件路径

load_module(fullname)

调用super的 load_module()。

在 3.4 版之後被棄用: 使用 Loader.exec_module() 来代替。

abstractmethod get_filename(fullname)

返回 path。

abstractmethod get_data(path)

读取 path 作为二进制文件并且返回来自它的字节数据。

class importlib.abc.SourceLoader

一个用于实现源文件（和可选地字节码）加载的抽象基类。这个类继承自 ResourceLoader 和 ExecutionLoader，需要实现：

由这个类定义的抽象方法用来添加可选的字节码文件支持。不实现这些可选的方法（或导致它们引发 NotImplementedError 异常）导致这个加载器只能与源代码一起工作。 实现这些方法允许加载器能与源 和 字节码文件一起工作。不允许只提供字节码的 无源式 加载。字节码文件是通过移除 Python 编译器的解析步骤来加速加载的优化，并且因此没有开放出字节码专用的 API。

path_stats(path)

返回一个包含关于指定路径的元数据的 dict 的可选的抽象方法。 支持的字典键有：

  • 'mtime' (必选项): 一个表示源码修改时间的整数或浮点数；

  • 'size' (可选项)：源码的字节大小。

字典中任何其他键会被忽略，以允许将来的扩展。 如果不能处理该路径，则会引发 OSError。

在 3.3 版新加入.

在 3.4 版的變更: 引发 OSError 而不是 NotImplemented。

path_mtime(path)

返回指定文件路径修改时间的可选的抽象方法。

在 3.3 版之後被棄用: 在有了 path_stats() 的情况下，这个方法被弃用了。 没必要去实现它了，但是为了兼容性，它依然处于可用状态。 如果文件路径不能被处理，则引发 OSError 异常。

在 3.4 版的變更: 引发 OSError 而不是 NotImplemented。

set_data(path, data)

往一个文件路径写入指定字节的的可选的抽象方法。任何中间不存在的目录不会被自动创建。

当对路径的写入因路径为只读而失败时 (errno.EACCES/PermissionError)，不会传播异常。

在 3.4 版的變更: 当被调用时，不再引起 NotImplementedError 异常。

get_code(fullname)

InspectLoader.get_code() 的具体实现。

exec_module(module)

Loader.exec_module() 的具体实现。

在 3.4 版新加入.

load_module(fullname)

Concrete implementation of Loader.load_module().

在 3.4 版之後被棄用: 使用 exec_module() 来代替。

get_source(fullname)

InspectLoader.get_source() 的具体实现。

is_package(fullname)

InspectLoader.is_package() 的具体实现。一个模块被确定为一个包的条件是：它的文件路径（由 ExecutionLoader.get_filename() 提供）当文件扩展名被移除时是一个命名为 __init__ 的文件，并且 这个模块名字本身不是以 __init__ 结束。

importlib.machinery —— 导入器和路径钩子函数。

原始碼：Lib/importlib/machinery.py

本模块包含多个对象，以帮助 import 查找并加载模块。

importlib.machinery.SOURCE_SUFFIXES

一个字符串列表，表示源模块的可识别的文件后缀。

在 3.3 版新加入.

importlib.machinery.DEBUG_BYTECODE_SUFFIXES

一个字符串列表，表示未经优化字节码模块的文件后缀。

在 3.3 版新加入.

在 3.5 版之後被棄用: 改用 BYTECODE_SUFFIXES 。

importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES

一个字符串列表，表示已优化字节码模块的文件后缀。

在 3.3 版新加入.

在 3.5 版之後被棄用: 改用 BYTECODE_SUFFIXES 。

importlib.machinery.BYTECODE_SUFFIXES

一个字符串列表，表示字节码模块的可识别的文件后缀（包含前导的句点符号）。

在 3.3 版新加入.

在 3.5 版的變更: 该值不再依赖于 __debug__ 。

importlib.machinery.EXTENSION_SUFFIXES

一个字符串列表，表示扩展模块的可识别的文件后缀。

在 3.3 版新加入.

importlib.machinery.all_suffixes()

返回字符串的组合列表，代表标准导入机制可识别模块的所有文件后缀。这是个助手函数，只需知道某个文件系统路径是否会指向模块，而不需要任何关于模块种类的细节（例如 inspect.getmodulename()）。

在 3.3 版新加入.

class importlib.machinery.BuiltinImporter

用于导入内置模块的 importer。 所有已知的内置模块都已列入 sys.builtin_module_names。 此类实现了 importlib.abc.MetaPathFinder 和 importlib.abc.InspectLoader 抽象基类。

此类只定义类的方法，以减轻实例化的开销。

在 3.5 版的變更: 作为 PEP 489 的一部分，现在内置模块导入器实现了 Loader.create_module() 和 Loader.exec_module()。

class importlib.machinery.FrozenImporter

用于已冻结模块的 importer。 此类实现了 importlib.abc.MetaPathFinder 和 importlib.abc.InspectLoader 抽象基类。

此类只定义类的方法，以减轻实例化的开销。

在 3.4 版的變更: 有了 create_module() 和 exec_module() 方法。

class importlib.machinery.WindowsRegistryFinder

Finder 用于查找在 Windows 注册表中声明的模块。该类实现了基础的 importlib.abc.MetaPathFinder 。

此类只定义类的方法，以减轻实例化的开销。

在 3.3 版新加入.

在 3.6 版之後被棄用: 改用 site 配置。未来版本的 Python 可能不会默认启用该查找器。

class importlib.machinery.PathFinder

用于 sys.path 和包的 __path__ 属性的 Finder 。该类实现了基础的 importlib.abc.MetaPathFinder。

此类只定义类的方法，以减轻实例化的开销。

classmethod find_spec(fullname, path=None, target=None)

类方法试图在 sys.path 或 path 上为 fullname 指定的模块查找 spec。对于每个路径条目，都会查看 sys.path_importer_cache 。如果找到非 False 的对象，则将其用作 path entry finder 来查找要搜索的模块。如果在 sys.path_importer_cache 中没有找到条目，那会在 sys.path_hooks 检索该路径条目的查找器，找到了则和查到的模块信息一起存入 sys.path_importer_cache 。如果查找器没有找到，则缓存中的查找器和模块信息都存为 None ，然后返回。

在 3.4 版新加入.

在 3.5 版的變更: 如果当前工作目录不再有效（用空字符串表示），则返回 None，但在 sys.path_importer_cache 中不会有缓存值。

classmethod find_module(fullname, path=None)

A legacy wrapper around find_spec().

在 3.4 版之後被棄用: 使用 find_spec() 代替。

classmethod invalidate_caches()

为所有存于 sys.path_importer_cache 中的查找器，调用其 importlib.abc.PathEntryFinder.invalidate_caches() 方法。 sys.path_importer_cache 中为 None 的条目将被删除。

在 3.7 版的變更: sys.path_importer_cache 中为 None 的条目将被删除。

在 3.4 版的變更: 调用 sys.path_hooks 中的对象，当前工作目录为 '' (即空字符串)。

class importlib.machinery.FileFinder(path, *loader_details)

importlib.abc.PathEntryFinder 的一个具体实现，它会缓存来自文件系统的结果。

参数 path 是查找器负责搜索的目录。

loader_details 参数是数量不定的二元组，每个元组包含加载器及其可识别的文件后缀列表。加载器应为可调用对象，可接受两个参数，即模块的名称和已找到文件的路径。

查找器将按需对目录内容进行缓存，通过对每个模块的检索进行状态统计，验证缓存是否过期。因为缓存的滞后性依赖于操作系统文件系统状态信息的粒度，所以搜索模块、新建文件、然后搜索新文件代表的模块，这会存在竞争状态。如果这些操作的频率太快，甚至小于状态统计的粒度，那么模块搜索将会失败。为了防止这种情况发生，在动态创建模块时，请确保调用 importlib.invalidate_caches()。

在 3.3 版新加入.

path

查找器将要搜索的路径。

find_spec(fullname, target=None)

尝试在 path 中找到处理 fullname 的规格。

在 3.4 版新加入.

find_loader(fullname)

Attempt to find the loader to handle fullname within path.

在 3.10 版之後被棄用: 使用 find_spec() 代替。

invalidate_caches()

清理内部缓存。

classmethod path_hook(*loader_details)

一个类方法，返回供 sys.path_hooks 使用的闭包。 使用直接提供给闭包的路径参数和间接提供的 loader_details 闭包将返回一个 FileFinder 的实例。

如果给闭包的参数不是已存在的目录，将会触发 ImportError。

class importlib.machinery.SourceFileLoader(fullname, path)

importlib.abc.SourceLoader 的一个具体实现，该实现子类化了 importlib.abc.FileLoader 并提供了其他一些方法的具体实现。

在 3.3 版新加入.

name

该加载器将要处理的模块名称。

path

源文件的路径

is_package(fullname)

如果 path 看似包的路径，则返回 True。

path_stats(path)

importlib.abc.SourceLoader.path_stats() 的具体代码实现。

set_data(path, data)

importlib.abc.SourceLoader.set_data() 的具体代码实现。

load_module(name=None)

importlib.abc.Loader.load_module() 的具体代码实现，这里要加载的模块名是可选的。

在 3.6 版之後被棄用: 改用 importlib.abc.Loader.exec_module() 。

class importlib.machinery.SourcelessFileLoader(fullname, path)

importlib.abc.FileLoader 的具体代码实现，可导入字节码文件（也即源代码文件不存在）。

请注意，直接用字节码文件（而不是源代码文件），会让模块无法应用于所有的 Python 版本或字节码格式有所改动的新版本 Python。

在 3.3 版新加入.

name

加载器将要处理的模块名。

path

二进制码文件的路径。

is_package(fullname)

根据 path 确定该模块是否为包。

get_code(fullname)

返回由 path 创建的 name 的代码对象。

get_source(fullname)

因为用此加载器时字节码文件没有源码文件，所以返回 None。

load_module(name=None)

importlib.abc.Loader.load_module() 的具体代码实现，这里要加载的模块名是可选的。

在 3.6 版之後被棄用: 改用 importlib.abc.Loader.exec_module() 。

class importlib.machinery.ExtensionFileLoader(fullname, path)

importlib.abc.ExecutionLoader 的具体代码实现，用于扩展模块。

参数 fullname 指定了加载器要支持的模块名。参数 path 是指向扩展模块文件的路径。

在 3.3 版新加入.

name

装载器支持的模块名。

path

扩展模块的路径。

create_module(spec)

根据 PEP 489 ，由给定规范创建模块对象。

在 3.5 版新加入.

exec_module(module)

根据 PEP 489，初始化给定的模块对象。

在 3.5 版新加入.

is_package(fullname)

根据 EXTENSION_SUFFIXES ，如果文件路径指向某个包的 __init__ 模块，则返回 True。

get_code(fullname)

返回 None，因为扩展模块缺少代码对象。

get_source(fullname)

返回 None，因为扩展模块没有源代码。

get_filename(fullname)

返回 path。

在 3.4 版新加入.

class importlib.machinery.NamespaceLoader(name, path, path_finder)

一个针对命名空间包的 importlib.abc.InspectLoader 具体实现。 这是一个私有类的别名，仅为在命名空间包上内省 __loader__ 属性而被设为公有:

>>> from importlib.machinery import NamespaceLoader
>>> import my_namespace
>>> isinstance(my_namespace.__loader__, NamespaceLoader)
True
>>> import importlib.abc
>>> isinstance(my_namespace.__loader__, importlib.abc.Loader)
True

在 3.11 版新加入.

class importlib.machinery.ModuleSpec(name, loader, *, origin=None, loader_state=None, is_package=None)

针对特定模块的导入系统相关状态的规范说明。 这通常是作为模块的 __spec__ 属性对外公开。 在下面的描述中，圆括号内的名称给出了在模块对象上直接可用的对应属性，例如 module.__spec__.origin == module.__file__。 但是要注意，虽然 values 通常是相等的，但它们也可以因为两个对象之间没有进行同步而不相等。 举例来说，有可能在运行时更新模块的 __file__ 而这将不会自动反映在模块的 __spec__.origin 中，反之亦然。

在 3.4 版新加入.

name

(__name__)

模块的完整限定名称。 finder 总是应当将此属性设为一个非空字符串。

loader

(__loader__)

用于加载模块的 loader。 finder 总是应当设置此属性。

origin

(__file__)

应当被 loader 用来加载模块的位置。 例如，对于从 .py 文件加载的模块来说这将为文件名。 finder 总是应当将此属性设为一个有意义的值供 loader 使用。 在少数没有可用值的情况下（如命名空间包），它应当被设为 None。

submodule_search_locations

(__path__)

将被用于包的子模块查找的位置列表。 在大多数时候这将为单个目录。 finder 应当将此属性设为一个列表，甚至可以是空列表，以便提示导入系统指定的模块是一个包。 对于非包模块它应当被设为 None。 对于命名空间包它会在稍后被自动设为一个特殊对象。

loader_state

finder 可以将此属性设为一个包含额外的模块专属数据的对象供加载模块时使用。 在其他情况下应将其设为 None。

cached

(__cached__)

模块代码的编译版本的文件名。 finder 总是应当设置此属性但是对于不需要存储已编译代码的模块来说可以将其设为 None。

parent

(__package__)

（只读）指定模块所在的包的完整限定名称（或者对于最高层级模块来说则为空字符串）。 如果模块是包则它将与 name 相同。

has_location
如果 spec 的 origin 指向一个可加载的位置则为 True,

在其他情况下为 False。 该值将确定如何解读 origin 以及如何填充模块的 __file__。

importlib.util —— 导入器的工具程序代码

原始碼：Lib/importlib/util.py

本模块包含了帮助构建 importer 的多个对象。

importlib.util.MAGIC_NUMBER

代表字节码版本号的字节串。若要有助于加载/写入字节码，可考虑采用 importlib.abc.SourceLoader。

在 3.4 版新加入.

importlib.util.cache_from_source(path, debug_override=None, *, optimization=None)

返回 PEP 3147/PEP 488 定义的，与源 path 相关联的已编译字节码文件的路径。 例如，如果 path 为 /foo/bar/baz.py 则 Python 3.2 中的返回值将是 /foo/bar/__pycache__/baz.cpython-32.pyc。 字符串 cpython-32 来自于当前的魔法标签 (参见 get_tag(); 如果 sys.implementation.cache_tag 未定义则将会引发 NotImplementedError)。

参数 optimization 用于指定字节码文件的优化级别。空字符串代表没有优化，所以 optimization 为 的 /foo/bar/baz.py，将会得到字节码路径为 /foo/bar/__pycache__/baz.cpython-32.pyc。None 会导致采用解释器的优化。任何其他字符串都会被采用，所以 optimization 为 '' 的 /foo/bar/baz.py 会导致字节码路径为 /foo/bar/__pycache__/baz.cpython-32.opt-2.pyc。optimization 字符串只能是字母数字，否则会触发 ValueError。

debug_override 参数已废弃，可用于覆盖系统的 __debug__ 值。True 值相当于将 optimization 设为空字符串。False 则相当于*optimization* 设为 1。如果 debug_override 和 optimization 都不为 None，则会触发 TypeError。

在 3.4 版新加入.

在 3.5 版的變更: 增加了 optimization 参数，废弃了 debug_override 参数。

在 3.6 版的變更: 接受一个 path-like object。

importlib.util.source_from_cache(path)

根据指向一个 PEP 3147 文件名的 path，返回相关联的源代码文件路径。 举例来说，如果 path 为 /foo/bar/__pycache__/baz.cpython-32.pyc 则返回的路径将是 /foo/bar/baz.py。 path 不需要已存在，但如果它未遵循 PEP 3147 或 PEP 488 的格式，则会引发 ValueError。 如果未定义 sys.implementation.cache_tag，则会引发 NotImplementedError。

在 3.4 版新加入.

在 3.6 版的變更: 接受一个 path-like object。

importlib.util.decode_source(source_bytes)

对代表源代码的字节串进行解码，并将其作为带有通用换行符的字符串返回（符合 importlib.abc.InspectLoader.get_source() 要求）。

在 3.4 版新加入.

importlib.util.resolve_name(name, package)

将模块的相对名称解析为绝对名称。

如果 name 前面没有句点，那就简单地返回 name。这样就能采用 importlib.util.resolve_name('sys', __spec__.parent) 之类的写法，而无需检查是否需要 package 参数。

如果 name 是一个相对模块名称但 package 为假值（如为 None 或空字符串）则会引发 ImportError。 如果相对名称离开了其所在的包（如为从 spam 包请求 ..bacon 的形式）则也会引发 ImportError。

在 3.3 版新加入.

在 3.9 版的變更: 为了改善与 import 语句的一致性，对于无效的相对导入尝试会引发 ImportError 而不是 ValueError。

importlib.util.find_spec(name, package=None)

查找模块的 spec，可选择相对于指定的 package 名称。 如果该模块位于 sys.modules 中，则会返回 sys.modules[name].__spec__ (除非 spec 为 None 或未设置，在此情况下则会引发 ValueError)。 在其他情况下将使用 sys.meta_path 进行搜索。 如果找不到任何 spec 则返回 None。

如果 name 为一个子模块（带有一个句点），则会自动导入父级模块。

name 和 package 的用法与 import_module() 相同。

在 3.4 版新加入.

在 3.7 版的變更: 如果 package 实际上不是一个包（即缺少 __path__ 属性）则会引发 ModuleNotFoundError 而不是 AttributeError。

importlib.util.module_from_spec(spec)

基于 spec 和 spec.loader.create_module 创建一个新模块。

如果 spec.loader.create_module 未返回 None，那么先前已存在的属性不会被重置。另外，如果 AttributeError 是在访问 spec 或设置模块属性时触发的，则不会触发 。

本函数比 types.ModuleType 创建新模块要好，因为用到 spec 模块设置了尽可能多的导入控制属性。

在 3.5 版新加入.

@importlib.util.module_for_loader

A decorator for importlib.abc.Loader.load_module() to handle selecting the proper module object to load with. The decorated method is expected to have a call signature taking two positional arguments (e.g. load_module(self, module)) for which the second argument will be the module object to be used by the loader. Note that the decorator will not work on static methods because of the assumption of two arguments.

The decorated method will take in the name of the module to be loaded as expected for a loader. If the module is not found in sys.modules then a new one is constructed. Regardless of where the module came from, __loader__ set to self and __package__ is set based on what importlib.abc.InspectLoader.is_package() returns (if available). These attributes are set unconditionally to support reloading.

If an exception is raised by the decorated method and a module was added to sys.modules, then the module will be removed to prevent a partially initialized module from being in left in sys.modules. If the module was already in sys.modules then it is left alone.

在 3.3 版的變更: __loader__ and __package__ are automatically set (when possible).

在 3.4 版的變更: Set __name__, __loader__ __package__ unconditionally to support reloading.

在 3.4 版之後被棄用: The import machinery now directly performs all the functionality provided by this function.

@importlib.util.set_loader

A decorator for importlib.abc.Loader.load_module() to set the __loader__ attribute on the returned module. If the attribute is already set the decorator does nothing. It is assumed that the first positional argument to the wrapped method (i.e. self) is what __loader__ should be set to.

在 3.4 版的變更: Set __loader__ if set to None, as if the attribute does not exist.

在 3.4 版之後被棄用: 导入机制会自动进行处理。

@importlib.util.set_package

A decorator for importlib.abc.Loader.load_module() to set the __package__ attribute on the returned module. If __package__ is set and has a value other than None it will not be changed.

在 3.4 版之後被棄用: 导入机制会自动进行处理。

importlib.util.spec_from_loader(name, loader, *, origin=None, is_package=None)

一个工厂函数，用于创建基于加载器的 ModuleSpec 实例。参数的含义与 ModuleSpec 的相同。该函数会利用当前可用的 loader API，比如 InspectLoader.is_package()，以填充所有缺失的规格信息。

在 3.4 版新加入.

importlib.util.spec_from_file_location(name, location, *, loader=None, submodule_search_locations=None)

一个工厂函数，根据文件路径创建 ModuleSpec 实例。缺失的信息将根据 spec 进行填补，利用加载器 API ，以及模块基于文件的隐含条件。

在 3.4 版新加入.

在 3.6 版的變更: 接受一个 path-like object。

importlib.util.source_hash(source_bytes)

以字节串的形式返回 source_bytes 的哈希值。基于哈希值的 .pyc 文件在头部嵌入了对应源文件内容的 source_hash()。

在 3.7 版新加入.

class importlib.util.LazyLoader(loader)

此类会延迟执行模块加载器，直至该模块有一个属性被访问到。

此类 仅仅 适用于定义 exec_module() 作为需要控制模块使用何种模块类型的加载器。 出于相同理由，加载器的 create_module() 方法必须返回 None 或其 __class__ 属性可被改变并且不使用 槽位 的类型。 最后，用于替换已放入 sys.modules 的对象的模块将无法工作因为没有办法安全地在整个解释器中正确替换模块引用； 如果检测到这种替换则会引发 ValueError。

備註

如果项目对启动时间要求很高，只要模块未被用过，此类能够最小化加载模块的开销。对于启动时间并不重要的项目来说，由于加载过程中产生的错误信息会被暂时搁置，因此强烈不建议使用此类。

在 3.5 版新加入.

在 3.6 版的變更: 开始调用 create_module()，移除 importlib.machinery.BuiltinImporter 和 importlib.machinery.ExtensionFileLoader 的兼容性警告。

classmethod factory(loader)

一个返回创建延迟加载器的可调用对象的类方法。 这专门被用于加载器由类而不是实例来传入的场合。

suffixes = importlib.machinery.SOURCE_SUFFIXES
loader = importlib.machinery.SourceFileLoader
lazy_loader = importlib.util.LazyLoader.factory(loader)
finder = importlib.machinery.FileFinder(path, (lazy_loader, suffixes))

範例

用编程方式导入

要以编程方式导入一个模块，请使用 importlib.import_module() ：

import importlib

itertools = importlib.import_module('itertools')

检查某模块可否导入。

如果你需要在不实际执行导入的情况下确定某个模块是否可被导入，则你应当使用 importlib.util.find_spec()。

请注意如果 name 是一个子模块（即包含一个点号），则 importlib.util.find_spec() 将会导入父模块。

import importlib.util
import sys

# For illustrative purposes.
name = 'itertools'

if name in sys.modules:
    print(f"{name!r} already in sys.modules")
elif (spec := importlib.util.find_spec(name)) is not None:
    # If you chose to perform the actual import ...
    module = importlib.util.module_from_spec(spec)
    sys.modules[name] = module
    spec.loader.exec_module(module)
    print(f"{name!r} has been imported")
else:
    print(f"can't find the {name!r} module")

直接导入源码文件。

要直接导入 Python 源文件，请使用以下写法:

import importlib.util
import sys

# For illustrative purposes.
import tokenize
file_path = tokenize.__file__
module_name = tokenize.__name__

spec = importlib.util.spec_from_file_location(module_name, file_path)
module = importlib.util.module_from_spec(spec)
sys.modules[module_name] = module
spec.loader.exec_module(module)

实现延迟导入

以下例子展示了如何实现延迟导入：

>>> import importlib.util
>>> import sys
>>> def lazy_import(name):
...     spec = importlib.util.find_spec(name)
...     loader = importlib.util.LazyLoader(spec.loader)
...     spec.loader = loader
...     module = importlib.util.module_from_spec(spec)
...     sys.modules[name] = module
...     loader.exec_module(module)
...     return module
...
>>> lazy_typing = lazy_import("typing")
>>> #lazy_typing is a real module object,
>>> #but it is not loaded in memory yet.
>>> lazy_typing.TYPE_CHECKING
False

导入器的配置

对于导入的深度定制，通常你需要实现一个 importer。 这意味着同时管理 finder 和 loader 两方面。 对于查找器来说根据你的需求有两种类别可供选择: meta path finder 或 path entry finder。 前者你应当放到 sys.meta_path 而后者是使用 path entry hook 在 sys.path_hooks 上创建并与 sys.path 条目一起创建一个潜在的查找器。 下面的例子将向你演示如何注册自己的导入器供导入机制使用 (关于自行创建导入器，请阅读在本包内定义的相应类的文档):

import importlib.machinery
import sys

# For illustrative purposes only.
SpamMetaPathFinder = importlib.machinery.PathFinder
SpamPathEntryFinder = importlib.machinery.FileFinder
loader_details = (importlib.machinery.SourceFileLoader,
                  importlib.machinery.SOURCE_SUFFIXES)

# Setting up a meta path finder.
# Make sure to put the finder in the proper location in the list in terms of
# priority.
sys.meta_path.append(SpamMetaPathFinder)

# Setting up a path entry finder.
# Make sure to put the path hook in the proper location in the list in terms
# of priority.
sys.path_hooks.append(SpamPathEntryFinder.path_hook(loader_details))

importlib.import_module() 的近似实现

导入过程本身是用 Python 代码实现的，这样就有可能通过 importlib 来对外公开大部分导入机制。 以下代码通过提供 importlib.import_module() 的近似实现来说明 importlib 所公开的几种 API:

import importlib.util
import sys

def import_module(name, package=None):
    """An approximate implementation of import."""
    absolute_name = importlib.util.resolve_name(name, package)
    try:
        return sys.modules[absolute_name]
    except KeyError:
        pass

    path = None
    if '.' in absolute_name:
        parent_name, _, child_name = absolute_name.rpartition('.')
        parent_module = import_module(parent_name)
        path = parent_module.__spec__.submodule_search_locations
    for finder in sys.meta_path:
        spec = finder.find_spec(absolute_name, path)
        if spec is not None:
            break
    else:
        msg = f'No module named {absolute_name!r}'
        raise ModuleNotFoundError(msg, name=absolute_name)
    module = importlib.util.module_from_spec(spec)
    sys.modules[absolute_name] = module
    spec.loader.exec_module(module)
    if path is not None:
        setattr(parent_module, child_name, module)
    return module