【问题标题】:Best practices: how do you list required dependencies in your setup.py?最佳实践:如何在 setup.py 中列出所需的依赖项?
【发布时间】:2013-03-15 00:09:33
【问题描述】:

这就是我目前的做法:

import os
from setuptools import setup, find_packages
here = os.path.abspath(os.path.dirname(__file__))

requires = [
    'pyramid',
    'pyramid_debugtoolbar',
    'waitress',
    'requests',
    'mock',
    'gunicorn',
    'mongoengine',
    ]

setup(name='repoapi',
      version='0.0',
      description='repoapi',
      packages=find_packages(),
      include_package_data=True,
      zip_safe=False,
      install_requires=requires,
      tests_require=requires,
      test_suite="repoapi",
      entry_points="""\
      [paste.app_factory]
      main = repoapi:main
      """,
      )

这是一个好的方法吗?我有一些麻烦。例如,对于金字塔,我不能使用系统范围的 nosetests 插件来运行测试。我需要在全局 python 站点包中安装pyramid!

但我不希望那样。所以我必须在这个项目的virtualenv中安装nose。但我不希望它成为依赖项。我觉得它不应该属于requires。它不是。然而,我也不想一直手动安装。是的,我知道我有很多我不想做这个和那个......

但是你将如何解决这个问题?我不想篡改全局 python 站点包,但我想将鼻子安装为 virtualenv 的一部分。

另外,pip 安装要求文件。它稍微准确一点,因为我不需要手动指定版本,也不需要害怕手动更新 setup.py。只需抛出 pip freeze > file.txt 即可。

但是,pip 可以返回垃圾,因为我们将垃圾包扔到 virtualenv 中。

这么多刀片。最佳做法是什么?你如何处理这些问题?

也许我错过了,但是https://github.com/django/django/blob/master/setup.py,Django 是怎么做到的?

【问题讨论】:

标签: python


【解决方案1】:

您可以将您的需求拆分为“安装”依赖项和“测试”依赖项,如下所示:

import os
from setuptools import setup, find_packages
here = os.path.abspath(os.path.dirname(__file__))

install_requires = [
    'pyramid',
    'pyramid_debugtoolbar',
    'waitress',
    'requests',
    'gunicorn',
    'mongoengine',
    ]

tests_require = [
    'mock',
    'nose',
    ]

setup(name='repoapi',
      ...
      install_requires=install_requires,
      tests_require=tests_require,
      test_suite="nose.collector",
      ...
      )

这样,当有人安装包时,只安装“安装”依赖项。因此,如果有人只想使用该包(并且他们对运行测试不感兴趣),那么他们不必安装测试依赖项。

当你确实想运行测试时,你可以使用这个:

$ python setup.py test

根据docs:

请注意,这些必需的项目不会安装在运行测试的系统上,而只会在本地尚未安装的情况下下载到项目的安装目录。

一旦“test”依赖项就位,它将运行“test_suite”命令。由于您提到鼻子是您首选的测试运行器,因此我向您展示了 use "nose.collector" 是如何配置它的。

顺便说一下,Django setup.py 并不是了解 setuptools 基础知识的最简洁示例。我认为Sentry setup.py 是一个更好的学习例子。

【讨论】:

  • 感谢分享。但是鼻子不会真正安装到virtualenv中吗?所以归根结底,最佳实践仍然是文档,保持 setup.py 同步的错误票?谢谢。
  • 感谢您链接到tests_require 的文档。在 Python 中有很多难以管理的依赖项。在我最初提到的文档中找不到该属性:packaging.python.org/guides/…
  • 如果我想安装测试依赖项但还没有运行测试怎么办?有python setup.py install --all 选项吗?
  • setuptools tests_require 是 deprecated since 41.5.0(2019 年 10 月)。我们现在是 50.3.0。
【解决方案2】:

如果您使用的是需求文件,那么另一种方法是读取它们的内容而不是复制它:

import pathlib
from setuptools import setup, find_packages

HERE = pathlib.Path(__file__).parent
INSTALL_REQUIRES = (HERE / "requirements.txt").read_text().splitlines()
TESTS_REQUIRE = (HERE / "test-requirements.txt").read_text().splitlines()[1:]

setup(...,
      install_requires=INSTALL_REQUIRES,
      tests_require=TESTS_REQUIRE,
      ...
      )

我发现这种方法更稳定,更不容易出错,因为有时需求会发生变化,而且人们经常忘记更新两个地方。

注意:注意TESTS_REQUIRE从第二行开始,这是因为test-requirements.txt的第一行通常是-r requirements.txt。如果您的情况不同,请随意更改。

【讨论】:

  • setuptools tests_require 是 deprecated since 41.5.0(2019 年 10 月)。我们现在是 50.3.0。
  • @MartinThoma 那么我们应该改用什么?文档似乎没有说。
  • 只需记录如何运行测试,例如在自述文件中
  • Pytest 是最常见的选择。 tox 也是众所周知的。如果我看到 pytest.ini 或 tox.ini 我会知道如何运行测试。
猜你喜欢
  • 2011-10-15
  • 2019-08-24
  • 2011-08-16
  • 2017-12-09
  • 1970-01-01
  • 2018-10-04
  • 2018-03-03
  • 2011-06-11
  • 2010-12-11
相关资源
最近更新 更多