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 运算符 供重载参考
Jun 11 Python
Python去掉字符串中空格的方法
Mar 11 Python
Python 异常处理实例详解
Mar 12 Python
Python从MP3文件获取id3的方法
Jun 15 Python
python实现下载整个ftp目录的方法
Jan 17 Python
selenium python浏览器多窗口处理代码示例
Jan 15 Python
tensorflow 获取模型所有参数总和数量的方法
Jun 14 Python
flask框架中勾子函数的使用详解
Aug 01 Python
解决python执行不输出系统命令弹框的问题
Jun 24 Python
python3实现二叉树的遍历与递归算法解析(小结)
Jul 03 Python
python 代码实现k-means聚类分析的思路(不使用现成聚类库)
Jun 01 Python
Python如何利用Har文件进行遍历指定字典替换提交的数据详解
Nov 05 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
PHP5.5和之前的版本empty函数的不同之处
2014/06/13 PHP
浅析PHP数据导出知识点
2018/02/17 PHP
javascript 框架小结 个人工作经验
2009/06/13 Javascript
整理8个很棒的 jQuery 倒计时插件和教程
2011/12/12 Javascript
jQuery向上遍历DOM树之parents(),parent(),closest()之间的区别
2013/12/02 Javascript
js中arguments,caller,callee,apply的用法小结
2014/01/28 Javascript
Nodejs极简入门教程(三):进程
2014/10/27 NodeJs
js实现YouKu的漂亮搜索框效果
2015/08/19 Javascript
javascript先序遍历DOM树的方法
2016/02/27 Javascript
浅谈jquery中的each方法$.each、this.each、$.fn.each
2016/06/23 Javascript
详谈jQuery Ajax(load,post,get,ajax)的用法
2017/03/02 Javascript
各种选择框jQuery的选中方法(实例讲解)
2017/06/27 jQuery
angular4自定义组件详解
2017/09/28 Javascript
React Native使用Modal自定义分享界面的示例代码
2017/10/31 Javascript
jQuery实现左右滑动的toggle方法
2018/03/03 jQuery
浅谈JS中this在各个场景下的指向
2019/08/14 Javascript
layui table去掉右侧滑动条的实现方法
2019/09/05 Javascript
详解利用nodejs对本地json文件进行增删改查
2019/09/20 NodeJs
jquery实现拖拽小方块效果
2020/12/10 jQuery
[01:04:01]2014 DOTA2国际邀请赛中国区预选赛 5 23 CIS VS DT第一场
2014/05/24 DOTA
[01:04:30]Fnatic vs Mineski 2018国际邀请赛小组赛BO2 第二场 8.17
2018/08/18 DOTA
python实现linux下使用xcopy的方法
2015/06/28 Python
浅谈python中copy和deepcopy中的区别
2017/10/23 Python
Python编程scoketServer实现多线程同步实例代码
2018/01/29 Python
对python 中class与变量的使用方法详解
2019/06/26 Python
Python使用matplotlib 模块scatter方法画散点图示例
2019/09/27 Python
Python利用逻辑回归分类实现模板
2020/02/15 Python
python连接手机自动搜集蚂蚁森林能量的实现代码
2021/02/24 Python
精美的手工家居和生活用品:Nkuku
2019/11/01 全球购物
大学军训感言
2014/01/10 职场文书
工作失职检讨书范文
2014/01/16 职场文书
违反课堂纪律检讨书
2014/01/19 职场文书
质量承诺书格式
2014/05/20 职场文书
小学生我的梦想演讲稿
2014/08/21 职场文书
MySQL完整性约束的定义与实例教程
2021/05/30 MySQL
Window server 2012 R2 AD域的组策略相关设置
2022/04/28 Servers