distribute、distutils、setuptools和distutils2之间的区别？

Question

情况

我正在尝试把一个开源库移植到Python 3。（如果有人好奇的话，是SymPy。）

所以，我需要在为Python 3构建时自动运行2to3。为此，我需要使用distribute。因此，我需要把当前的系统移植过来，而这个系统（根据文档测试）是distutils。

问题

不幸的是，我不太清楚这些模块之间有什么区别——distutils、distribute和setuptools。它们的文档简直不够清晰，似乎都是从彼此分叉出来的，目的是在大多数情况下兼容（但实际上并不是所有情况都兼容）……等等。

提问

有人能解释一下它们之间的区别吗？我应该使用哪个？最现代的解决方案是什么？（顺便说一下，我也希望能得到一些关于移植到Distribute的指导，不过那有点超出问题的范围……）

Answer 1

注意：这个回答已经过时了，Distribute现在也不再使用。因为Python打包管理机构成立后，做了很多工作来整理这个问题，所以这个回答不再有效。

---

没错，你说对了。:-o 目前推荐使用的包是Distribute，它是setuptools的一个分支，而setuptools又是distutils的扩展（distutils是最早的打包系统）。因为setuptools没有得到维护，所以就被分叉出来并改了名字，不过安装后它还是用setuptools这个包名！我觉得现在大多数Python开发者都在用Distribute，我可以肯定地说我也是。

Answer 2

我是distutils的维护者，也是distutils2和打包相关项目的贡献者。我在2011年的ConFoo大会上做过一个关于Python打包的演讲，现在我正在写这个演讲的扩展版本。虽然还没发布，但这里有一些摘录，希望能帮助大家理解相关内容。

• Distutils是用来打包的标准工具。对于简单的需求，它工作得还不错，但功能有限，扩展起来也不太容易。

• Setuptools是为了填补distutils功能缺失而诞生的项目，同时也在探索新的方向。在一些小圈子里，它已经成为一种事实上的标准。它使用了一些被Python核心开发者不太赞成的技术，比如猴子补丁和一些魔法。

• Distribute是Setuptools的一个分支，最初是因为一些开发者觉得Setuptools的发展速度太慢，无法继续进化而开始的。当同一组开发者开始了distutils2的项目后，Distribute的开发速度大幅放缓。2013年8月的更新：Distribute已经合并回Setuptools，并停止了开发。

• Distutils2是一个新的distutils库，起初是从distutils的代码库分叉出来的，借鉴了setup tools中的一些好点子（其中一些在PEP中有详细讨论），并且有一个受pip启发的基本安装程序。在Python 3.3及以上版本中，你用来导入Distutils2的实际名称是packaging，在2.4+和3.1–3.2中是distutils2。（很快会有一个回溯版本。） Distutils2没有在Python 3.3版本中发布，后来被搁置了。

更多信息：

• Distutils的命运 – Pycon峰会 + 打包冲刺详细报告
• Distutils和Distutils2的快速对比

我希望能尽快完成我的指南，里面会包含关于每个库的优缺点和过渡指南的更多信息。

Answer 3

截至2022年5月，关于这个问题的许多其他回答已经过时了好几年。当你看到关于Python打包问题的建议时，记得查看发布时间，不要相信过时的信息。

Python打包用户指南值得一读。每一页都有“最后更新”日期，这样你可以检查手册的更新情况，而且内容非常全面。它托管在Python软件基金会的python.org子域名上，这也增加了它的可信度。特别是项目摘要页面在这里特别相关。

工具总结：

以下是Python打包工具的总结：

支持的工具：

• setuptools是为了解决Distutils的局限性而开发的，不在标准库中。它引入了一个命令行工具叫做easy_install。它还引入了可以在你的setup.py脚本中导入的setuptools Python包，以及可以在代码中导入以定位与发行版一起安装的数据文件的pkg_resources Python包。它的一个小问题是，它会修改distutils Python包。它应该能很好地与pip配合使用。它会定期发布新版本。

  • _{官方文档 | Pypi页面 | GitHub仓库 | setuptools部分的Python打包用户指南}

• scikit-build是一个改进的构建系统生成器，内部使用CMake来构建编译的Python扩展。因为scikit-build不是基于distutils，所以没有它的局限性。当ninja-build可用时，scikit-build可以比其他工具快三倍以上地编译大型项目。它应该能很好地与pip配合使用。

  • _{官方文档 | Pypi页面 | GitHub仓库 | scikit-build部分的Python打包用户指南}

• distlib是一个库，提供了更高级工具（如pip）使用的功能。

  • _{官方文档 | Pypi页面 | Bitbucket仓库 | distlib部分的Python打包用户指南}

• packaging也是一个库，提供了更高级工具（如pip和setuptools）使用的功能。

  • _{官方文档 | Pypi页面 | GitHub仓库 | packaging部分的Python打包用户指南}

已弃用/放弃的工具：

• distutils仍然包含在Python的标准库中，但自Python 3.10起被认为是弃用的。它适用于简单的Python发行版，但功能有限。它引入了可以在你的setup.py脚本中导入的distutils Python包。

  • _{官方文档 | distutils部分的Python打包用户指南}

• distribute是setuptools的一个分支。它共享同一个命名空间，所以如果你安装了Distribute，import setuptools实际上会导入Distribute中分发的包。Distribute已经合并回Setuptools 0.7，所以你不需要再使用Distribute。实际上，Pypi上的版本只是一个兼容层，用于安装Setuptools。

• distutils2是一个尝试，旨在将distutils、setuptools和distribute的优点结合起来，成为Python标准库中包含的标准工具。计划是将distutils2分发给旧版本的Python，并将其重命名为Python 3.3中的packaging，并将其包含在标准库中。然而，这些计划并没有按预期进行，目前distutils2是一个被放弃的项目。最新的发布是在2012年3月，其Pypi主页也终于更新以反映其已结束。

其他：

还有其他工具，如果你感兴趣，可以阅读Python打包用户指南中的项目摘要。我不会列出所有工具，以免重复该页面的内容，并保持回答与问题一致，问题只涉及distribute、distutils、setuptools和distutils2。

推荐：

如果这些对你来说都是新鲜事，不知道从哪里开始，我建议你学习setuptools，同时学习pip和virtualenv，这三者配合得很好。

如果你在研究virtualenv，你可能会对这个问题感兴趣：venv、pyvenv、pyenv、virtualenv、virtualenvwrapper等之间有什么区别？。（是的，我知道，这让我也很头疼。）