Tox是一个项目自动化工具,在此记录下没在文档和网上tutorial找到的使用细节。试验中尽可能使用最小tox.ini。本文使用tox --showconfig -- <args...>的形式观察配置结果。如果文中没有提<args...>是什么(例如直接说“配置结果为”,而不是“运行…后配置结果为“),那么运行的是tox --showconfig

默认basepython

情况一

tox.ini为空。此时只有一个匿名虚拟环境。

配置结果为:

...

[testenv:python]
...
basepython = /Library/Frameworks/Python.framework/Versions/3.9/bin/python3
...

这里的/Library/Frameworks/Python.framework/Versions/3.9/bin/python3是本机上按PATH顺序第一个遇到的Python解释器(注意这里既不是第一个python也不是第一个python3)。另外可以观察到,匿名虚拟环境被命名为python

情况二

tox.ini

[testenv:x]

此时只有一个名为x的虚拟环境,x不与文档中的任何一种特殊命名匹配。配置结果为

...

[testenv:x]
...
basepython = /Library/Frameworks/Python.framework/Versions/3.9/bin/python3
...

可见与情况一相同。

情况三

tox.ini

[testenv:py28]

此时只有一个名为py28的虚拟环境。配置结果为

...

[testenv:py28]
...
basepython = python2.8
...

我们知道是没有python2.8的,可见tox这里只是做了一个简单的从pyMNpythonM.N的映射。此时如果运行tox的话是要报错的(即使tox.ini里加上skipsdist = true也会报错):ERROR: InterpreterNotFound: python2.8

情况四

tox.ini

[testenv:py28]
basepython = python2.7

与情况三相同,但显式指定了basepython。配置结果为

...

[testenv:py28]
...
basepython = python2.7
...

可见显式指定的basepython生效了。

{posargs}展开

情况一

tox.ini

[testenv]
commands = {posargs}

运行tox --showconfig后(无参数),配置结果为

...
commands = [[]]
...

可见{posargs}在无参数时展开为空字符串。

运行tox --showconfig -- hello world后(带参数),配置结果为

...
commands = [['hello', 'world']]
...

{toxinidir}下新建两个文件hello1hello2,然后运行tox --showconfig -- hello*后(注意这里的运行环境不是Windows),配置结果为

...
commands = [['hello1', 'hello2']]
...

这是符合期望的,因为Shell在传参前先做了Globbing,然而如果运行tox --showconfig -- "hello*"后,配置结果为

...
commands = [['hello*']]
...

可见{posargs}不会做Globbing。

举一个运行tox的例子。令tox.ini

[tox]
skipsdist = true

[testenv]
allowlist_externals = ls
commands = ls {posargs}

如果运行tox -- "hello*",我们会得到结果

python run-test-pre: PYTHONHASHSEED='2558120981'
python run-test: commands[0] | ls 'hello*'
ls: hello*: No such file or directory
ERROR: InvocationError for command /bin/ls 'hello*' (exited with code 1)
_________________________ summary __________________________
ERROR:   python: commands failed

情况二

tox.ini

[testenv]
commands = "{posargs}"

注意{posargs}两边的引号。运行tox --showconfig后(无参数),配置结果为

...
commands = [['']]
...

可见虽然{posargs}在无参数时展开为空字符串,但现在有引号,导致仍产生了一个参数,只不过该参数值为空。

运行tox --showconfig -- hello后(一个参数),配置结果为

...
commands = [['hello']]
...

没什么值得惊讶的。

运行tox --showconfig -- hello world后(多参数),配置结果为

...
commands = [['hello world']]
...

可见虽然{posargs}展开成了两个参数,但是引号又重新把它们括成了一个参数。