pytest 配置文件

概述

配置文件可以有三种,pytest.ini, tox.ini, setup.cfg。通常情况下,放在根目录下。所有的选项必须放在[pytest]下边,对于setup.cfg是[tool:pytest]。
(建议使用pytest.ini或者tox.ini,一般setup.cfg用在简单的用例中,因为很难去追踪问题)

配置文件选项可以被命令行覆盖,通过-o/--override,也可以多次传递,比如:

pytest -o console_output_style=classic -o cache_dir=/tmp/mycache

addopts

给命令行增加详细的选项,例如,在pytest.ini

[pytest]
addopts = --maxfail=2 -rf  # 2个用例失败后退出,病给出详细信息

具体应用就像:

pytest --maxfail=2 -rf test_hello.py

cache_dir

设置存储缓存插件内容的目录。默认目录是在根目录中创建的.pytest_缓存。目录可以是相对路径或绝对路径。如果设置相对路径,则相对于根目录创建目录。另外,路径可能包含将被扩展的环境变量。

confcutdir

设置向上搜索的目录conftest.py文件停止。默认情况下,pytest将停止搜索conftest.py从向上的文件pytest.ini/tox.ini/setup.cfg如果有的话,或者直到文件系统根目录。

console_output_style

设置输出样式

  • classic:经典样式
  • progress: 带有进度指示器的经典演示
  • count: 像progress,但将进度显示为已完成的测试数,而不是百分比
    默认为process,当然也可以设置为经典模式
# content of pytest.ini
[pytest]
console_output_style = classic

doctest_encoding

doctest编码格式,默认为utf8

empty_parameter_set_mark

参数为空的选择操作

  • skip 跳过空参数的测试用例
  • xfail 标注空参数的用例失败
  • fail_at_collect 当收集到空参数的时候抛出异常
    比如:
# content of pytest.ini
[pytest]
empty_parameter_set_mark = xfail

faulthandler_timeout

如果测试运行时间超过X秒(包括fixture setup和teardown)

filterwarnings

设置对匹配警告应执行的筛选器和操作的列表。默认情况下,测试会话期间发出的所有警告将在测试会话结束时显示在摘要中。

# content of pytest.ini
[pytest]
filterwarnings =
    error
    ignore::DeprecationWarning

这将告诉pytest忽略不推荐警告,并将所有其他警告转换为错误。

junit_duration_report

配置如何将持续时间记录到JUnit XML报表中

  • total (默认),报告的持续时间包括setup/teardown
  • call,紧紧包括调用时间,不包括setup/teardown的时间

junit_family

JUnit XML生成的格式

  • xunit1 (or legacy) ,默认值
  • xunit2 和Jekins更合适

junit_logging

配置捕捉到的输出是否写到JUnit XML 中,有效值有:

  • log: 只写捕捉到的日志
  • system-out: 写入标准输出内容
  • system-err: 写入错误输出内容
  • out-err:自恶如标准输出和错误输出
  • all: 包括日志,stdout, stderr
    -no(默认值): 不写

junit_log_passing_tests

如果junit_logging != no,那么测试通过的用例的输出写到JUnit XML中,默认值为True

junit_suite_name

设置根目录测试套的名称

log_auto_indent

允许多行日志消息的选择性自动缩进

  • True or 'on'
  • False or 'off' or 0
  • [正整数] 按[正整数]空格自动缩进多行日志消息

log_cli

在测试运行期间启用日志显示(也称为“实时日志记录”),默认为False

log_cli_date_format

日志时间格式

[pytest]
log_cli_date_format = %Y-%m-%d %H:%M:%S

log_cli_format

[pytest]
log_cli_format = %(asctime)s %(levelname)s %(message)s

log_cli_level

[pytest]
log_cli_level = INFO

log_date_format

[pytest]
log_date_format = %Y-%m-%d %H:%M:%S

log_file

[pytest]
log_file = logs/pytest-logs.txt

log_file_date_format

[pytest]
log_file_date_format = %Y-%m-%d %H:%M:%S

log_file_format

[pytest]
log_file_format = %(asctime)s %(levelname)s %(message)s

log_file_level

log_format

log_level

log_print

markers

[pytest]
addopts = --strict-markers
markers =
    slow
    serial

minversion

pytest 最低版本

norecursedirs

不被执行的目录

[pytest]
norecursedirs = .svn _build tmp*

python_classes

那些类将被执行,比如下边的带有Suite的将被执行

[pytest]
python_classes = *Suite

python_files

那些文件会被执行

[pytest]
python_files = test_*.py check_*.py example_*.py
# 或者
python_files =
    test_*.py
    check_*.py
    example_*.py

python_functions

更多的函数会被执行

[pytest]
python_functions = *_test

testpaths

被执行的测试目录

[pytest]
testpaths = testing doc

usefixtures

[pytest]
usefixtures =
    clean_db

xfail_strict

设置为True,@pytest.mark.xfail 的用例,实际成功,但是会被标注为失败

[pytest]
xfail_strict = True

你可能感兴趣的:(pytest 配置文件)