更改标准 (Python) 测试发现

在测试收集期间忽略路径

您可以通过在命令行界面 (cli) 中传递 --ignore=path 选项，轻松地在收集期间忽略某些测试目录和模块。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

现在，如果您使用 --ignore=tests/foobar/test_foobar_03.py --ignore=tests/hello/ 调用 pytest，您将看到 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 结尾的测试模块，请使用 --ignore-glob='*_01.py' 执行 pytest。

在测试收集期间取消选择测试

可以通过传递 --deselect=item 选项在收集期间单独取消选择测试。例如，假设 tests/foobar/test_foobar_01.py 包含 test_a 和 test_b。您可以通过使用 --deselect tests/foobar/test_foobar_01.py::test_a 调用 pytest，运行 tests/ 中除 tests/foobar/test_foobar_01.py::test_a 之外的所有测试。pytest 允许使用多个 --deselect 选项。

保留从命令行指定的重复路径

pytest 的默认行为是忽略从命令行指定的重复路径。示例

pytest path_a path_a

...
collected 1 item
...

只收集测试一次。

要收集重复的测试，请在命令行界面 (cli) 上使用 --keep-duplicates 选项。示例

pytest --keep-duplicates path_a path_a

...
collected 2 items
...

由于收集器仅适用于目录，因此如果您两次指定单个测试文件，无论是否指定 --keep-duplicates，pytest 仍将收集两次。示例

pytest test_a.py test_a.py

...
collected 2 items
...

更改目录递归

您可以在 ini 文件中设置 norecursedirs 选项，例如项目根目录中的 pytest.ini

# content of pytest.ini
[pytest]
norecursedirs = .svn _build tmp*

这将告诉 pytest 不要递归进入典型的 subversion 或 sphinx-build 目录，也不要递归进入任何以 tmp 为前缀的目录。

更改命名约定

您可以通过在 配置文件 中设置 python_files、python_classes 和 python_functions 来配置不同的命名约定。这是一个示例

# 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 glob 模式匹配的文件、类中的 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-8.x.y, pluggy-1.x.y
rootdir: /home/sweet/project
configfile: pytest.ini
collected 2 items

<Dir pythoncollection.rst-207>
  <Module check_myapp.py>
    <Class CheckMyApp>
      <Function simple_check>
      <Function complex_check>

======================== 2 tests collected in 0.12s ========================

您可以通过在模式之间添加空格来检查多个 glob 模式

# 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 将检查 NAME 是否作为可导入的包/模块存在，否则将其视为文件系统路径。

找出收集了什么

您可以随时查看收集树，而无需像这样运行测试

. $ pytest --collect-only pythoncollection.py
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-8.x.y, pluggy-1.x.y
rootdir: /home/sweet/project
configfile: pytest.ini
collected 3 items

<Dir pythoncollection.rst-207>
  <Dir CWD>
    <Module 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

以及如下所示的 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-8.x.y, pluggy-1.x.y
rootdir: /home/sweet/project
configfile: pytest.ini
collected 0 items

======================= no tests collected in 0.12s ========================

也可以基于 Unix shell 风格的通配符忽略文件，方法是将模式添加到 collect_ignore_glob。

以下 conftest.py 示例忽略了 setup.py 文件，此外，当使用 Python 3 解释器执行时，还忽略了所有以 *_py2.py 结尾的文件

# content of conftest.py
import sys

collect_ignore = ["setup.py"]
if sys.version_info[0] > 2:
    collect_ignore_glob = ["*_py2.py"]

自 Pytest 2.6 以来，用户可以通过将布尔 __test__ 属性设置为 False 来阻止 pytest 发现以 Test 开头的类。

# Will not be discovered as a test
class TestClass:
    __test__ = False