如何在Python 3.9中实现更灵活的包资源访问_使用importlib.resources

浅静君_3207

浅静君_3207

2026-05-28

433人浏览

原创

importlib.resources更可靠,因其是python标准库模块、零依赖、无副作用,且天然支持zip包和冻结环境;而pkg_resources已被弃用,易在虚拟环境或pep 517构建中失效,并引发distributionnotfound或filenotfounderror。

如何在python 3.9中实现更灵活的包资源访问_使用importlib.resources

为什么 importlib.resources 比 pkg_resources 更可靠

因为 pkg_resources 在 Python 3.9+ 中已显式标记为“不推荐使用”,且依赖 easy_install 机制,容易在虚拟环境或 PEP 517 构建中失效;importlib.resources 是标准库模块,零依赖、无运行时副作用,且与 importlib.metadata 协同良好。

常见错误现象:pkg_resources.DistributionNotFound 或资源路径拼接后 FileNotFoundError —— 多数源于开发者手动拼接 __file__ 路径,而该路径在 zipimport、冻结可执行文件(如 PyInstaller)或命名空间包中根本不可靠。

  • 始终用资源名(字符串),而非文件系统路径
  • 资源名必须是相对于包的相对路径,不以 / 开头,且用 / 分隔(非 os.sep)
  • 不支持通配符或递归遍历;需明确指定文件名

files() 是 Python 3.9+ 的首选接口

Python 3.9 引入了 importlib.resources.files(),取代旧版 open_text()/open_binary() 等函数。它返回一个 Traversable 对象,行为类似 pathlib.Path,支持 .joinpath()、.read_text()、.is_file() 等方法,且天然兼容 zip 包和源码目录。

使用场景:读取配置模板、嵌入 JSON Schema、加载字体/图标等二进制资源。

from importlib import resources
<h1>假设包结构为 mypackage/ (含 data/schema.json 和 templates/report.j2)</h1><p>with resources.files("mypackage").joinpath("data/schema.json").open("r") as f:
schema = json.load(f)</p><h1>读取二进制资源(如图标)</h1><p>icon_bytes = resources.files("mypackage").joinpath("assets/icon.png").read_bytes()</p><div class="aritcle_card flexRow artxards">
											<div class="artcardd flexRow">
												<a class="aritcle_card_img" rel="nofollow" href="/xiazai/skill9386" title="python学习"><img
														src="https://img.php.cn/upload/skill/000/000/081/179257684888086.jpg" alt="python学习" onerror="this.onerror='';this.src='/static/lhimages/moren/morentu.png'" ></a>
												<div class="aritcle_card_info flexColumn">
													<a rel="nofollow" href="/xiazai/skill9386" title="python学习" class="overflowclass">python学习</a>
													<p class="overflowclass">Python 编程学习助手 skill,面向零基础用户。 当用户表达以下意图时触发: - 学习 Python 基础概念(变量、数据类型、循环、函数、类等) - 请求 Python 练习题或测验 - 请求审查或调试 Python 代码 - 请求 Python 项目实战指导(爬虫、数据分析、Web 开发等入门项目) - 泛化表述如"教我 Python""我想学编程""Python 怎么写""帮我学 Python" 此 skill </p>
												</div>
												<a rel="nofollow" href="/xiazai/skill9386" title="python学习" class="aritcle_card_btn flexRow flexcenter"><b></b><span>下载</span>
												</a>
											</div>
										</div>
  • files() 必须传入**包名字符串**(如 "mypackage"),不能是模块对象或相对导入路径
  • 若包未安装(仅在开发目录下),需确保当前工作目录包含该包,或通过 -m pip install -e . 安装为可编辑模式
  • 不支持跨包访问;files("otherpkg").joinpath("x.txt") 会抛 ModuleNotFoundError,除非 otherpkg 已安装且可导入

处理子包和嵌套资源的路径写法

资源路径中的 / 表示层级分隔,不是操作系统路径分隔符。例如 subpkg/config.yaml 对应 mypackage/subpkg/config.yaml,无论该子包是否被声明为独立包(即有无 __init__.py)。

容易踩的坑:resources.files("mypackage.subpkg") 会失败,除非 mypackage.subpkg 是一个可导入的子包(含 __init__.py);否则应统一从顶层包出发,用 joinpath("subpkg/config.yaml")。

  • 路径中禁止出现 .. 或以 . 开头;joinpath("../bad.txt") 抛 ValueError
  • 空目录不会被识别为资源;joinpath("empty_dir/") 会返回 None 或引发 FileNotFoundError
  • 区分大小写:Windows 上可能忽略,但 Linux/macOS 和 zip 包严格区分,"Data" ≠ "data"

兼容旧版 Python 的回退方案

如果代码需同时支持 Python 3.8 及以下,不能直接用 files()。此时应使用 importlib_resources 第三方 backport 包(注意名字带下划线),并在运行时做版本判断。

try:
    from importlib import resources
    if not hasattr(resources, "files"):
        raise ImportError
except ImportError:
    import importlib_resources as resources  # pip install importlib-resources
<h1>后续统一用 resources.files(...)</h1>

性能影响:backport 版本在 Python 3.9+ 下会自动委托给标准库,几乎无开销;但在 Python 3.7 下,其 files() 实现基于 __file__ 推导,无法支持 zipimport,这点必须在测试中覆盖。

真正容易被忽略的是:资源文件的编码。默认 .read_text() 使用 UTF-8,若资源含 BOM 或 GBK 编码,需显式传 encoding="gbk";而 .read_bytes() 总是安全的,建议优先用于二进制或需自行解码的文本。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1771

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4644

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1749

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

27497

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3327

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3327

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1203

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2583

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习