Python任务自动化工具tox使用教程


Posted in Python onMarch 17, 2020

1、tox 能做什么?

细分的用途包括:

  • 创建开发环境
  • 运行静态代码分析与测试工具
  • 自动化构建包
  • 针对 tox 构建的软件包运行测试
  • 检查软件包是否能在不同的 Python 版本/解释器中顺利安装
  • 统一持续集成(CI)和基于命令行的测试
  • 创建和部署项目文档
  • 将软件包发布到 PyPI 或任何其它平台

tox 官方文档中列出了 40 余种使用场景的示例,详细的列表可查看:

https://tox.readthedocs.io/en/latest/examples.html

Python任务自动化工具tox使用教程

2、tox 怎么配置?

关于它的用法:使用pip install tox安装,使用tox运行全部测试环境,和tox -e envname运行指定的环境。还有不少的命令行参数,通过tox -h查看。

tox 的行为由其配置文件控制,当前它支持 3 种配置文件:

pyproject.tomltox.inisetup.cfg

以 tox 项目自己的 tox.ini 配置内容为例,可以看到它是这样配置的(https://github.com/tox-dev/tox/blob/master/tox.ini):

Python任务自动化工具tox使用教程

Python任务自动化工具tox使用教程

每个[xxx]及其下方内容组成一个章节(section),每个章节间使用空行作间隔。

[tox]下面是全局性的配置项,envlist 字段定义了 tox 去操作的环境。[xxx]下面是 xxx 虚拟环境的配置项,[xxx:yyy]继承 xxx 的配置,同时其自身配置项的优先级更高。

对于每个虚拟环境,可用的配置项很多,例如常用的有:description(描述信息)、basepython(Python解释器版本)、deps(环境依赖项)、commands(命令语句)等等。

tox 还支持作变量替换,它提供了一些内置的基础变量(全局的或对于虚拟环境的):{toxinidir}、{homedir}、{envname}、{envdir}等等。

除了基础性的变量替换,它还支持这些高级用法:

  • 取操作系统的环境变量:{env:KEY},效果等同于os.environ['KEY'] 。可以变化成:{env:KEY:DEFAULTVALUE},在取不到环境变量时则使用默认值;{env:KEY:{env:DEFAULT_OF_KEY}},达到 if-else 的取值效果
  • 传递命令行参数:{posargs:DEFAULTS},当没有命令行参数时,使用 DEFAULTS 值。使用方式:tox arg1 arg2 传两个参,或者tox -- --opt1 arg1 将“-- opt1 arg1”作为整体传入。
  • 章节间传值:{[sectionname]valuename},不同章节的内容可以传递使用。
  • 交互式控制台注入:{tty:ON_VALUE:OFF_VALUE},当交互式 shell 控制台开启时,使用第一个值,否则使用第二个。pytest 在使用“--pdb”时,是这样的例子。

花括号“{}”除了可以做变量替换使用,它还可以作为“或关系”判断的取值。直接看下面的例子:

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

{py27,py36}-django{15,16} 的 2 组花括号内各有 2 个值,它们实际可以组合成 4 个环境:py27-django15、py27-django16、py36-django15、py36-django16。

关于 tox 有哪些配置项、使用条件、什么含义、高级用法等等内容,可在官方文档中查看:

https://tox.readthedocs.io/en/latest/config.html

3、tox 的插件化

除了自身强大的可配置性,tox 还具有很强的可扩展性,它是可插拔的(pluggable),围绕它产生了一个极为丰富的插件生态。

使用pip search tox,可以看到数量众多的“tox-”开头的库,它们都是 tox 的插件包。其中不乏 setuptools、pipenv、conda、travis、pytest、docker 等被大家熟知的名字。

Python任务自动化工具tox使用教程

tox 开放了挺多的 API 接口,方便其他人定制开发插件。

Python任务自动化工具tox使用教程

4、tox 的工作流程

接下来看看 tox 是怎么运作的:

Python任务自动化工具tox使用教程

其工作流程中主要的环节有:

配置(从figuration):加载配置文件(如 tox.ini),解析命令行参数,读取系统环境变量等打包(packaging):可选的,对于带有 setup.py 文件的项目,可以在这步去生成它的源发行版创建虚拟环境:默认使用 virtualenv 来创建虚拟环境,并根据配置项中的“deps”安装所需的依赖项,然后执行配置好的命令(commands)

报告(report):汇总所有虚拟环境的运行结果并罗列出来

5、小结

tox 本身定位是一个测试工具,它试图令 Pytho 测试工作变得自动化、标准化与流程化。但跟 unittest 和 pytest 这些测试框架不同,它作用的是代码层面之外的事情,是一种项目级的工具。因此,它需要跟这些测试框架相结合,或者同时处理多种自动化任务(如跑 pep8、测代码覆盖率、生成文档等等),这样才能更好地发挥它的价值。

它的一大特色在于创建/管理虚拟环境,但这只是为了方便测试而使用的手段,因此相比其它可管理虚拟环境的工具,如 Virtualenvwrapper、conda、pipenv、poetry,它在某些方面就存在着不足。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
Python中操作文件之write()方法的使用教程
May 25 Python
Centos Python2 升级到Python3的简单实现
Jun 21 Python
在PyCharm环境中使用Jupyter Notebook的两种方法总结
May 24 Python
Python DataFrame 设置输出不显示index(索引)值的方法
Jun 07 Python
Python中的取模运算方法
Nov 10 Python
python字符串常用方法及文件简单读写的操作方法
Mar 04 Python
Python3交互式shell ipython3安装及使用详解
Jul 11 Python
如何基于python把文字图片写入word文档
Jul 31 Python
聊聊python中的循环遍历
Sep 07 Python
Django 权限管理(permissions)与用户组(group)详解
Nov 30 Python
pyx文件 生成pyd 文件用于 cython调用的实现
Mar 04 Python
Python 装饰器(decorator)常用的创建方式及解析
Apr 24 Python
vue常用指令代码实例总结
Mar 16 #Python
django-利用session机制实现唯一登录的例子
Mar 16 #Python
python安装dlib库报错问题及解决方法
Mar 16 #Python
使用python图形模块turtle库绘制樱花、玫瑰、圣诞树代码实例
Mar 16 #Python
关于win10在tensorflow的安装及在pycharm中运行步骤详解
Mar 16 #Python
Python3.6 中的pyinstaller安装和使用教程
Mar 16 #Python
python pandas利用fillna方法实现部分自动填充功能
Mar 16 #Python
You might like
Apache, PHP在Windows 9x/NT下的安装与配置 (二)
2006/10/09 PHP
php adodb连接mssql解决乱码问题
2009/06/12 PHP
PHP屏蔽过滤指定关键字的方法
2014/11/03 PHP
一些mootools的学习资源
2010/02/07 Javascript
js控制容器隐藏出现防止样式变化的两种方法
2014/04/25 Javascript
jQuery mobile转换url地址及获取url中目录部分的方法
2015/12/04 Javascript
Javascript中的几种继承方式对比分析
2016/03/22 Javascript
jQuery 跨域访问解决原理案例详解
2016/07/09 Javascript
轻松掌握JavaScript装饰者模式
2016/08/27 Javascript
JavaScript函数柯里化原理与用法分析
2017/03/31 Javascript
jquery 一键复制到剪切板的实例
2017/09/20 jQuery
深入理解Vue Computed计算属性原理
2018/05/29 Javascript
vue.js引入外部CSS样式和外部JS文件的方法
2019/01/06 Javascript
Vue唯一可以更改vuex实例中state数据状态的属性对象Mutation的讲解
2019/01/18 Javascript
vue框架制作购物车小球动画效果实例代码
2019/09/26 Javascript
vue实现列表滚动的过渡动画
2020/06/29 Javascript
如何搭建一个完整的Vue3.0+ts的项目步骤
2020/10/18 Javascript
[05:08]顺网杯ISS-DOTA2赛歌 少女偶像Lunar青春演绎
2013/12/05 DOTA
[01:08]DOTA2次级职业联赛 - Wings 战队宣传片
2014/12/01 DOTA
python文件和目录操作方法大全(含实例)
2014/03/12 Python
python搜索指定目录的方法
2015/04/29 Python
浅谈pandas用groupby后对层级索引levels的处理方法
2018/11/06 Python
学习和使用python的13个理由
2019/07/30 Python
python实现简单银行管理系统
2019/10/25 Python
解决python 找不到module的问题
2020/02/12 Python
Boden美国官网:英伦原创时装品牌
2017/07/03 全球购物
什么是java序列化,如何实现java序列化
2012/11/14 面试题
关于Java finally的面试题
2016/04/27 面试题
统计学专业毕业生的自我评价分享
2013/11/28 职场文书
客服工作职责
2013/12/11 职场文书
六一节目主持词
2014/04/01 职场文书
统计专业自荐书
2014/07/06 职场文书
爱国教育主题班会
2015/08/14 职场文书
《大禹治水》教学反思
2016/02/22 职场文书
python geopandas读取、创建shapefile文件的方法
2021/06/29 Python
MySQL实现字段分割一行转多行的示例代码
2022/07/07 MySQL