在setuptools setup.py文件中引用install_requires kwarg的requirements.txt

我有一个我正在使用Travis-CI的requirements.txt文件。在requirements.txt和setup.py中复制需求似乎很愚蠢，所以我希望在setuptools.setup中传递一个文件句柄给install_requires kwarg。

这可能吗?如果是，我该怎么做呢?

这是我的requirements.txt文件:

guessit>=0.5.2
tvdb_api>=1.8.2
hachoir-metadata>=1.3.3
hachoir-core>=1.3.3
hachoir-parser>=1.3.4

当前回答

我不建议做这样的事。正如多次提到的，install_requires和requirements.txt绝对不应该是同一个列表。但是由于涉及到pip的私有内部api，有很多误导性的答案，因此可能值得考虑更理智的替代方案……

没有pip，可以从setuptools setup.py脚本中解析一个相对简单的requirements.txt文件。setuptools项目已经在其顶级包pkg_resources中包含了必要的工具。

它或多或少是这样的:

#!/usr/bin/env python3

import pathlib

import pkg_resources
import setuptools

with pathlib.Path('requirements.txt').open() as requirements_txt:
    install_requires = [
        str(requirement)
        for requirement
        in pkg_resources.parse_requirements(requirements_txt)
    ]

setuptools.setup(
    install_requires=install_requires,
)

同样，这只适用于简单的requirements.txt文件。请参阅pkg_resources文档页中的需求解析，以获得关于所处理内容的详细信息。简而言之，每一行都应该是有效的PEP 508需求。不支持真正特定于pip的符号，这将导致失败。

警告之词

如前所述，不建议这样做。requirements.txt文件和“安装依赖项”列表是两个不同的概念，它们是不可互换的。

但是如果你确实写了一个setup.py安装脚本来读取requirements.txt，那么确保requirements.txt文件包含在“源发行版”(sdist)中，否则安装显然会失败。

自从setuptools版本62.6以来，可以在setup.cfg中写这样的东西:

[options]
install_requires = file: requirements.txt

或者在pyproject.toml中:

[project]
dynamic = ["dependencies"]

[tool.setuptools.dynamic]
dependencies = requirements.txt

上述忠告同样适用:

只支持非常简单的文件该文件必须添加到sdist

此外，它目前被认为是一个“测试版”功能。

注:

另一个答案是:https://stackoverflow.com/a/59971236/11138259 https://caremad.io/posts/2013/07/setup-vs-requirement/ https://setuptools.pypa.io/en/latest/history.html#v62-6-0

2020-01-29 16:25:41

其他回答

交叉张贴我从这个SO问题的答案，另一个简单的，pip版本证明解决方案。

try:  # for pip >= 10
    from pip._internal.req import parse_requirements
    from pip._internal.download import PipSession
except ImportError:  # for pip <= 9.0.3
    from pip.req import parse_requirements
    from pip.download import PipSession

requirements = parse_requirements(os.path.join(os.path.dirname(__file__), 'requirements.txt'), session=PipSession())

if __name__ == '__main__':
    setup(
        ...
        install_requires=[str(requirement.req) for requirement in requirements],
        ...
    )

然后把所有的需求放在项目根目录下的requirements.txt下。

2019-07-24 21:53:49

需求文件使用扩展的pip格式，这只在您需要用更强的约束来补充setup.py时有用，例如指定某些依赖项必须来自的确切url，或者pip freeze的输出将整个包集冻结为已知的工作版本。如果不需要额外的约束，则只使用setup.py。如果你觉得你真的需要发布一个requirements.txt，你可以让它变成一行:

它将是有效的，并准确地引用同一目录下的setup.py的内容。

2013-09-29 17:48:42

我是这样做的:

import re

def requirements(filename):
    with open(filename) as f:
        ll = f.read().splitlines()
    d = {}
    for l in ll:
        k, v = re.split(r'==|>=', l)
        d[k] = v
    return d

def packageInfo():
    try:
        from pip._internal.operations import freeze
    except ImportError:
        from pip.operations import freeze

    d = {}
    for kv in freeze.freeze():
        k, v = re.split(r'==|>=', kv)
        d[k] = v
    return d

req = getpackver('requirements.txt')
pkginfo = packageInfo()

for k, v in req.items():
    print(f'{k:<16}: {v:<6} -> {pkginfo[k]}')

2020-03-24 03:38:46

它不能接受文件句柄。install_requires参数只能是字符串或字符串列表。

当然，您可以在设置脚本中读取您的文件，并将其作为字符串列表传递给install_requires。

import os
from setuptools import setup

with open('requirements.txt') as f:
    required = f.read().splitlines()

setup(...
install_requires=required,
...)

2013-01-18 13:14:47