在前文Pytest基础指南之APIs集大体介绍了Pytest的API集以及大体能力,本文主要介绍其中的配置项这块,通过具体的实例来说明配置使用方法,当然了如果你对Pytest还未做过任何了解可以参见最初的文章Pytest基础指南之介绍、环境及安装和Pytest基础指南之如何选择unitttest与pytest来了解一下pytest相关基础。
在本文主要介绍以pytest.ini文件为配置文件的使用方法,不对tox.ini和setup.cfg说明,通常掌握了pytest.ini配置文件的使用,足以应对所有场景的使用了。
下面看一个表,也是笔者日常工作中常用的配置项,注:这里未必列出所有的配置项,如果你需要了解所有配置项,请参见官网文档,别问我要链接。
常用配置项表
配置项 | 说明 |
---|---|
cache_dir | pytest运行时缓存目录,默认在根目录生成.python_cache目录 |
console_output_style | 设置运行测试时console输出样式 |
junit_duration_report | 配置如何将持续时间记录到JUnit XML报告中 |
junit_family | 配置生成的JUnit XML文件的格式。可能的选项有junit1、junit2 |
junit_logging | 配置stdout/stderr是否应该写入JUnit XML文件。有效的值system-out、system-err或no(默认值) |
log_cli_date_format | 设置一个time.strftime()兼容的字符串,该字符串将在格式化实时日志记录的日期时使用 |
log_cli_format | 设置一个日志兼容的字符串,用于格式化实时日志记录消息。 |
log_cli_level | 设置为实时日志记录应捕获的最小日志消息级别。可以使用整数值或级别的名称。 |
log_date_format | 设置一个time.strftime()兼容的字符串,该字符串将在为日志捕获格式化日期时使用。 |
log_file | 设置路径相对pytest.ini文件的日志文件路径,用于日志记录和其他一些活动的日志记录 |
log_file_date_format | 设置一个time.strftime()兼容的字符串,该字符串将在为日志文件格式化日期时使用。 |
log_file_format | 设置一个与日志兼容的字符串,用于格式化重定向到日志文件的日志消息。 |
log_file_level | 设置应该为日志文件捕获的最小日志消息级别。可以使用整数值或级别的名称。 |
log_format | 设置一个与日志兼容的字符串,用于格式化捕获的日志消息。 |
log_level | 设置应该为日志捕获捕获的最小日志消息级别。可以使用整数值或级别的名称。 |
log_print | 如果设置为False,将禁用显示失败测试捕获的日志消息。 |
注:大家在看上表时,会发现我并未列出配置项可设置的值或格式,这里我是故意不列出的,目的是期望大家能够去找到官方文档,进一步加强理解,因为每个人都应该需要去做一个适合自己的配置文件,从而在工作中形成自己的风格和需求。
下面可以看一下我的pytest.ini配置实例,我只需要常用的几个配置,其他的都是默认的,如下,大部分人按我的这个配置一般足够用,当然了,我会工作中会根据需要进行修改,所以大家还是需要通过官方文档进一步熟悉相关配置项才行。
!