Python开发打包时怎么把非代码的配置文件和静态资源包含进去?

雨晨小哥_7870

雨晨小哥_7870

2026-11-02

814人浏览

原创

package_data 用于将文件打包进 Python 包内部,运行时通过 importlib.resources 等安全读取;data_files 则按系统路径单独安装,适用于全局资源。关键区别在于用途与安装位置。

python开发打包时怎么把非代码的配置文件和静态资源包含进去?

setup.py 里用 package_data 还是 data_files?

关键看文件用途和安装路径:package_data 只打包进 Python 包内部(跟 .py 文件同级或子目录),运行时用 importlib.resources 或 pkg_resources 读取;data_files 则按系统约定路径(如 /usr/local/share/ 或 %PROGRAMFILES%)单独安装,适合全局配置、图标、文档等。

常见错误是把本该随包分发的 config.yaml 放进 data_files,结果在虚拟环境里找不到路径,或者跨平台行为不一致。

  • package_data 必须配合 find_packages() 或显式声明 packages,否则会被忽略
  • data_files 的目标路径在 Windows 和 Linux 上语义不同,比如 ('etc', ['conf/app.conf']) 在 Linux 会装到 /etc/app.conf,Windows 下可能直接失败或乱放
  • 如果用 setuptools 61.0+,优先用 include_package_data=True + MANIFEST.in,更直观

MANIFEST.in 怎么写才不会漏文件?

MANIFEST.in 控制源码分发包(sdist)里包含哪些非 Python 文件,但它不影响 wheel 构建——wheel 依赖 setup.py 中的 package_data 或 data_files 配置。漏文件最常发生在:只写了 MANIFEST.in 却没配 package_data,导致 pip install wheel 时资源消失。

  • 用 recursive-include mypackage *.json *.yaml 比 include mypackage/conf/*.yaml 更可靠,避免路径拼写错误
  • 别用 global-include,它会把 .gitignore 里的文件也塞进去(比如 .env)
  • 执行 python setup.py sdist --dry-run 可预览实际打进 tar.gz 的文件列表

运行时怎么安全读取打包进来的配置文件?

硬编码相对路径(如 open('conf/app.yaml'))在开发时能跑,打包后必然失败。Python 3.9+ 推荐用 importlib.resources.files(),3.7–3.8 用 importlib.resources.open_text(),兼容旧版可用 pkg_resources.resource_string()(但已弃用)。

python-flask-vue-creator
python-flask-vue-creator

创建 Flask + Vue.js 全栈项目,采用单端口架构、uv 依赖管理、结构化日志和生产级前端设计。当用户要求以下操作时触发:创建新的 Flask+Vue 项目、搭建 Web 应用、构建全栈 Python+Vue 应用、初始化 Flask Web 项目、设置单端口 Flask 前后端项目。触发词:新建项目、创建项目、搭建项目、Flask项目、Vue项目。

下载
from importlib import resources
# Python 3.9+
with resources.files('mypackage').joinpath('conf/app.yaml').open('r') as f:
    config = yaml.safe_load(f)
  • 不要用 __file__ 拼路径,__file__ 在 zipimport(如某些 wheel)下是无效路径
  • 如果文件是二进制(如字体、图片),用 .read_bytes() 而不是 .open()
  • resources.files() 返回的是 Traversable 对象,不能直接传给 open(),必须调用 .open() 或 .read_text()

PyInstaller 打包时静态资源总找不到?

PyInstaller 默认只扫描 import 语句,不会自动收集 MANIFEST.in 或 package_data 里的文件。必须显式告诉它:“这些路径下的文件也要打进最终可执行文件”。

  • 用 --add-data 'src/conf;conf'(Windows)或 --add-data 'src/conf:conf'(Linux/macOS),注意分隔符不同
  • 代码里读取时,要适配 PyInstaller 的 _MEIPASS 临时解压路径:os.path.join(sys._MEIPASS, 'conf', 'app.yaml')
  • 更稳妥的做法是封装一个函数统一处理路径,开发时走普通路径,打包后自动切到 _MEIPASS

真正麻烦的不是怎么加,而是加完忘了改读取逻辑——资源进了 bundle,但代码还在原路径找,报 FileNotFoundError 时容易误判为打包失败。

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

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python 配置文件

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1851

4

python能做什么
python能做什么

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

2023.07.25

5004

7

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

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

2023.07.31

1789

3

python教程
python教程

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

2023.08.03

29997

23

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

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

2023.08.04

3567

5

python eval
python eval

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

2023.08.04

3587

5

scratch和python区别
scratch和python区别

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

2023.08.11

1223

5

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

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

2023.08.10

616

4

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

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

2023.08.11

2783

5

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习