更改标准(python)测试发现¶
在测试收集期间忽略路径¶
通过传递 --ignore=path
cli上的选项。 pytest
允许多重 --ignore
选项。例子:
tests/
|-- example
| |-- test_example_01.py
| |-- test_example_02.py
| '-- test_example_03.py
|-- foobar
| |-- test_foobar_01.py
| |-- test_foobar_02.py
| '-- test_foobar_03.py
'-- hello
'-- world
|-- test_world_01.py
|-- test_world_02.py
'-- test_world_03.py
现在如果你调用 pytest
具有 --ignore=tests/foobar/test_foobar_03.py --ignore=tests/hello/
你会看到的 pytest
仅收集与指定模式不匹配的测试模块:
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
rootdir: $REGENDOC_TMPDIR, inifile:
collected 5 items
tests/example/test_example_01.py . [ 20%]
tests/example/test_example_02.py . [ 40%]
tests/example/test_example_03.py . [ 60%]
tests/foobar/test_foobar_01.py . [ 80%]
tests/foobar/test_foobar_02.py . [100%]
========================= 5 passed in 0.02 seconds =========================
这个 --ignore-glob
选项允许忽略基于unix shell样式通配符的测试文件路径。如果要排除以 _01.py
执行 pytest
具有 --ignore-glob='*_01.py'
.
在测试收集期间取消选择测试¶
通过传递 --deselect=item
选择权。例如,假设 tests/foobar/test_foobar_01.py
包含 test_a
和 test_b
. 您可以在 tests/
除了 对于 tests/foobar/test_foobar_01.py::test_a
通过调用 pytest
具有 --deselect tests/foobar/test_foobar_01.py::test_a
. pytest
允许多重 --deselect
选项。
保留从命令行指定的重复路径¶
的默认行为 pytest
忽略从命令行指定的重复路径。例子:
pytest path_a path_a
...
collected 1 item
...
只收集一次测试。
要收集重复测试,请使用 --keep-duplicates
cli上的选项。例子:
pytest --keep-duplicates path_a path_a
...
collected 2 items
...
因为收集器只在目录上工作,所以如果为单个测试文件指定两次, pytest
仍然会收集它两次,无论 --keep-duplicates
未指定。例子:
pytest test_a.py test_a.py
...
collected 2 items
...
更改目录递归¶
您可以设置 norecursedirs
ini文件中的选项,例如 pytest.ini
在项目根目录中:
# content of pytest.ini
[pytest]
norecursedirs = .svn _build tmp*
这会告诉 pytest
不递归到典型的Subversion或Sphinx构建目录或任何 tmp
前缀目录。
更改命名约定¶
您可以通过设置 python_files
, python_classes
和 python_functions
在你 configuration file . 下面是一个例子:
# content of pytest.ini
# Example 1: have pytest look for "check" instead of "test"
[pytest]
python_files = check_*.py
python_classes = Check
python_functions = *_check
这会使 pytest
在文件中查找与 check_* .py
球形模式, Check
类中的前缀,以及匹配的函数和方法 *_check
. 例如,如果我们有:
# content of check_myapp.py
class CheckMyApp:
def simple_check(self):
pass
def complex_check(self):
pass
测试集合如下所示:
$ pytest --collect-only
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-0.x.y
cachedir: $PYTHON_PREFIX/.pytest_cache
rootdir: $REGENDOC_TMPDIR, configfile: pytest.ini
collected 2 items
<Module check_myapp.py>
<Class CheckMyApp>
<Function simple_check>
<Function complex_check>
======================== 2 tests collected in 0.12s ========================
您可以通过在模式之间添加一个空格来检查多个全局模式:
# Example 2: have pytest look for files with "test" and "example"
# content of pytest.ini
[pytest]
python_files = test_*.py example_*.py
注解
这个 python_functions
和 python_classes
选项对没有影响 unittest.TestCase
测试发现,因为Pytest将测试用例方法的发现委托给UnitTest代码。
将命令行参数解释为python包¶
你可以使用 --pyargs
选择权 pytest
尝试将参数解释为python包名称,派生它们的文件系统路径,然后运行测试。例如,如果安装了UnitTest2,则可以键入:
pytest --pyargs unittest2.test.test_skipping -q
运行各自的测试模块。和其他选项一样,通过一个ini文件和 addopts
选项您可以更永久地进行此更改:
# content of pytest.ini
[pytest]
addopts = --pyargs
现在简单地调用 pytest NAME
将检查名称是否作为可导入的包/模块存在,否则将其视为文件系统路径。
了解收集的内容¶
您可以在不运行以下测试的情况下查看收集树:
. $ pytest --collect-only pythoncollection.py
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-0.x.y
cachedir: $PYTHON_PREFIX/.pytest_cache
rootdir: $REGENDOC_TMPDIR, configfile: pytest.ini
collected 3 items
<Module CWD/pythoncollection.py>
<Function test_function>
<Class TestClass>
<Function test_method>
<Function test_anothermethod>
======================== 3 tests collected in 0.12s ========================
自定义测试集合¶
你可以很容易地指导 pytest
要从每个python文件中发现测试,请执行以下操作:
# content of pytest.ini
[pytest]
python_files = *.py
然而,许多项目将有一个 setup.py
他们不想进口。此外,可能只有特定的python版本才能导入文件。对于这种情况,您可以动态定义要忽略的文件,方法是将它们列在 conftest.py
文件:
# content of conftest.py
import sys
collect_ignore = ["setup.py"]
if sys.version_info[0] > 2:
collect_ignore.append("pkg/module_py2.py")
如果有这样的模块文件:
# content of pkg/module_py2.py
def test_only_on_python2():
try:
assert 0
except Exception, e:
pass
和A setup.py
像这样的虚拟文件:
# content of setup.py
0 / 0 # will raise exception if imported
如果您使用python 2解释器运行,那么您将找到一个测试,并忽略 setup.py
文件:
#$ pytest --collect-only
====== test session starts ======
platform linux2 -- Python 2.7.10, pytest-2.9.1, py-1.4.31, pluggy-0.3.1
rootdir: $REGENDOC_TMPDIR, inifile: pytest.ini
collected 1 items
<Module 'pkg/module_py2.py'>
<Function 'test_only_on_python2'>
====== 1 tests found in 0.04 seconds ======
如果使用python 3解释器运行,则一个测试和 setup.py
文件将被删除:
$ pytest --collect-only
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-0.x.y
cachedir: $PYTHON_PREFIX/.pytest_cache
rootdir: $REGENDOC_TMPDIR, configfile: pytest.ini
collected 0 items
======================= no tests collected in 0.12s ========================
通过将模式添加到 collect_ignore_glob
.
以下示例 conftest.py
忽略文件 setup.py
此外,所有以 *_py2.py
使用Python 3解释器执行时:
# content of conftest.py
import sys
collect_ignore = ["setup.py"]
if sys.version_info[0] > 2:
collect_ignore_glob = ["*_py2.py"]
从pytest2.6开始,用户可以阻止Pytest发现以 Test
通过设置布尔值 __test__
属性到 False
.
# Will not be discovered as a test
class TestClass:
__test__ = False