使用Tox复制setup.py依赖项

时间:2017-12-21 12:44:54

标签: python testing setuptools tox

setup.py通常取决于几个外部文件,最明显的是README.md long_descriptionVERSION version。 e.g。

root = os.path.dirname(os.path.abspath(__file__))
setuptools.setup(
    name             = 'package',
    version          = open(os.path.join(root, 'VERSION')).read().strip(),
    description      = 'A Simple Package',
    long_description = open(os.path.join(root, 'README.md')).read().strip(),
    # ...
)

但是,在尝试使用tox在此类程序包上运行测试时,出现以下错误:

ERROR: invocation failed (exit code 1), logfile: 
.tox/py36/log/py36-6.log
ERROR: actionid: py36
msg: installpkg
cmdargs: 
['.tox/py36/bin/pip', 'install', '-U', '--no-deps', '.tox/dist/package-0.1.0.zip']

Processing ./.tox/dist/package-0.1.0.zip
    Complete output from command python setup.py egg_info:
    Traceback (most recent call last):
      File "<string>", line 1, in <module>
      File "setup.py", line 10, in <module>
        version          = open(os.path.join(root, 'VERSION')).read().strip(),
    FileNotFoundError: [Errno 2] No such file or directory: 'VERSION'

(或与README.md类似的消息)。显然,tox只复制setup.py,当它试图运行它时,它的依赖关系丢失了,它不起作用。

我查看了文档,但我似乎找不到告诉tox复制这些文件的方法。有办法吗?

修改

这是我的目录结构和相关文件:

$ ls
package/   tests/   README.md    VERSION   setup.py    tox.ini

$ cat tox.ini
[tox]
envlist = py36
[testenv]
deps     = pytest
commands = pytest tests

$ cat setup.py
import os
import setuptools
root = os.path.dirname(os.path.abspath(__file__))
setuptools.setup(
    name             = 'package',
    version          = open(os.path.join(root, 'VERSION')).read().strip(),
    description      = 'A Simple Package',
    long_description = open(os.path.join(root, 'README.md')).read().strip(),
    packages         = setuptools.find_packages(),
)

(如果我使用相对路径,也会发生同样的情况,例如open('README.md')。)

2 个答案:

答案 0 :(得分:2)

原来它不是tox问题,而是setuptools问题(或者更确切地说,我没有正确使用它)。我在这里发布答案,以防其他人在将来遇到类似的问题。

tox创建一个源代码分发(即python setup.py sdist),然后将其安装在虚拟环境中,然后运行测试。 此分发缺少VERSIONREADME.md个文件,因为setuptools不包含任何非标准内容默认情况下的文件即:

# create a source distribution
$ python setup.py sdist

# extract it
$ cd dist/
$ tar xfz package-0.1.0.tar.gz

# check it out
$ ls package-0.1.0
package    package.egg-info   PKG-INFO   setup.cfg   setup.py

# no VERSION or README.md :(

要包含非标准文件,请添加MANIFEST.in文件,如下所示:

include VERSION
include README.md

告诉setuptools在分发中包含这些文件,并使tox按预期工作。

答案 1 :(得分:2)

您使用的是哪个版本的setuptools

我遇到了类似的问题,升级setuptools修复了该问题。

version 36.4.0开始,似乎自动完成了README.md的添加。但是,VERSION文件必须包含在MANIFEST.in文件中。