如何在Python打包时通过MANIFEST.in包含非代码静态文件

大强大大_8951

大强大大_8951

2026-10-05

910人浏览

原创

manifest.in仅对sdist生效,不影响wheel;pip install .默认优先用wheel,故静态文件缺失,须配合setup.py中package_data和include_package_data=true双配置。

如何在python打包时通过manifest.in包含非代码静态文件

MANIFEST.in 为什么对 setup.py 不起作用

因为 setup.py 默认只打包 py 文件,MANIFEST.in 控制的是源码分发包(sdist)中包含哪些非 Python 文件,和 wheel(bdist_wheel)基本无关。如果你用 pip install . 本地安装却没看到静态文件,大概率是 pip 从 wheel 安装的——而 wheel 根本不读 MANIFEST.in。

常见错误现象:python setup.py sdist 打出的 tar.gz 里有文件,但 pip install . 后 import mypkg; mypkg.get_data("data/config.json") 报错找不到路径。

  • MANIFEST.in 只影响 sdist,不影响 bdist_wheel
  • wheel 中要包含非代码文件,必须显式声明在 setup.py 的 package_data 或 data_files 里
  • 如果项目结构是 mypkg/ 下带 data/ 子目录,别忘了在 mypkg/__init__.py 中设 __package_data__ = True(非必需,但某些旧工具链会检查)

正确写法:MANIFEST.in + package_data 双保险

假设目录结构如下:

myproject/
├── setup.py
├── MANIFEST.in
└── mypkg/
    ├── __init__.py
    ├── core.py
    └── data/
        ├── config.json
        └── templates/
            └── email.txt

你需要两处同时配置:

  • MANIFEST.in 写:
    recursive-include mypkg/data *.json *.txt
  • setup.py 中加:
    setup(
        # ...
        package_data={
            "mypkg": ["data/*.json", "data/templates/*.txt"],
        },
        include_package_data=True,  # 这行让 setuptools 合并 MANIFEST.in 规则进 sdist
    )

注意:package_data 的键是包名(字符串),值是相对于该包根目录的 glob 模式;路径分隔符一律用 /,即使在 Windows 上。

读取这些文件时别硬编码路径

打包后文件不再在原始文件系统路径下,不能用 os.path.join(os.path.dirname(__file__), "data/config.json")——wheel 解压后可能被重定位或内存加载。

Li Python Sec Check
Li Python Sec Check

Python 安全规范检查工具:基于 CloudBase 规范、腾讯安全指南,LLM 智能分析(默认禁用,优先本地执行)

下载

推荐用 importlib.resources(Python 3.7+)或兼容方案:

  • Python 3.9+:from importlib import resources; content = resources.files("mypkg").joinpath("data/config.json").read_text()
  • Python 3.7–3.8:from importlib import resources; content = resources.read_text("mypkg", "data/config.json")
  • 需兼容 3.6 或更老版本?改用 pkg_resources.resource_string("mypkg", "data/config.json"),但注意 pkg_resources 已被标记为 legacy

错误示范:open("mypkg/data/config.json") —— 这依赖当前工作目录,不是包内路径。

调试技巧:验证文件是否真打进去了

别猜,直接看生成物:

  • 检查 sdist:tar -tzf dist/mypkg-1.0.tar.gz | grep data/
  • 检查 wheel:unzip -l dist/mypkg-1.0-py3-none-any.whl | grep data/
  • 安装后验证:python -c "import mypkg; print(mypkg.__file__)"; ls $(dirname $(python -c "import mypkg; print(mypkg.__file__)"))/data/

如果 unzip -l 看不到 data/,说明 package_data 配置有误或 glob 模式没匹配上;如果 tar -tzf 能看到但 wheel 里没有,说明漏了 package_data 声明。

容易被忽略的一点:package_data 只处理「已声明为 package」的目录(即含 __init__.py),mypkg/data/ 如果没有 __init__.py,哪怕写了 recursive-include,也不会进 wheel——除非你把它也变成一个子包,或者改用 data_files(但那会装到全局路径,不推荐)。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1651

4

python能做什么
python能做什么

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

2023.07.25

4104

7

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

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

2023.07.31

1649

3

python教程
python教程

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

2023.08.03

23697

23

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

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

2023.08.04

2907

5

python eval
python eval

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

2023.08.04

2927

5

scratch和python区别
scratch和python区别

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

2023.08.11

1143

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2283

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程