使用python setup.py sdist打包Python项目：MANIFEST.in与整树归档的优缺点

嘿，这个问题问到点子上了——很多人刚开始打包Python项目时，都会觉得直接归档整个项目树是最省心的选择，但MANIFEST.in确实有它不可替代的价值，咱们把利弊掰扯清楚：

一、使用MANIFEST.in的优点 #

• 精准控制打包内容：可以主动排除掉项目里不需要的文件，比如本地调试生成的日志、__pycache__文件夹、编辑器配置（.vscode/.idea）、未完成的测试用例或者临时脚本。这样打包出来的sdist体积更小，也不会把无关文件发给用户或上传到PyPI，显得更专业。
• 确保非代码文件不遗漏：Python的setup.py默认不会自动包含所有非代码文件，比如README.md、LICENSE、配置模板、项目依赖的静态数据文件（如CSV、JSON）。用MANIFEST.in可以明确声明这些文件要被包含，避免发行版缺斤短两。
• 打包逻辑透明化：对于多人协作的项目，MANIFEST.in把哪些文件会被打包的规则写得明明白白，新维护者一看就懂，不会因为“默认打包规则”产生歧义，也方便后续修改打包范围。

二、使用MANIFEST.in的缺点 #

• 额外的维护成本：每次新增或删除需要打包的文件，都得同步更新MANIFEST.in的规则。要是忘了修改，要么漏了关键文件，要么把没用的文件打包进去，反而容易出错——这也是你觉得直接归档更简单的核心原因，确实少了一步维护工作。
• 存在学习门槛：刚接触的开发者得花点时间熟悉它的语法，比如include、exclude、recursive-include这些指令的用法，不像直接打包那样“一键搞定”。
• 规则匹配容易出错：比如路径写错、通配符使用不当，会导致需要的文件没被包含，或者不该有的文件被打包进来，排查问题时得逐行核对规则，比较麻烦。

关于“直接归档更简单不易出错”的补充 #

你这个观点完全站得住脚！对于小型个人项目、快速原型项目来说，直接打包整个项目树确实省心，只要项目里没堆太多临时文件，基本不会出问题。但当项目规模变大、有多个维护者，或者需要严格控制发行版内容时，MANIFEST.in的优势就显现了——它能避免“隐性打包”带来的意外，比如不小心把本地的测试数据、敏感配置文件打包进去的尴尬情况。

内容的提问来源于stack exchange，提问作者Aurélien Gâteau