讲师中心 微信公众号
AI工具推荐 视频效率加速

如何在Python中通过importlib.resources安全读取包内资源

风婷小哥_5436

风婷小哥_5436

发布时间:2026-10-28 10:39:32

|

869人浏览过

|

来源于php中文网

原创

应使用 importlib.resources.files()(3.9+)或 open_text()/open_binary()(3.7–3.8),禁用已弃用的 read_text() 和 contents();因其依赖 file 路径拼接,在 zip 包、命名空间包或符号链接下会静默失败或抛 FileNotFoundError。

如何在python中通过importlib.resources安全读取包内资源

直接用 importlib.resources.files()(Python 3.9+)或 importlib.resources.open_binary()/open_text()(3.7–3.8),别碰已弃用的 importlib.resources.read_text() 和 contents() —— 它们在包含命名空间包或符号链接时会静默失败或抛 FileNotFoundError。

为什么 importlib.resources.read_text() 不安全?

这个函数在 Python 3.9 被标记为 deprecated,核心问题是它内部依赖 __file__ 和文件系统路径拼接。当包被 zipimport 加载(如打包成 .whl 或 pyz)、位于命名空间包中、或资源实际是 symlink 指向外部路径时,read_text() 会直接报 FileNotFoundError,且不提供 fallback 机制。

  • 常见错误现象:FileNotFoundError: [Errno 2] No such file or directory: '/path/to/pkg/data/config.json',但资源明明存在
  • 使用场景:CI/CD 构建后部署到容器、PyInstaller 打包、PEP 420 命名空间包
  • 替代方案必须基于 Traversable 接口(返回对象支持 .joinpath()、.is_file()、.open())

importlib.resources.files() 是唯一推荐入口(3.9+)

它返回一个 Traversable 对象,代表包的根目录,所有操作都通过该对象进行,与底层加载机制无关(zip、filesystem、namespace 全兼容)。

macOS UI 自动化技能包 —— 用 Python 控制你的 Mac
macOS UI 自动化技能包 —— 用 Python 控制你的 Mac

让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac,无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启:辅助功能 + 屏幕录制权限

下载
  • 读取文本:importlib.resources.files('mypkg').joinpath('data', 'config.json').read_text(encoding='utf-8')
  • 读取二进制:importlib.resources.files('mypkg').joinpath('static', 'logo.png').read_bytes()
  • 检查存在性:res = importlib.resources.files('mypkg').joinpath('templates'); res.is_file() or res.is_dir()
  • 注意:路径分隔符统一用 /(joinpath() 自动处理),不要用 os.path.join()

兼容旧版本(3.7–3.8)必须用 open_text() + files() 回退

Python 3.7–3.8 没有 files(),但已有 open_text() 和 open_binary(),它们比 read_text() 更健壮(内部已尝试 Traversable fallback)。不过仍需手动处理异常并降级到 importlib_resources backport(非标准库)。

立即学习“Python免费学习笔记(深入)”;

  • 优先尝试标准库:from importlib import resources; resources.open_text('mypkg', 'data/config.json')
  • 若报 AttributeError(3.7 早期版),则安装 backport:pip install importlib-resources,再用 importlib_resources.files()
  • 绝对不要在 3.7+ 中继续用 resources.contents() —— 它只返回文件名列表,不保证可访问,且对 zip 包返回空
  • 性能影响:相比直接读文件,files().joinpath().read_text() 多一次对象构造,但差异在纳秒级,可忽略

容易被忽略的路径和编码陷阱

资源路径是相对于包根目录的纯字符串,不是模块路径;编码必须显式指定,否则 read_text() 在非 UTF-8 系统上可能解码失败。

  • files('mypkg.subpkg').joinpath('data.txt') → 错!files() 只接受顶层包名,子包要写成 files('mypkg').joinpath('subpkg', 'data.txt')
  • 二进制资源(如图片、字体)必须用 read_bytes() 或 open_binary(),用 read_text() 会抛 UnicodeDecodeError
  • JSON/YAML 配置建议统一用 UTF-8 并显式传 encoding='utf-8',避免依赖 locale
  • Windows 上路径大小写不敏感,但 Linux/macOS 敏感——测试务必在目标部署环境运行

热门AI工具

更多
讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

相关专题

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

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

1811

2023.07.20

python能做什么
python能做什么

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

4844

2023.07.25

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

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

1769

2023.07.31

python教程
python教程

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

28937

2023.08.03

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

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

3467

2023.08.04

python eval
python eval

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

3467

2023.08.04

scratch和python区别
scratch和python区别

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

1223

2023.08.11

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

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

616

2023.08.10

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

20

2026.10.28

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn