Python 中的 requirements.txt 与 setup.py
发布网友
发布时间：2024-09-27 16:03
共1个回答
热心网友
时间：2024-09-27 22:13
对于新手来说，管理 Python 项目中的依赖项非常具有挑战性，这一问题由历史原因引起，并且一直受到吐槽。
本文将探讨如何正确管理 Python 项目的依赖关系。具体来说，将讨论 requirements.txt 文件的用途，以及如何使用 setuptools 来分发自定义的 Python 包，并让其他用户进一步使用和开发它。此外，还将讨论设置文件（即 setup.cfg 和 setup.py）的用途，以及如何将它们与需求文件一起使用，从而使包开发和重新分发的过程变得更容易。
Python 项目的依赖关系是什么
让我们从包依赖开始，介绍它们到底是什么，以及如何正确管理它们，因为这样可以使 Python 项目变得更容易维护。
简单来说，依赖项是我们 Python 项目所依赖的外部其他 Python 包，例如在 AI 方向，最常用的包是 Numpy 和 Pandas。在 Python 中，这些依赖通常可以在 Python 包索引（PyPI）或其他管理工具中找到（例如 Nexus），以下以 PyPI 为例介绍，因为它是最常用且大家都在用的包管理工具。
现在，我们的 Python 项目可能需要引用某个特定版本的第三方包有依赖。这种情况可能会导致依赖冲突的出现，因为我们所有的依赖中（至少）有两个依赖项可能依赖同一个包，但每个依赖项都需要该外部包的特定版本（比如一个需要 1.0，而一个需要 2.0）。在这种情况下，我们需要告诉 pip 如何处理依赖关系，以及我们需要哪些特定版本。
一般情况下，我们需要 requirements.txt 来指定项目的依赖包和版本，因此先看看 requirements.txt 的格式。
requirements.txt 文件
requirements.txt 是一个文件，列出了 Python 项目的所有依赖项。如前所述，它还可能包含依赖项的依赖项。除了列出依赖包名称外，还可以指定特定的版本（使用 ==）、>= 或 <=，甚至两者都指定。
示例 requirements.txt 文件
matplotlib >= 2.2 numpy >= 1.15.0, < 1.21.0 pandas pytest == 4.0.1
然后可以使用以下命令通过 pip 安装这些依赖项（通常在虚拟环境中）：
pip install -r requirements.txt
在上面的示例中，我们指定了一些依赖项。例如，对于没有关联版本的 pandas 包，pip 将正常安装最新版本，除非其他依赖项之一与它有任何冲突（如果有冲突，pip 将安装满足其余依赖项指定条件的最新 pandas 版本）。对于 pytest，包管理器将安装特定版本（即 4.0.1），而对于 matplotlib，将安装至少大于或等于 2.2 的最新版本（这还取决于是否有其他依赖项具体要求，如果没有则会安装符合条件的最新版）。对于 numpy 包，pip 将尝试安装 1.15.0（包含）和 1.21.0（不包含）之间的最新版本。
在安装所有依赖项后，可以通过运行 pip freeze 来查看虚拟环境中安装的每个依赖项的确切版本。此命令将列出所有包及其特定版本（即 ==）。
requirements.txt 非常有用，但它仅针对我们项目的开发和发布（例如线上部署等）。如果我们想将我们的代码发布到 PyPI 供其他人使用，那么需要的不仅仅是这个文件。
Python 中的 setuptools
setuptools 是构建在 distutils 之上的包，它可以帮助开发人员快速发布 Python 包。此外，它还提供了使依赖管理更容易的功能。
当想要发布一个包时，通常需要填写一些元数据，例如包名、版本、依赖项、入口点等。setuptools 就提供了简化这些操作的功能。
项目的元数据等信息需要在 setup.py 文件中定义，例如下面的 demo：
我们所填写的信息都是纯声明性的，因此一个更好的方法是在名为 setup.cfg 的文件中定义这些元数据和信息，然后只需在 setup.py 文件中调用 setup() 即可。setup.cfg 文件如下所示：
这样在我们的 setup.py 文件中只需要保留最少的代码：
上面 install_requires 参数与 requirements.txt 类似，可以使用运算符 <、>、<=、>=、== 或！=，后跟版本标识符。当项目安装时会根据该配置来下载和安装依赖。
我们需要 requirements.txt 和 setup.py/setup.cfg 文件吗？
这就需要分情况对待了。首先，requirements.txt 与 setup.py 之间的通常用于实现不同的需求：
另外，如果同时使用两者，setup.py（setup.cfg）文件应包含抽象依赖项列表，而 requirements.txt 文件必须包含具有每个包版本的特定引脚的具体依赖项（使用 == 指定特定版本）。
以下是 Python 文档中官方的定义：
install_requires（即 setup.py）定义了单个项目的依赖关系，而 requirements.txt 通常用于定义完整的 Python 环境。
尽管 install_requires 要求很少，但 requirements.txt 通常包含详尽的固定版本列表，以实现完整环境的可重复安装。
来自： packaging.python.org/en...
总结
本文讨论了在开发 Python 项目和应用程序时适当的依赖管理的重要性。并且介绍了 requirements.txt 文件的用途以及如何将它与 setuptools 的配置文件（即 setup.py 和 setup.cfg）一起使用，这样可以保证其他开发人员可以安装、运行、开发甚至测试源代码 Python 包的代码。
setuptools 不能完全替代 requirements.txt 文件。在大多数情况下，可能需要这两个文件同时存在，这样才能够正确管理包依赖和进行包的发布。
