何时使用 pip 需求文件与 setup.py 中的 install_requires ？

Question

我使用 pip 和 virtualenv 来打包和安装一些 Python 库。

我想我正在做的事情是一个非常常见的场景。我是几个库的维护者，我可以明确指定这些库的依赖关系。我的一些库依赖于第三方库，这些库具有我无法控制的传递依赖项。

我想要实现的是在我的一个库上进行 pip install 以下载/安装其所有上游依赖项。我在 pip 文档中遇到的问题是 if/how 要求文件可以单独执行此操作，或者如果它们实际上只是使用install_requires的补充。

我是否会在所有库中使用 install_requires 来指定依赖项和版本范围，然后仅使用需求文件来解决冲突和/或冻结它们以进行生产构建？

让我们假设我生活在一个想象的世界中（我知道，我知道），我的上游依赖关系很简单，并且保证永远不会冲突或破坏向后兼容性。我是否必须使用 pip 要求文件，或者只是让 pip/setuptools/distribute 根据 install_requires 安装所有内容？

这里有很多类似的问题，但我找不到任何像何时使用其中之一或和谐地使用它们一样基本的问题。

Answer 1

我的理念是 install_requires 应该指出您需要的最低限度。如果您知道某些版本无法运行，它可能会包含版本要求；但它不应该有您不确定的版本要求（例如，您不确定依赖项的未来版本是否会破坏您的库）。

另一方面，需求文件应该表明您知道什么可以工作，并且可能包括您推荐的可选依赖项。例如，您可能使用 SQLAlchemy 但建议使用 MySQL，因此将 MySQLdb 放在需求文件中）。

因此，总而言之：install_requires 是为了让人们远离那些你知道不起作用的东西，而需求文件则是为了引导人们走向你知道起作用的东西。原因之一是 install_requires 要求始终受到检查，并且在不实际更改包元数据的情况下无法禁用。所以你不能轻易尝试新的组合。仅在安装时检查需求文件。

Answer 2

这是我在 setup.py 中放入的内容：

# this grabs the requirements from requirements.txt
REQUIREMENTS = [i.strip() for i in open("requirements.txt").readlines()]

setup(
    .....
    install_requires=REQUIREMENTS
)

Answer 3

Python 打包用户指南有一个关于此主题的页面，我强烈建议您阅读它：

• install_requires 与需求文件

摘要：

install_requires 用于列出包的依赖项，必须安装这些依赖项才能使包正常工作。它并不意味着将依赖项固定到特定版本，但接受范围，例如 install_requires=['django>=1.8']。 install_requires 由 pip install name-on-pypi 和其他工具观察。

requirements.txt 只是一个文本文件，您可以选择对其运行 pip install -rrequirements.txt。它意味着固定所有依赖项和子依赖项的版本，如下所示：django==1.8.1。您可以使用 pip freeze > 创建一个需求.txt。 （某些服务，例如 Heroku，会自动为您运行 pip install -rrequirements.txt。）pip install name-on-pypi 不会查看 requirements。 txt，仅在 install_requires 处。

Answer 4

我只使用 setup.py 和 install_requires 因为只有一个地方可以查看。它与拥有需求文件一样强大，并且无需重复维护。