快捷導(dǎo)航

淺談Python任務(wù)自動(dòng)化工具Tox基本用法

更新時(shí)間：2022年06月22日 11:37:01 作者：馬踏飛燕&lin_li

這篇文章主要介紹了淺談Python任務(wù)自動(dòng)化工具Tox,tox 是一個(gè)管理測(cè)試虛擬環(huán)境的命令行工具，它已存在多年且廣被開(kāi)發(fā)者們使用，對(duì)Python任務(wù)自動(dòng)化工具Tox基本用法感興趣的朋友一起看看吧

淺談Python任務(wù)自動(dòng)化工具Tox

引言：

最近在搜集github上包含測(cè)試樣例的Python項(xiàng)目，并試圖在docker環(huán)境下跑通這些項(xiàng)目，發(fā)現(xiàn)這些項(xiàng)目主要使用的測(cè)試框架有： unittest, pytest ,nosetest。還有一些用到了自動(dòng)化工具Tox，所以簡(jiǎn)單了解了一下。

簡(jiǎn)介：

Command line driven CI frontend and development task automation tool
命令行驅(qū)動(dòng)的 CI 前端和開(kāi)發(fā)任務(wù)自動(dòng)化工具

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

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

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

基本用法：

安裝

pip install tox

將有關(guān)項(xiàng)目和希望項(xiàng)目在其中運(yùn)行的測(cè)試環(huán)境的基本信息放入應(yīng)位于文件旁邊的文件中：tox.ini setup.py

# content of: tox.ini , put in same dir as setup.py
[tox]
envlist = py27,py36
[testenv]
# install testing framework
# ... or install anything else you might need here
deps = pytest
# run the tests
# ... or run any other command line tool you need to run here
commands = pytest

若要打包、安裝和測(cè)試項(xiàng)目，現(xiàn)在可以在命令提示符下鍵入：

tox

配置文件：

tox 的行為由其配置文件控制，當(dāng)前它支持 3 種配置文件：

pyproject.toml
tox.ini
setup.cfg

我們以**python-project-wizard**項(xiàng)目為例，看一下開(kāi)發(fā)人員寫(xiě)的tox配置文件。

pyproject.toml

[tool]
[tool.poetry]
name = "ppw"
version = "1.1.1"
description = "A Wizard to create a skeleton python project with up-to-date technology"
license = "BSD-3-Clause"
authors = ["Aaron Yang <aaron_yang@jieyu.ai>"]
readme = "README.md"
repository = "https://github.com/zillionare/cookiecutter-pypackage"
documentation = "https://zillionare.github.io/cookiecutter-pypackage/"
keywords = ['cookiecutter', 'template', 'package']
packages = [
  {include = "ppw"}
]

include = [
  '{{cookiecutter.project_slug}}/**/*',
  'cookiecutter.json',
  'hooks/*'
]

[tool.poetry.dependencies]
python = ">=3.7,<4.0"
cookiecutter = "1.7.2"

pytest = {version = "^5.4.3", optional=true}
pytest-cookies = {version = "^0.5.1", optional=true}
pyyaml = {version="^5.3.1",optional=true}
mkdocs = {version="^1.1.2",optional=true}
mkdocs-material = {version="^6.1.7",optional=true}
mkdocs-material-extensions = {version="^1.0.1",optional=true}
pytest-cov = {version="^2.10.1",optional=true}
tox = {version = "^3.20.1", optional=true}
mkdocs-include-markdown-plugin = {version = "^2.8.0", optional=true}
fire = {version="^0.4.0", optional=true}
pre-commit = {version="^2.18.1",optional=true}

[tool.poetry.extras]
dev = [
  "pytest",
  "pytest-cookies",
  "pyyaml",
  "mkdocs",
  "mkdocs-material",
  "mkdocs-material-extensions",
  "pytest-cov",
  "tox",
  "mkdocs-include-markdown-plugin",
  "fire"
]

[tool.black]
line-length = 88
include = '\.pyi?$'
exclude = '''
/(
    \.eggs
  | \.git
  | \.hg
  | \.mypy_cache
  | \.tox
  | \.venv
  | _build
  | buck-out
  | build
  | dist
)/
'''

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

[tool.poetry.scripts]
ppw = 'ppw.cli:main'

INI（.ini）文件是一種非常原始的基礎(chǔ)形式，但各家有各家的用法，而且它最多只能解決一層嵌套。只適合非常非常簡(jiǎn)單的配置文件，一旦需要兩層嵌套，或需要數(shù)組，就力不從心了。
終于，TOML（.toml）橫空出世。它徹底放棄了括號(hào)或縮進(jìn)的底層原理，而是采取了顯式鍵名鏈的方式。

tox.ini

[tox]
envlist = py37,py38,py39,py310, docs
isolated_build = True

[gh-actions]
python =
    3.7: py37
    3.8: py38, docs
    3.9: py39
    3.10: py310

[testenv:docs]
basepython=python
allowlist_externals = mkdocs
commands= mkdocs build

[testenv]
extras =
    dev

setenv =
    PYTHONPATH = {toxinidir}

commands = pytest -s --cov-report=term-missing tests

每個(gè)[xxx]及其下方內(nèi)容組成一個(gè)章節(jié)（section），每個(gè)章節(jié)間使用空行作間隔。
[tox]下面是全局性的配置項(xiàng)
[xxx:yyy]繼承 xxx 的配置，同時(shí)其自身配置項(xiàng)的優(yōu)先級(jí)更高。
對(duì)于每個(gè)虛擬環(huán)境，可用的配置項(xiàng)很多，例如常用的有：description（描述信息）、basepython（Python解釋器版本）、deps（環(huán)境依賴(lài)項(xiàng)）、commands（命令語(yǔ)句）等等。

tox 的工作流程:

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

安裝：

使用tox-quickstart快速生成tox.ini，也可以根據(jù)模板手寫(xiě)tox.ini文件

使用：

配置好文件后，可以tox 直接運(yùn)行，也可以tox -e test_api
如果在其他目錄下運(yùn)行，則需要tox -c /test/tox.ini -c是指定配置文件的意思

小結(jié)：

tox 本身定位是一個(gè)測(cè)試工具，它試圖令 Python 測(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，它在某些方面就存在著不足。

到此這篇關(guān)于淺談Python任務(wù)自動(dòng)化工具Tox的文章就介紹到這了,更多相關(guān)Python任務(wù)自動(dòng)化工具Tox內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: