Python任務(wù)自動(dòng)化工具tox使用教程
1、tox 能做什么?
細(xì)分的用途包括:
創(chuàng)建開發(fā)環(huán)境 運(yùn)行靜態(tài)代碼分析與測試工具 自動(dòng)化構(gòu)建包 針對 tox 構(gòu)建的軟件包運(yùn)行測試 檢查軟件包是否能在不同的 Python 版本/解釋器中順利安裝 統(tǒng)一持續(xù)集成(CI)和基于命令行的測試 創(chuàng)建和部署項(xiàng)目文檔 將軟件包發(fā)布到 PyPI 或任何其它平臺(tái)tox 官方文檔中列出了 40 余種使用場景的示例,詳細(xì)的列表可查看:
https://tox.readthedocs.io/en/latest/examples.html
2、tox 怎么配置?
關(guān)于它的用法:使用pip install tox安裝,使用tox運(yùn)行全部測試環(huán)境,和tox -e envname運(yùn)行指定的環(huán)境。還有不少的命令行參數(shù),通過tox -h查看。
tox 的行為由其配置文件控制,當(dāng)前它支持 3 種配置文件:
pyproject.tomltox.inisetup.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)先級更高。
對于每個(gè)虛擬環(huán)境,可用的配置項(xiàng)很多,例如常用的有:description(描述信息)、basepython(Python解釋器版本)、deps(環(huán)境依賴項(xiàng))、commands(命令語句)等等。
tox 還支持作變量替換,它提供了一些內(nèi)置的基礎(chǔ)變量(全局的或?qū)τ谔摂M環(huán)境的):{toxinidir}、{homedir}、{envname}、{envdir}等等。
除了基礎(chǔ)性的變量替換,它還支持這些高級用法:
取操作系統(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í),是這樣的例子。花括號“{}”除了可以做變量替換使用,它還可以作為“或關(guān)系”判斷的取值。直接看下面的例子:
[tox]envlist = {py27,py36}-django{15,16}
{py27,py36}-django{15,16} 的 2 組花括號內(nèi)各有 2 個(gè)值,它們實(shí)際可以組合成 4 個(gè)環(huán)境:py27-django15、py27-django16、py36-django15、py36-django16。
關(guān)于 tox 有哪些配置項(xiàng)、使用條件、什么含義、高級用法等等內(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-”開頭的庫,它們都是 tox 的插件包。其中不乏 setuptools、pipenv、conda、travis、pytest、docker 等被大家熟知的名字。
tox 開放了挺多的 API 接口,方便其他人定制開發(fā)插件。
4、tox 的工作流程
接下來看看 tox 是怎么運(yùn)作的:
其工作流程中主要的環(huán)節(jié)有:
配置(從figuration):加載配置文件(如 tox.ini),解析命令行參數(shù),讀取系統(tǒng)環(huán)境變量等打包(packaging):可選的,對于帶有 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è)測試工具,它試圖令 Pytho 測試工作變得自動(dòng)化、標(biāo)準(zhǔn)化與流程化。但跟 unittest 和 pytest 這些測試框架不同,它作用的是代碼層面之外的事情,是一種項(xiàng)目級的工具。因此,它需要跟這些測試框架相結(jié)合,或者同時(shí)處理多種自動(dòng)化任務(wù)(如跑 pep8、測代碼覆蓋率、生成文檔等等),這樣才能更好地發(fā)揮它的價(jià)值。
它的一大特色在于創(chuàng)建/管理虛擬環(huán)境,但這只是為了方便測試而使用的手段,因此相比其它可管理虛擬環(huán)境的工具,如 Virtualenvwrapper、conda、pipenv、poetry,它在某些方面就存在著不足。
以上就是本文的全部內(nèi)容,希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持好吧啦網(wǎng)。
相關(guān)文章:
1. ASP的Global.asa文件技巧用法2. CSS3實(shí)例分享之多重背景的實(shí)現(xiàn)(Multiple backgrounds)3. ASP中if語句、select 、while循環(huán)的使用方法4. ASP中常用的22個(gè)FSO文件操作函數(shù)整理5. SharePoint Server 2019新特性介紹6. 告別AJAX實(shí)現(xiàn)無刷新提交表單7. Vue+elementUI下拉框自定義顏色選擇器方式8. PHP函數(shù)原理理解詳談9. XML入門的常見問題(四)10. 使用css實(shí)現(xiàn)全兼容tooltip提示框
