importlib --- import 的实现

在 3.1 版本新加入.

原始碼:Lib/importlib/__init__.py


簡介

The purpose of the importlib package is three-fold.

One is to provide the implementation of the import statement (and thus, by extension, the __import__() function) in Python source code. This provides an implementation of import which is portable to any Python interpreter. This also provides an implementation which is easier to comprehend than one implemented in a programming language other than Python.

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

Three, the package contains modules exposing additional functionality for managing aspects of Python packages:

也參考

import 语句

import 语句的语言参考

包规格说明

包的初始规范。自从编写这个文档开始,一些语义已经发生改变了(比如基于 sys.modulesNone 的重定向)。

__import__() 函数

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

The initialization of the sys.path module search path

The initialization of 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)

查找一个模块的加载器,可选择地在指定的 path 里面。如果这个模块是在 sys.modules,那么返回 sys.modules[name].__loader__ (除非这个加载器是 None 或者是没有被设置, 在这样的情况下,会引起 ValueError 异常)。 否则使用 sys.meta_path 的一次搜索就结束。如果未发现加载器,则返回 None

点状的名称没有使得它父包或模块隐式地导入,因为它需要加载它们并且可能不需要。为了适当地导入一个子模块,需要导入子模块的所有父包并且使用正确的参数提供给 path

在 3.3 版本新加入.

在 3.4 版本變更: 如果没有设置 __loader__,会引起 ValueError 异常,就像属性设置为 None 的时候一样。

在 3.4 版本開始棄用: 使用 importlib.util.find_spec() 来代替。

importlib.invalidate_caches()

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

在 3.3 版本新加入.

在 3.10 版本變更: Namespace packages created/installed in a different sys.path location after the same namespace was already imported are noticed.

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


The importlib.abc module contains all of the core abstract base classes used by import. Some subclasses of the core abstract base classes are also provided to help in implementing the core ABCs.

ABC 类的层次结构:

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

代表 finder 的一个抽象基类

在 3.3 版本開始棄用: 使用 MetaPathFinderPathEntryFinder 来代替。

abstractmethod find_module(fullname, path=None)

为指定的模块查找 loader 定义的抽象方法。本来是在 PEP 302 指定的,这个方法是在 sys.meta_path 和基于路径的导入子系统中使用。

在 3.4 版本變更: 当被调用的时候,返回 None 而不是引发 NotImplementedError

在 3.10 版本開始棄用: 改为实现 MetaPathFinder.find_spec()PathEntryFinder.find_spec()

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)

一个用于查找指定的模块中 loader 的遗留方法。如果这是最高层级的导入,path 的值将会是 None。否则,这是一个查找子包或者模块的方法,并且 path 的值将会是来自父包的 __path__ 的值。如果未发现加载器,返回 None

如果定义了 find_spec() 方法,则提供了向后兼容的功能。

在 3.4 版本變更: 当调用这个方法的时候返回 None 而不是引发 NotImplementedError。 可以使用 find_spec() 来提供功能。

在 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)

一个用于在模块中查找一个 loader 的遗留方法。 返回一个 (loader, portion) 的2元组,portion 是一个贡献给命名空间包部分的文件系统位置的序列。 加载器可能是 None,同时正在指定的 portion 表示的是贡献给命名空间包的文件系统位置。portion 可以使用一个空列表来表示加载器不是命名空间包的一部分。 如果 loaderNone 并且 portion 是一个空列表,那么命名空间包中无加载器或者文件系统位置可查找到(即在那个模块中未能找到任何东西)。

如果定义了 find_spec() ,则提供了向后兼容的功能。

在 3.4 版本變更: 返回 (None, []) 而不是引发 NotImplementedError。 当可于提供相应的功能的时候,使用 find_spec()

在 3.4 版本開始棄用: 使用 find_spec() 来代替。

find_module(fullname)

Finder.find_module`的具体实现,该方法等价于``self.find_loader(fullname)[0]`()

在 3.4 版本開始棄用: 使用 find_spec() 来代替。

invalidate_caches()

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

class importlib.abc.Loader

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

Loaders that wish to support resource reading should implement a get_resource_reader() method as specified by importlib.resources.abc.ResourceReader.

在 3.7 版本變更: Introduced the optional get_resource_reader() method.

create_module(spec)

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

在 3.4 版本新加入.

在 3.6 版本變更: This method is no longer optional when exec_module() is defined.

exec_module(module)

An abstract method that executes the module in its own namespace when a module is imported or reloaded. The module should already be initialized when exec_module() is called. When this method exists, create_module() must be defined.

在 3.4 版本新加入.

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

load_module(fullname)

A legacy method for loading a module. If the module cannot be loaded, ImportError is raised, otherwise the loaded module is returned.

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()).

The loader should set several attributes on the module (note that some of these attributes can change when a module is reloaded):

  • __name__

    The module's fully qualified name. It is '__main__' for an executed module.

  • __file__

    The location the loader used to load the module. For example, for modules loaded from a .py file this is the filename. It is not set on all modules (e.g. built-in modules).

  • __cached__

    The filename of a compiled version of the module's code. It is not set on all modules (e.g. built-in modules).

  • __path__

    The list of locations where the package's submodules will be found. Most of the time this is a single directory. The import system passes this attribute to __import__() and to finders in the same way as sys.path but just for the package. It is not set on non-package modules so it can be used as an indicator that the module is a package.

  • __package__

    The fully qualified name of the package the module is in (or the empty string for a top-level module). If the module is a package then this is the same as __name__.

  • __loader__

    The loader used to load the module.

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

在 3.4 版本變更: Raise ImportError when called instead of NotImplementedError. Functionality provided when exec_module() is available.

在 3.4 版本開始棄用: The recommended API for loading a module is exec_module() (and create_module()). Loaders should implement it instead of load_module(). The import machinery takes care of all the other responsibilities of load_module() when exec_module() is implemented.

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 版本變更: 是可选的方法而不是一个抽象方法。

在 3.4 版本開始棄用: 现在导入机制会自动地关注这个方法。

class importlib.abc.ResourceLoader

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

在 3.7 版本開始棄用: This ABC is deprecated in favour of supporting resource loading through 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)

一个继承自 ResourceLoaderExecutionLoader,提供 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

一个用于实现源文件(和可选地字节码)加载的抽象基类。这个类继承自 ResourceLoaderExecutionLoader,需要实现:

由这个类定义的抽象方法用来添加可选的字节码文件支持。不实现这些可选的方法(或导致它们引发 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.MetaPathFinderimportlib.abc.InspectLoader 抽象基类。

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

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

class importlib.machinery.FrozenImporter

用于已冻结模块的 importer。 此类实现了 importlib.abc.MetaPathFinderimportlib.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.pathpath 上为 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)

一个过时的 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)

试图在 path 内找到处理 fullname 的加载器。

在 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 版本新加入.

NamespaceLoader(name, path, path_finder):

A concrete implementation of importlib.abc.InspectLoader for namespace packages. This is an alias for a private class and is only made public for introspecting the __loader__ attribute on namespace packages:

>>> 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)

A specification for a module's import-system-related state. This is typically exposed as the module's __spec__ attribute. In the descriptions below, the names in parentheses give the corresponding attribute available directly on the module object, e.g. module.__spec__.origin == module.__file__. Note, however, that while the values are usually equivalent, they can differ since there is no synchronization between the two objects. For example, it is possible to update the module's __file__ at runtime and this will not be automatically reflected in the module's __spec__.origin, and vice versa.

在 3.4 版本新加入.

name

(__name__)

The module's fully qualified name. The finder should always set this attribute to a non-empty string.

loader

(__loader__)

The loader used to load the module. The finder should always set this attribute.

origin

(__file__)

The location the loader should use to load the module. For example, for modules loaded from a .py file this is the filename. The finder should always set this attribute to a meaningful value for the loader to use. In the uncommon case that there is not one (like for namespace packages), it should be set to None.

submodule_search_locations

(__path__)

The list of locations where the package's submodules will be found. Most of the time this is a single directory. The finder should set this attribute to a list, even an empty one, to indicate to the import system that the module is a package. It should be set to None for non-package modules. It is set automatically later to a special object for namespace packages.

loader_state

The finder may set this attribute to an object containing additional, module-specific data to use when loading the module. Otherwise it should be set to None.

cached

(__cached__)

The filename of a compiled version of the module's code. The finder should always set this attribute but it may be None for modules that do not need compiled code stored.

parent

(__package__)

(Read-only) The fully qualified name of the package the module is in (or the empty string for a top-level module). If the module is a package then this is the same as name.

has_location
True if the spec's origin refers to a loadable location,

False otherwise. This value impacts how origin is interpreted and how the module's __file__ is populated.

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.pycNone 会导致采用解释器的优化。任何其他字符串都会被采用,所以 optimization''/foo/bar/baz.py 会导致字节码路径为 /foo/bar/__pycache__/baz.cpython-32.opt-2.pycoptimization 字符串只能是字母数字,否则会触发 ValueError

debug_override 参数已废弃,可用于覆盖系统的 __debug__ 值。True 值相当于将 optimization 设为空字符串。False 则相当于*optimization* 设为 1。如果 debug_overrideoptimization 都不为 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.pypath 不需要已存在,但如果它未遵循 PEP 3147PEP 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 参数。

ImportError is raised if name is a relative module name but package is a false value (e.g. None or the empty string). ImportError is also raised if a relative name would escape its containing package (e.g. requesting ..bacon from within the spam package).

在 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 进行搜索。若找不到则返回 None

如果 name 为一个子模块(带有一个句点),则会自动导入父级模块。

namepackage 的用法与 import_module() 相同。

在 3.4 版本新加入.

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

importlib.util.module_from_spec(spec)

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

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

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

在 3.5 版本新加入.

@importlib.util.module_for_loader

importlib.abc.Loader.load_module() 的一个 decorator,用来选取合适的模块对象以供加载。被装饰方法的签名应带有两个位置参数(如:load_module(self, module)),其中第二个参数将是加载器用到的模块 对象。请注意,由于假定有两个参数,所以装饰器对静态方法不起作用。

装饰的方法将接受要加载的模块的 name,正如 loader 一样。如果在 sys.modules 中没有找到该模块,那么将构造一个新模块。不管模块来自哪里, __loader__ 设置为 self ,并且 __package__ 是根据 importlib.abc.InspectLoader.is_package() 的返回值设置的。这些属性会无条件进行设置以便支持再次加载。

如果被装饰的方法触发异常,并且已有模块加入 sys.modules 中,那么该模块将被移除,以防 sys.modules 中残留一个部分初始化的模块。如果该模块原先已在 sys.modules 中,则会保留不变。

在 3.3 版本變更: 有可能时自动设置 __loader____package__

在 3.4 版本變更: 无条件设置 __name____loader____package__ 以支持再次加载。

在 3.4 版本開始棄用: 现在,导入机制直接执行本函数提供的所有功能。

@importlib.util.set_loader

一个 decorator,用于 importlib.abc.Loader.load_module() 在返回的模块上设置 __loader__ 属性。如果该属性已被设置,装饰器就什么都不做。这里假定被封装方法的第一个位置参数(即 self)就是 __loader__ 要设置的。

在 3.4 版本變更: 如果设为 None ,则会去设置 __loader__ ,就像该属性不存在一样。

在 3.4 版本開始棄用: 现在导入机制会自动用到本方法。

@importlib.util.set_package

一个用于 importlib.abc.Loader.load_module()decorator ,以便设置返回模块的 __package__ 属性。如果 __package__ 已设置且不为 None,则不会做改动。

在 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__ 属性可被改变且不用 slots 的类型。 最后,用于替换 sys.modules 内容的模块将无法工作,因为无法在整个解释器中安全地替换模块的引用;如果检测到这种替换,将触发 ValueError

備註

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

在 3.5 版本新加入.

在 3.6 版本變更: 开始调用 create_module(),移除 importlib.machinery.BuiltinImporterimportlib.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")

直接导入源码文件。

To import a Python source file directly, use the following recipe:

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。 这意味着得同时管理 finderloader。 根据不同的需求,有两种类型的查找器可供选择: meta path finderpath entry finder。 前者应位于 sys.meta_path 之上,而后者是用 path entry hooksys.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() 的近似实现

Import itself is implemented in Python code, making it possible to expose most of the import machinery through importlib. The following helps illustrate the various APIs that importlib exposes by providing an approximate implementation of importlib.import_module():

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