importlib.resources -- 包资源的读取、打开和访问

源代码: Lib/importlib/resources/__init__.py

---

在 3.7 版本加入.

此模块调整了 Python 的导入系统以便提供对 包 内部的 资源 的访问。

“资源”是指 Python 中与模块或包相关联的文件类资源。 资源可以直接包含在某个包中，包含在某个包的子目录中，或是与某个包外部的模块相邻。 资源可以是文本或二进制数据。 因此，从技术上说 Python 包的模块源代码文件 (.py) 和编译结果文件 (pycache) 就是包实际所包含的资源。 但是，在实践中，资源主要是指包作者专门公开的非 Python 文件。

资源可以使用二进制或文本模式打开。

资源大致相当于目录内的文件，不过需要记住这只是一个比喻。 资源和包 不是 必须如文件系统上的物理文件和目录那样存在的：例如，一个包及其资源可使用 zipimport 从一个 ZIP 文件导入。

备注

本模块提供了类似于 pkg_resources Basic Resource Access 的功能而没有那样高的性能开销。 这使得读取包中的资源更为容易，并具有更为稳定和一致的语义。

此模块的独立向下移植版本在 using importlib.resources 和 migrating from pkg_resources to importlib.resources 中提供了更多信息。

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

class importlib.resources.Anchor

代表资源的锚点，可以是一个 模块对象 或字符串形式的模块名称不。 定义为 Union[str, ModuleType]。

importlib.resources.files(anchor: Anchor | None = None)

返回一个代表资源容器（相当于目录）及其资源（相当于文件）的 Traversable 对象。 Traversable 可以包含其他容器（相当于子目录）。

anchor is an optional Anchor. If the anchor is a package, resources are resolved from that package. If a module, resources are resolved adjacent to that module (in the same package or the package root). If the anchor is omitted, the caller's module is used.

在 3.9 版本加入.

在 3.12 版本发生变更: package parameter was renamed to anchor. anchor can now be a non-package module and if omitted will default to the caller's module. package is still accepted for compatibility but will raise a DeprecationWarning. Consider passing the anchor positionally or using importlib_resources >= 5.10 for a compatible interface on older Pythons.

importlib.resources.as_file(traversable)

给定一个代表文件或目录的 Traversable 对象，通常是来自 importlib.resources.files()，返回一个上下文管理器以供 with 语句使用。 该上下文管理器提供一个 pathlib.Path 对象。

退出上下文管理器后会清除从 zip 文件等提取资源时创建的任何临时文件或目录。

当 Traversable 的方法（如 read_text 等）不足以满足需要而需要文件系统中的真实文件或目录时请使用 as_file。

在 3.9 版本加入.

在 3.12 版本发生变更: Added support for traversable representing a directory.