Python 任務(wù)自動(dòng)化工具 tox 教程

在我剛翻譯完的 Python 打包系列文章中，作者提到了一個(gè)神奇的測(cè)試工具 tox，而且他本人就是 tox 的維護(hù)者之一。趁著話題的相關(guān)性，本文將對(duì)它做簡(jiǎn)單的介紹，說不定大家在開發(fā)項(xiàng)目時(shí)能夠用得上。

Command line driven CI frontend and development task automation tool

命令行驅(qū)動(dòng)的 CI 前端和開發(fā)任務(wù)自動(dòng)化工具

tox 的項(xiàng)目地址是：https://github.com/tox-dev/tox

其核心作用是支持創(chuàng)建隔離的 Python 環(huán)境，在里面可以安裝不同版本的 Python 解釋器與各種依賴庫(kù)，以此方便開發(fā)者做自動(dòng)化測(cè)試、打包、持續(xù)集成等事情。

簡(jiǎn)單來說，tox 是一個(gè)管理測(cè)試虛擬環(huán)境的命令行工具。它已存在多年且廣被開發(fā)者們使用，例如，著名的云計(jì)算平臺(tái) OpenStack 也采用了它，作為最基礎(chǔ)的測(cè)試工具之一。

1、tox 能做什么？

• 創(chuàng)建開發(fā)環(huán)境
• 運(yùn)行靜態(tài)代碼分析與測(cè)試工具
• 自動(dòng)化構(gòu)建包
• 針對(duì) tox 構(gòu)建的軟件包運(yùn)行測(cè)試
• 檢查軟件包是否能在不同的 Python 版本/解釋器中順利安裝
• 統(tǒng)一持續(xù)集成（CI）和基于命令行的測(cè)試
• 創(chuàng)建和部署項(xiàng)目文檔
• 將軟件包發(fā)布到 PyPI 或任何其它平臺(tái)

tox 官方文檔中列出了 40 余種使用場(chǎng)景的示例，詳細(xì)的列表可查看：https://tox.readthedocs.io/en/latest/examples.html

2、tox 怎么配置？

關(guān)于它的用法：使用pip install tox 安裝，使用tox 運(yùn)行全部測(cè)試環(huán)境，和tox -e envname 運(yùn)行指定的環(huán)境。還有不少的命令行參數(shù)，通過tox -h 查看。

1. pyproject.toml
2. tox.ini
3. setup.cfg

以 tox 項(xiàng)目自己的 tox.ini 配置內(nèi)容為例，可以看到它是這樣配置的（https://github.com/tox-dev/tox/blob/master/tox.ini）：

每個(gè)[xxx]及其下方內(nèi)容組成一個(gè)章節(jié)（section），每個(gè)章節(jié)間使用空行作間隔。

[tox]下面是全局性的配置項(xiàng)，envlist 字段定義了 tox 去操作的環(huán)境。[xxx]下面是 xxx 虛擬環(huán)境的配置項(xiàng)，[xxx:yyy]繼承 xxx 的配置，同時(shí)其自身配置項(xiàng)的優(yōu)先級(jí)更高。

對(duì)于每個(gè)虛擬環(huán)境，可用的配置項(xiàng)很多，例如常用的有：description（描述信息）、basepython（Python解釋器版本）、deps（環(huán)境依賴項(xiàng)）、commands（命令語(yǔ)句）等等。

tox 還支持作變量替換，它提供了一些內(nèi)置的基礎(chǔ)變量（全局的或?qū)τ谔摂M環(huán)境的）：{toxinidir}、{homedir}、{envname}、{envdir}等等。

• 取操作系統(tǒng)的環(huán)境變量：{env:KEY}，效果等同于os.environ['KEY'] 。可以變化成：{env:KEY:DEFAULTVALUE}，在取不到環(huán)境變量時(shí)則使用默認(rèn)值；{env:KEY:{env:DEFAULT_OF_KEY}}，達(dá)到 if-else 的取值效果
• 傳遞命令行參數(shù)：{posargs:DEFAULTS}，當(dāng)沒有命令行參數(shù)時(shí)，使用 DEFAULTS 值。使用方式：tox arg1 arg2 傳兩個(gè)參，或者tox -- --opt1 arg1 將“-- opt1 arg1”作為整體傳入。
• 章節(jié)間傳值：{[sectionname]valuename}，不同章節(jié)的內(nèi)容可以傳遞使用。

• 交互式控制臺(tái)注入：{tty:ON_VALUE:OFF_VALUE}，當(dāng)交互式 shell 控制臺(tái)開啟時(shí)，使用第一個(gè)值，否則使用第二個(gè)。pytest 在使用“--pdb”時(shí)，是這樣的例子。

花括號(hào)“{}”除了可以做變量替換使用，它還可以作為“或關(guān)系”判斷的取值。直接看下面的例子：

[tox]
envlist = {py27,py36}-django{15,16}

{py27,py36}-django{15,16} 的 2 組花括號(hào)內(nèi)各有 2 個(gè)值，它們實(shí)際可以組合成 4 個(gè)環(huán)境：py27-django15、py27-django16、py36-django15、py36-django16。

關(guān)于 tox 有哪些配置項(xiàng)、使用條件、什么含義、高級(jí)用法等等內(nèi)容，可在官方文檔中查看：https://tox.readthedocs.io/en/latest/config.html

3、tox 的插件化

除了自身強(qiáng)大的可配置性，tox 還具有很強(qiáng)的可擴(kuò)展性，它是可插拔的（pluggable），圍繞它產(chǎn)生了一個(gè)極為豐富的插件生態(tài)。

使用pip search tox ，可以看到數(shù)量眾多的“tox-”開頭的庫(kù)，它們都是 tox 的插件包。其中不乏 setuptools、pipenv、conda、travis、pytest、docker 等被大家熟知的名字。

tox 開放了挺多的 API 接口，方便其他人定制開發(fā)插件。

4、tox 的工作流程

接下來看看 tox 是怎么運(yùn)作的：

• 配置（從figuration）：加載配置文件（如 tox.ini），解析命令行參數(shù)，讀取系統(tǒng)環(huán)境變量等
• 打包（packaging）：可選的，對(duì)于帶有 setup.py 文件的項(xiàng)目，可以在這步去生成它的源發(fā)行版
• 創(chuàng)建虛擬環(huán)境：默認(rèn)使用 virtualenv 來創(chuàng)建虛擬環(huán)境，并根據(jù)配置項(xiàng)中的“deps”安裝所需的依賴項(xiàng)，然后執(zhí)行配置好的命令（commands）

• 報(bào)告（report）：匯總所有虛擬環(huán)境的運(yùn)行結(jié)果并羅列出來

5、小結(jié)

tox 本身定位是一個(gè)測(cè)試工具，它試圖令 Pytho 測(cè)試工作變得自動(dòng)化、標(biāo)準(zhǔn)化與流程化。但跟 unittest 和 pytest 這些測(cè)試框架不同，它作用的是代碼層面之外的事情，是一種項(xiàng)目級(jí)的工具。因此，它需要跟這些測(cè)試框架相結(jié)合，或者同時(shí)處理多種自動(dòng)化任務(wù)（如跑 pep8、測(cè)代碼覆蓋率、生成文檔等等），這樣才能更好地發(fā)揮它的價(jià)值。

它的一大特色在于創(chuàng)建/管理虛擬環(huán)境，但這只是為了方便測(cè)試而使用的手段，因此相比其它可管理虛擬環(huán)境的工具，如 Virtualenvwrapper、conda、pipenv、poetry，它在某些方面就存在著不足。

tox 還有強(qiáng)大的可配置性與豐富的插件支持，這使得它在運(yùn)用上具有很大的可能性與自由度。因此，不少忠實(shí)開發(fā)者仍在持續(xù)地在使用它，比如，我剛翻譯好的系列文章的作者就是它的維護(hù)者之一。

我們的文章到此就結(jié)束啦，如果你喜歡今天的Python 實(shí)戰(zhàn)教程，請(qǐng)持續(xù)關(guān)注Python實(shí)用寶典。

有任何問題，可以在公眾號(hào)后臺(tái)回復(fù)：加群，回答相應(yīng)紅字驗(yàn)證信息，進(jìn)入互助群詢問。

原創(chuàng)不易，希望你能在下面點(diǎn)個(gè)贊和在看支持我繼續(xù)創(chuàng)作，謝謝！

點(diǎn)擊下方閱讀原文可獲得更好的閱讀體驗(yàn)

Python實(shí)用寶典 (pythondict.com)
不只是一個(gè)寶典
歡迎關(guān)注公眾號(hào)：Python實(shí)用寶典