返回顶部

弃用和移除¶

此页面列出了当前已弃用或在过去主要版本中已移除的所有 pytest 功能。目的是向用户清楚地说明为什么某个功能已被移除，以及应该使用哪些替代方案。

已弃用功能¶

以下是所有被认为已弃用的 pytest 功能的完整列表。使用这些功能将发出 PytestWarning 或子类，可以使用标准警告过滤器进行过滤。

`pytest.importorskip` 关于 `ImportError` 的默认行为¶

自版本 8.2 起已弃用。

传统上，pytest.importorskip() 将捕获 ImportError，最初的目的是跳过未安装依赖模块的测试，例如使用不同依赖项进行测试。

然而，某些软件包可能已安装在系统中，但由于某些其他问题（例如，编译错误或安装损坏）而无法导入。在这些情况下，pytest.importorskip() 仍然会静默跳过测试，但通常用户希望看到意外错误，以便可以解决根本问题。

在 8.2 中，添加了 exc_type 参数，使用户能够传递 ModuleNotFoundError，以便仅在模块确实找不到时才跳过测试，而不是因为其他错误。

默认情况下仅捕获 ModuleNotFoundError（并让其他错误传播）将是最佳解决方案，但为了向后兼容性，pytest 将保留现有行为，但在以下情况下引发警告

捕获的异常类型为 ImportError，并且
用户未显式传递 exc_type。

如果导入尝试引发 ModuleNotFoundError（通常情况），则会跳过该模块，并且不发出警告。

这样，通常的情况将保持相同的工作方式，而意外错误现在将发出警告，用户可以通过显式传递 exc_type=ImportError 来抑制警告。

在 9.0 中，警告将变为错误，在 9.1 中，pytest.importorskip() 默认情况下将仅捕获 ModuleNotFoundError，并且不再发出警告 – 但用户仍然可以通过将其传递给 exc_type 来捕获 ImportError。

Node 构造函数的 `fspath` 参数已替换为 `pathlib.Path`¶

自版本 7.0 起已弃用。

为了支持从 py.path.local 到 pathlib 的过渡，Node 构造函数（如 pytest.Function.from_parent() 和 pytest.Class.from_parent()）的 fspath 参数现已弃用。

构造节点的插件应传递 path 参数（类型为 pathlib.Path），而不是 fspath 参数。

鼓励实现自定义 item 和 collector 的插件将 fspath 参数 (py.path.local) 替换为 path 参数 (pathlib.Path)，并在可能的情况下删除 py 库的任何其他用法。

如果可能，具有自定义 item 的插件应使用协作构造函数，以避免硬编码它们仅传递给超类的参数。

注意

Node 参数和属性的名称（新属性为 path）与 hooks 的情况相反，如下所述（旧参数为 path）。

这是一个不幸的产物，由于历史原因造成的，应该在未来的版本中解决，因为我们正在慢慢摆脱 py 依赖项（有关更长的讨论，请参阅 #9283）。

由于正在进行的诸如 reportinfo() 等方法的迁移，这些方法仍然期望返回 py.path.local 对象，因此节点仍然同时具有 fspath (py.path.local) 和 path (pathlib.Path) 属性，无论构造函数中使用了什么参数。我们预计在未来的版本中弃用 fspath 属性。

使用 markers 配置 hook specs/impls¶

在 pluggy（pytest 的插件库）成为其自身的软件包并具有清晰的 API 之前，pytest 只是使用 pytest.mark 来配置 hooks。

pytest.hookimpl() 和 pytest.hookspec() 装饰器已经存在多年，应该改用它们。

@pytest.mark.tryfirst
def pytest_runtest_call(): ...

# or
def pytest_runtest_call(): ...

pytest_runtest_call.tryfirst = True

应该更改为

@pytest.hookimpl(tryfirst=True)
def pytest_runtest_call(): ...

已更改 hookimpl 属性

tryfirst
trylast
optionalhook
hookwrapper

已更改 hookwrapper 属性

firstresult
historic

hooks 的 `py.path.local` 参数已替换为 `pathlib.Path`¶

自版本 7.0 起已弃用。

为了支持从 py.path.local 到 pathlib 的过渡，以下 hooks 现在接收附加参数

pytest_ignore_collect(collection_path: pathlib.Path) 作为 path 的等效项
pytest_collect_file(file_path: pathlib.Path) 作为 path 的等效项
pytest_pycollect_makemodule(module_path: pathlib.Path) 作为 path 的等效项
pytest_report_header(start_path: pathlib.Path) 作为 startdir 的等效项
pytest_report_collectionfinish(start_path: pathlib.Path) 作为 startdir 的等效项

随附的基于 py.path.local 的路径已被弃用：手动调用这些 hooks 的插件应仅传递新的 pathlib.Path 参数，用户应更改其 hook 实现以使用新的 pathlib.Path 参数。

注意

Node 参数和属性的名称，如上所述（新属性为 path）与 hooks 的情况相反（旧参数为 path）。

这是一个不幸的产物，由于历史原因造成的，应该在未来的版本中解决，因为我们正在慢慢摆脱 py 依赖项（有关更长的讨论，请参阅 #9283）。

直接构造内部类¶

自版本 7.0 起已弃用。

直接构造以下类现已弃用

_pytest.mark.structures.Mark
_pytest.mark.structures.MarkDecorator
_pytest.mark.structures.MarkGenerator
_pytest.python.Metafunc
_pytest.runner.CallInfo
_pytest._code.ExceptionInfo
_pytest.config.argparsing.Parser
_pytest.config.argparsing.OptionGroup
_pytest.pytester.HookRecorder

这些构造函数一直被认为是私有的，但现在发出弃用警告，这可能会在 pytest 8 中变成硬错误。

`pytest.Collector` 和 `pytest.Item` 之间的菱形继承¶

自版本 7.0 起已弃用。

定义既是 Item 又是 Collector 的自定义 pytest 节点类型（例如 File）现在会发出警告。它从未得到合理的支持，并且会触发难以调试的错误。

一些提供 linting/代码分析的插件一直将其用作 hack 手段。相反，应该使用单独的 collector 节点来收集 item。有关示例，请参阅使用非 Python 测试，以及修复继承的示例 pr。

自定义 `Node` 子类的构造函数应接受 `**kwargs`¶

自版本 7.0 起已弃用。

如果 pytest.Item 等节点的自定义子类覆盖了 __init__ 方法，则它们应接受 **kwargs。因此，

class CustomItem(pytest.Item):
    def __init__(self, name, parent, additional_arg):
        super().__init__(name, parent)
        self.additional_arg = additional_arg

应更改为

class CustomItem(pytest.Item):
    def __init__(self, *, additional_arg, **kwargs):
        super().__init__(**kwargs)
        self.additional_arg = additional_arg

以避免硬编码 pytest 可以传递给超类的参数。有关完整示例，请参阅使用非 Python 测试。

对于没有冲突的情况，不会发出弃用警告。对于存在冲突的情况（例如，pytest.File 现在接受 path 而不是 fspath，如上文所述），现在会引发弃用警告。

将标记应用于 fixture 函数¶

自版本 7.4 起已弃用。

将标记应用于 fixture 函数从未产生任何效果，但这是一个常见的用户错误。

@pytest.mark.usefixtures("clean_database")
@pytest.fixture
def user() -> User: ...

在这种情况下，用户期望 usefixtures 标记会产生其预期的效果，即在调用 user 时使用 clean_database fixture，但实际上它根本没有任何效果。

现在，pytest 在遇到此问题时会发出警告，并在未来版本中引发错误。

在测试函数中返回非 None 值¶

自版本 7.2 起已弃用。

如果测试函数返回除 None 以外的其他内容，则现在会发出 pytest.PytestReturnNotNoneWarning。

这可以防止初学者常犯的一个错误，他们期望返回 bool 值会导致测试通过或失败，例如

@pytest.mark.parametrize(
    ["a", "b", "result"],
    [
        [1, 2, 5],
        [2, 3, 8],
        [5, 3, 18],
    ],
)
def test_foo(a, b, result):
    return foo(a, b) == result

鉴于 pytest 忽略返回值，这将令人惊讶的是它永远不会失败。

正确的修复方法是将 return 更改为 assert

@pytest.mark.parametrize(
    ["a", "b", "result"],
    [
        [1, 2, 5],
        [2, 3, 8],
        [5, 3, 18],
    ],
)
def test_foo(a, b, result):
    assert foo(a, b) == result

`yield_fixture` 函数/装饰器¶

自版本 6.2 起已弃用。

pytest.yield_fixture 是 pytest.fixture() 的已弃用别名。

这种情况已经存在很长时间了，因此可以安全地进行搜索/替换。

已移除的功能和重大变更¶

正如我们的向后兼容性政策政策中所述，已弃用的功能仅在经过适当的弃用期后才会在主要版本中移除。

还列出了一些无法弃用的重大变更。

支持为 nose 编写的测试¶

自版本 7.2 起已弃用。

在版本 8.0 中移除。

对运行为 nose 编写的测试的支持现已弃用。

nose 多年来一直处于仅维护模式，并且维护插件并非易事，因为它会蔓延到代码库中（有关更多详细信息，请参阅 #9886）。

setup/teardown¶

一件可能会让用户感到惊讶的事情是，普通的 setup 和 teardown 方法不是 pytest 原生的，它们实际上是 nose 支持的一部分。

class Test:
    def setup(self):
        self.resource = make_resource()

    def teardown(self):
        self.resource.close()

    def test_foo(self): ...

    def test_bar(self): ...

原生 pytest 支持使用 setup_method 和 teardown_method（请参阅方法和函数级别的 setup/teardown），因此上面的代码应更改为

class Test:
    def setup_method(self):
        self.resource = make_resource()

    def teardown_method(self):
        self.resource.close()

    def test_foo(self): ...

    def test_bar(self): ...

通过简单的查找/替换，这很容易在整个代码库中完成。

@with_setup¶

使用 @with_setup 的代码（例如以下代码）

from nose.tools import with_setup

def setup_some_resource(): ...

def teardown_some_resource(): ...

@with_setup(setup_some_resource, teardown_some_resource)
def test_foo(): ...

也需要移植到受支持的 pytest 样式。一种方法是使用 fixture

import pytest

def setup_some_resource(): ...

def teardown_some_resource(): ...

@pytest.fixture
def some_resource():
    setup_some_resource()
    yield
    teardown_some_resource()

def test_foo(some_resource): ...

`compat_co_firstlineno` 属性¶

Nose 检查函数对象上的此属性，以允许覆盖函数推断的行号。Pytest 不再尊重此属性。

将 `msg=` 传递给 `pytest.skip`、`pytest.fail` 或 `pytest.exit`¶

自版本 7.0 起已弃用。

在版本 8.0 中移除。

将关键字参数 msg 传递给 pytest.skip()、pytest.fail() 或 pytest.exit() 现已弃用，应改用 reason。此更改是为了使这些函数与已经接受 reason 参数的 @pytest.mark.skip 和 @pytest.mark.xfail markers 保持一致。

def test_fail_example():
    # old
    pytest.fail(msg="foo")
    # new
    pytest.fail(reason="bar")


def test_skip_example():
    # old
    pytest.skip(msg="foo")
    # new
    pytest.skip(reason="bar")


def test_exit_example():
    # old
    pytest.exit(msg="foo")
    # new
    pytest.exit(reason="bar")

`pytest.Instance` collector¶

在版本 7.0 中移除。

pytest.Instance collector 类型已被移除。

以前，Python 测试方法被收集为 Class -> Instance -> Function。现在，Class 直接收集测试方法。

大多数引用 Instance 的插件这样做是为了忽略或跳过它，使用诸如 if isinstance(node, Instance): return 之类的检查。此类插件应简单地删除对 pytest>=7 上 Instance 的考虑。但是，为了保持此类用途的正常工作，已在 pytest.Instance 和 _pytest.python.Instance 中实例化了一个虚拟类型，并且导入它会发出弃用警告。这已在 pytest 8 中移除。

使用 `pytest.warns(None)`¶

自版本 7.0 起已弃用。

在版本 8.0 中移除。

pytest.warns(None) 现已弃用，因为它经常被误用。其正确的用法是检查代码是否发出至少一个任何类型的警告 - 就像 pytest.warns() 或 pytest.warns(Warning) 一样。

有关示例，请参阅测试中警告的其他用例。

`Parser.addoption` 中的向后兼容性¶

自版本 2.4 起已弃用。

在版本 8.0 中移除。

Parser.addoption 的几种行为现在已在 pytest 8 中移除（自 pytest 2.4.0 起已弃用）

parser.addoption(..., help=".. %default ..") - 使用 %(default)s 代替。
parser.addoption(..., type="int/string/float/complex") - 使用 type=int 等代替。

`--strict` 命令行选项¶

自版本 6.2 起已弃用。

在版本 8.0 中移除。

--strict 命令行选项已被弃用，取而代之的是 --strict-markers，后者更好地传达了该选项的作用。

我们计划在未来可能重新引入 --strict 并使其成为所有严格性相关选项的包罗万象的标志（目前为 --strict-markers 和 --strict-config，未来可能会引入更多）。

实现 `pytest_cmdline_preparse` hook¶

自版本 7.0 起已弃用。

在版本 8.0 中移除。

实现 pytest_cmdline_preparse hook 已正式弃用。请改用 pytest_load_initial_conftests hook。

def pytest_cmdline_preparse(config: Config, args: List[str]) -> None: ...

# becomes:

def pytest_load_initial_conftests(
    early_config: Config, parser: Parser, args: List[str]
) -> None: ...

pytest 8 中的集合更改¶

添加了一个新的 pytest.Directory 基本集合节点，预计文件系统目录的所有 collector 节点都将继承自该节点。这类似于文件节点的现有 pytest.File。

将 pytest.Package 更改为 pytest.Directory 的子类。Package 表示一个文件系统目录，该目录是一个 Python 包，即包含 __init__.py 文件。

pytest.Package 现在仅收集其自身目录中的文件；以前它是递归收集的。子目录作为子 collector 节点收集，从而创建镜像文件系统层次结构的集合树。

session.name 现在为 ""；以前它是 rootdir 目录名称。这与始终为 "" 的 session.nodeid 匹配。

添加了一个新的 pytest.Dir 具体集合节点，它是 pytest.Directory 的子类。此节点表示一个文件系统目录，该目录不是 pytest.Package，即不包含 __init__.py 文件。与 Package 类似，它仅收集其自身目录中的文件，同时将子目录作为子 collector 节点收集。

文件和目录现在按字母顺序联合收集，除非被插件更改。以前，文件在目录之前收集。

集合树现在包含目录/包，直到 rootdir，对于在 rootdir 中找到的初始参数。对于 rootdir 之外的文件，仅收集直接目录/包 – 但请注意，不鼓励从 rootdir 外部收集。

例如，给定以下文件系统树

myroot/
    pytest.ini
    top/
    ├── aaa
    │   └── test_aaa.py
    ├── test_a.py
    ├── test_b
    │   ├── __init__.py
    │   └── test_b.py
    ├── test_c.py
    └── zzz
        ├── __init__.py
        └── test_zzz.py

集合树，如 pytest --collect-only top/ 所示，但为了清晰起见添加了原本隐藏的 Session 节点，现在如下所示

<Session>
  <Dir myroot>
    <Dir top>
      <Dir aaa>
        <Module test_aaa.py>
          <Function test_it>
      <Module test_a.py>
        <Function test_it>
      <Package test_b>
        <Module test_b.py>
          <Function test_it>
      <Module test_c.py>
        <Function test_it>
      <Package zzz>
        <Module test_zzz.py>
          <Function test_it>

以前，它是

<Session>
  <Module top/test_a.py>
    <Function test_it>
  <Module top/test_c.py>
    <Function test_it>
  <Module top/aaa/test_aaa.py>
    <Function test_it>
  <Package test_b>
    <Module test_b.py>
      <Function test_it>
  <Package zzz>
    <Module test_zzz.py>
      <Function test_it>

依赖于集合树特定形状的代码/插件可能需要更新。

`pytest.Package` 不再是 `pytest.Module` 或 `pytest.File`¶

在版本 8.0 中更改。

Package collector 节点指定一个 Python 包，即带有 __init__.py 文件的目录。以前，Package 是 pytest.Module（表示单个 Python 模块）的子类型，该模块是 __init__.py 文件。这已被认为是设计错误（有关详细信息，请参阅 #11137 和 #7777）。

Package 节点的 path 属性现在指向包目录，而不是 __init__.py 文件。

请注意，如果 __init__.py 的 Module 节点（它不是 Package）在收集期间被拾取（例如，如果您配置了 python_files 以包含 __init__.py 文件），则它可能仍然存在。

收集 `init.py` 文件不再收集包¶

在版本 8.0 中移除。

现在运行 pytest pkg/__init__.py 只会收集 pkg/__init__.py 文件（模块）。以前，它会收集整个 pkg 包，包括目录中的其他测试文件，但不包括 __init__.py 文件本身中的测试（除非 python_files 被更改为允许 __init__.py 文件）。

要收集整个包，请仅指定目录：pytest pkg。

`pytest.collect` 模块¶

自版本 6.0 起已弃用。

在版本 7.0 中移除。

pytest.collect 模块不再是公共 API 的一部分，其所有名称现在都应直接从 pytest 导入。

`pytest_warning_captured` 钩子¶

自版本 6.0 起已弃用。

在版本 7.0 中移除。

此钩子有一个 item 参数，该参数无法被 pytest-xdist 序列化。

请改用 pytest_warning_recorded 钩子，它用 nodeid 参数替换了 item 参数。

`pytest._fillfuncargs` 函数¶

自版本 6.0 起已弃用。

在版本 7.0 中移除。

保留此函数是为了向后兼容旧版本的插件。

它的功能不应直接使用，但如果您必须替换它，请改用 function._request._fillfixtures()，但请注意这不是公共 API，将来可能会被破坏。

`--no-print-logs` 命令行选项¶

自版本 5.4 起已弃用。

在版本 6.0 中已移除。

--no-print-logs 选项和 log_print ini 设置已移除。如果您使用了它们，请改用 --show-capture。

在 pytest 3.5.0 中添加了 --show-capture 命令行选项，该选项允许指定在测试失败时如何显示捕获的输出：no、stdout、stderr、log 或 all（默认值）。

结果日志 (`--result-log`)¶

自版本 4.0 起已弃用。

在版本 6.0 中已移除。

--result-log 选项生成测试报告流，可以在运行时进行分析，但它使用自定义格式，需要用户实现自己的解析器。

pytest-reportlog 插件提供了 --report-log 选项，这是一个更标准和可扩展的替代方案，每行生成一个 JSON 对象，并且应该涵盖相同的使用场景。请尝试使用它并提供反馈。

pytest-reportlog 插件甚至可能在某个时候合并到核心中，具体取决于插件的计划和使用它的用户数量。

`pytest_collect_directory` 钩子¶

在版本 6.0 中已移除。

pytest_collect_directory 钩子多年来一直无法正常工作（它被调用但结果被忽略）。用户可以考虑改用 pytest_collection_modifyitems。

TerminalReporter.writer¶

在版本 6.0 中已移除。

TerminalReporter.writer 属性已被弃用，不应再使用。这在无意中作为该插件公共 API 的一部分暴露出来，并且将其与 py.io.TerminalWriter 捆绑得太紧。

直接使用 TerminalReporter.writer 的插件应改为使用提供相同功能的 TerminalReporter 方法。

`junit_family` 默认值更改为 “xunit2”¶

在版本 6.0 中已更改。

junit_family 选项的默认值将在 pytest 6.0 中更改为 xunit2，这是旧版 xunit1 格式的更新，并且现代工具（例如 Jenkins、Azure Pipelines 等）默认支持该格式。

建议用户尝试新的 xunit2 格式，并查看其使用 JUnit XML 文件的工具是否支持它。

要使用新格式，请更新您的 pytest.ini

[pytest]
junit_family=xunit2

如果您发现您的工具不支持新格式，并且想继续使用旧版本，请将该选项设置为 legacy

[pytest]
junit_family=legacy

通过使用 legacy，您将在升级到 pytest 6.0 时继续使用旧版/xunit1 格式，其中默认格式将为 xunit2。

为了让用户了解过渡，如果命令行中给出了 --junit-xml 选项，但 junit_family 未在 pytest.ini 中显式配置，则 pytest 将发出警告。

已知支持 xunit2 格式的服务

Jenkins 与 JUnit 插件。
Azure Pipelines.

节点构造已更改为 `Node.from_parent`¶

在版本 6.0 中已更改。

现在节点的构造应该使用命名构造函数 from_parent。 API 表面的这种限制旨在实现对收集树的更好/更简单的重构。

这意味着现在必须调用 MyItem.from_parent(collector, name="foo")，而不是 MyItem(name="foo", parent=collector, obj=42)。

希望支持旧版本 pytest 并抑制警告的插件可以使用 hasattr 来检查该版本中是否存在 from_parent

def pytest_pycollect_makeitem(collector, name, obj):
    if hasattr(MyItem, "from_parent"):
        item = MyItem.from_parent(collector, name="foo")
        item.obj = 42
        return item
    else:
        return MyItem(name="foo", parent=collector, obj=42)

请注意，from_parent 应该只使用关键字参数来调用参数。

`pytest.fixture` 参数仅为关键字参数¶

在版本 6.0 中已移除。

已移除将参数作为位置参数传递给 pytest.fixture() 的方式 - 请改为通过关键字传递它们。

`funcargnames` 是 `fixturenames` 的别名¶

在版本 6.0 中已移除。

FixtureRequest、Metafunc 和 Function 类跟踪其关联 fixture 的名称，属性名为 fixturenames。

在 pytest 2.3 之前，此属性名为 funcargnames，从那时起我们一直将其保留为别名。它最终将被移除，因为它经常在我们需要或插件作者必须区分 fixture 名称和非 fixture 事物（例如 pytest.mark.parametrize）提供的名称的地方造成混淆。

`pytest.config` 全局对象¶

在版本 5.0 中已移除。

pytest.config 全局对象已弃用。请改用 request.config（通过 request fixture）或者如果您是插件作者，请使用 pytest_configure(config) 钩子。请注意，许多钩子也可以通过 session.config 或 item.config 等间接访问 config 对象。

`pytest.raises` 的 `"message"` 参数¶

在版本 5.0 中已移除。

一个常见的错误是认为此参数将匹配异常消息，而实际上它仅用于在 pytest.raises 检查失败时提供自定义消息。为了防止用户犯此错误，并且因为它被认为很少使用，pytest 正在弃用它，目前没有提供替代方案。

如果您对此参数有有效的用例，请考虑要获得相同的结果，您只需在 with 语句末尾手动调用 pytest.fail。

例如

with pytest.raises(TimeoutError, message="Client got unexpected message"):
    wait_for(websocket.recv(), 0.5)

变为

with pytest.raises(TimeoutError):
    wait_for(websocket.recv(), 0.5)
    pytest.fail("Client got unexpected message")

如果您仍然对此弃用和未来移除有疑虑，请在 #3974 上发表评论。

`raises` / `warns` 的第二个参数是字符串¶

在版本 5.0 中已移除。

请改用这些的上下文管理器形式。必要时，直接调用 exec。

示例

pytest.raises(ZeroDivisionError, "1 / 0")
pytest.raises(SyntaxError, "a $ b")

pytest.warns(DeprecationWarning, "my_function()")
pytest.warns(SyntaxWarning, "assert(1, 2)")

变为

with pytest.raises(ZeroDivisionError):
    1 / 0
with pytest.raises(SyntaxError):
    exec("a $ b")  # exec is required for invalid syntax

with pytest.warns(DeprecationWarning):
    my_function()
with pytest.warns(SyntaxWarning):
    exec("assert(1, 2)")  # exec is used to avoid a top-level warning

在自定义 Collector 中使用 `Class`¶

在版本 4.0 中已移除。

使用名为 "Class" 的对象来自定义在 Collector 子类中收集的节点类型已被弃用。用户应改为使用 pytest_pycollect_makeitem 在收集期间自定义节点类型。

此问题应该只影响创建新收集类型的高级插件，因此如果您看到此警告消息，请联系作者以便他们可以更改代码。

`pytest.mark.parametrize` 中的 marks¶

在版本 4.0 中已移除。

现在不建议将 marks 应用于 pytest.mark.parametrize 调用的值。例如

@pytest.mark.parametrize(
    "a, b",
    [
        (3, 9),
        pytest.mark.xfail(reason="flaky")(6, 36),
        (10, 100),
        (20, 200),
        (40, 400),
        (50, 500),
    ],
)
def test_foo(a, b): ...

此代码将 pytest.mark.xfail(reason="flaky") mark 应用于上述参数化调用的 (6, 36) 值。

这被认为难以阅读和理解，并且它的实现也给代码带来了问题，阻止了 marks 架构的进一步内部改进。

要更新代码，请使用 pytest.param

@pytest.mark.parametrize(
    "a, b",
    [
        (3, 9),
        pytest.param(6, 36, marks=pytest.mark.xfail(reason="flaky")),
        (10, 100),
        (20, 200),
        (40, 400),
        (50, 500),
    ],
)
def test_foo(a, b): ...

`pytest_funcarg__` 前缀¶

在版本 4.0 中已移除。

在非常早期的 pytest 版本中，可以使用 pytest_funcarg__ 前缀定义 fixture

def pytest_funcarg__data():
    return SomeData()

切换到 @pytest.fixture 装饰器

@pytest.fixture
def data():
    return SomeData()

setup.cfg 文件中的 [pytest] 部分¶

在版本 4.0 中已移除。

setup.cfg 文件中的 [pytest] 部分现在应命名为 [tool:pytest]，以避免与其他 distutils 命令冲突。

Metafunc.addcall¶

在版本 4.0 中已移除。

Metafunc.addcall 是当前参数化机制的前身。用户应改为使用 pytest.Metafunc.parametrize()。

示例

def pytest_generate_tests(metafunc):
    metafunc.addcall({"i": 1}, id="1")
    metafunc.addcall({"i": 2}, id="2")

变为

def pytest_generate_tests(metafunc):
    metafunc.parametrize("i", [1, 2], ids=["1", "2"])

`cached_setup`¶

在版本 4.0 中已移除。

request.cached_setup 是 fixture 可用的 setup/teardown 机制的前身。

示例

@pytest.fixture
def db_session():
    return request.cached_setup(
        setup=Session.create, teardown=lambda session: session.close(), scope="module"
    )

应更新此项以使用标准 fixture 机制

@pytest.fixture(scope="module")
def db_session():
    session = Session.create()
    yield session
    session.close()

您可以查阅文档中的 fixture 比较部分以获取更多信息。

非顶级 conftest 文件中的 pytest_plugins¶

在版本 4.0 中已移除。

现在不建议在非顶级 conftest.py 文件中定义 pytest_plugins，因为它们将全局激活引用的插件，这很令人惊讶，因为对于所有其他 pytest 功能，conftest.py 文件仅对位于其中或之下的测试有效。

`Config.warn` 和 `Node.warn`¶

在版本 4.0 中已移除。

这些方法是内部 pytest 警告系统的一部分，但自 3.8 以来，pytest 正在为其自己的警告使用内置警告系统，因此这两个函数现在已弃用。

Config.warn 应替换为对标准 warnings.warn 的调用，例如

config.warn("C1", "some warning")

变为

warnings.warn(pytest.PytestWarning("some warning"))

Node.warn 现在支持两种签名

node.warn(PytestWarning("some message"))：现在是调用此函数的推荐方式。警告实例必须是 PytestWarning 或子类。
node.warn("CI", "some message")：此代码/消息形式已被移除，应转换为上面的警告实例形式。

record_xml_property¶

在版本 4.0 中已移除。

record_xml_property fixture 现在已弃用，取而代之的是更通用的 record_property，其他使用者（例如 pytest-html）可以使用它来获取有关测试运行的自定义信息。

这只是重命名 fixture 的问题，因为 API 是相同的

def test_foo(record_xml_property): ...

更改为

def test_foo(record_property): ...

将命令行字符串传递给 `pytest.main()`¶

在版本 4.0 中已移除。

不建议将命令行字符串传递给 pytest.main()

pytest.main("-v -s")

请改为传递列表

pytest.main(["-v", "-s"])

通过传递字符串，用户期望 pytest 将使用他们正在使用的 shell 规则（例如 bash 或 Powershell）来解释该命令行，但这很难/不可能以可移植的方式实现。

直接调用 fixture¶

在版本 4.0 中已移除。

不建议直接调用 fixture 函数，而不是在测试函数中请求它们。

例如

@pytest.fixture
def cell():
    return ...


@pytest.fixture
def full_cell():
    cell = cell()
    cell.make_full()
    return cell

这是新用户困惑的主要来源，他们经常互换调用 fixture 函数并在测试函数中请求它们，这破坏了 fixture 解析模型。

在这些情况下，只需在依赖 fixture 中直接请求该函数

@pytest.fixture
def cell():
    return ...


@pytest.fixture
def full_cell(cell):
    cell.make_full()
    return cell

或者，如果 fixture 函数在测试中被多次调用（使其难以应用上述模式），或者您想对代码进行最小的更改，您可以创建一个 fixture，该 fixture 使用 name 参数调用原始函数

def cell():
    return ...


@pytest.fixture(name="cell")
def cell_fixture():
    return cell()

`yield` 测试¶

在版本 4.0 中已移除。

pytest 支持 yield 样式的测试，其中测试函数实际上 yield 函数和值，然后将其转换为适当的测试方法。示例

def check(x, y):
    assert x**x == y


def test_squared():
    yield check, 2, 4
    yield check, 3, 9

这将导致生成两个实际的测试函数。

这种形式的测试函数不能正确支持 fixture，用户应切换到 pytest.mark.parametrize

@pytest.mark.parametrize("x, y", [(2, 4), (3, 9)])
def test_squared(x, y):
    assert x**x == y

通过 `Node` 访问的内部类¶

在版本 4.0 中已移除。

现在通过 Node 实例访问 Module、Function、Class、Instance、File 和 Item 会发出此警告

usage of Function.Module is deprecated, please use pytest.Module instead

用户应该只需 import pytest 并使用 pytest 模块访问这些对象。

这已被记录为弃用多年，但现在我们才真正发出弃用警告。

`Node.get_marker`¶

在版本 4.0 中已移除。

作为 Marker 改造和迭代的一部分，_pytest.nodes.Node.get_marker 已被移除。请参阅文档，了解有关如何更新代码的提示。

`somefunction.markname`¶

在版本 4.0 中已移除。

作为 Marker 改造和迭代的一部分，我们已经不建议使用 MarkInfo，获取元素 marker 的唯一正确方法是通过 node.iter_markers(name)。

`pytest_namespace`¶

在版本 4.0 中已移除。

此钩子已被弃用，因为它极大地复杂化了 pytest 内部关于配置和初始化的部分，使得一些错误修复和重构变得不可能。

用法示例

class MySymbol: ...


def pytest_namespace():
    return {"my_symbol": MySymbol()}

依赖于此钩子的插件作者应改为要求用户现在直接导入插件模块（使用适当的公共 API）。

作为权宜之计，插件作者仍然可以将他们的名称注入到 pytest 的命名空间中，通常是在 pytest_configure 期间

import pytest


def pytest_configure():
    pytest.my_symbol = MySymbol()

弃用和移除¶

已弃用功能¶

pytest.importorskip 关于 ImportError 的默认行为¶

Node 构造函数的 fspath 参数已替换为 pathlib.Path¶

使用 markers 配置 hook specs/impls¶

hooks 的 py.path.local 参数已替换为 pathlib.Path¶

直接构造内部类¶

pytest.Collector 和 pytest.Item 之间的菱形继承¶

自定义 Node 子类的构造函数应接受 **kwargs¶

将标记应用于 fixture 函数¶

在测试函数中返回非 None 值¶

yield_fixture 函数/装饰器¶

已移除的功能和重大变更¶

支持为 nose 编写的测试¶

setup/teardown¶

@with_setup¶

compat_co_firstlineno 属性¶

将 msg= 传递给 pytest.skip、pytest.fail 或 pytest.exit¶

pytest.Instance collector¶

使用 pytest.warns(None)¶

Parser.addoption 中的向后兼容性¶

--strict 命令行选项¶

实现 pytest_cmdline_preparse hook¶

pytest 8 中的集合更改¶

pytest.Package 不再是 pytest.Module 或 pytest.File¶

收集 __init__.py 文件不再收集包¶

pytest.collect 模块¶

pytest_warning_captured 钩子¶

pytest._fillfuncargs 函数¶

--no-print-logs 命令行选项¶

结果日志 (--result-log)¶

pytest_collect_directory 钩子¶

TerminalReporter.writer¶

junit_family 默认值更改为 “xunit2”¶

节点构造已更改为 Node.from_parent¶

pytest.fixture 参数仅为关键字参数¶

funcargnames 是 fixturenames 的别名¶

pytest.config 全局对象¶

pytest.raises 的 "message" 参数¶

raises / warns 的第二个参数是字符串¶

在自定义 Collector 中使用 Class¶

pytest.mark.parametrize 中的 marks¶

pytest_funcarg__ 前缀¶

setup.cfg 文件中的 [pytest] 部分¶

Metafunc.addcall¶

cached_setup¶

非顶级 conftest 文件中的 pytest_plugins¶

Config.warn 和 Node.warn¶

record_xml_property¶

将命令行字符串传递给 pytest.main()¶

直接调用 fixture¶

yield 测试¶

通过 Node 访问的内部类¶

Node.get_marker¶

somefunction.markname¶

pytest_namespace¶

`pytest.importorskip` 关于 `ImportError` 的默认行为¶

Node 构造函数的 `fspath` 参数已替换为 `pathlib.Path`¶

hooks 的 `py.path.local` 参数已替换为 `pathlib.Path`¶

`pytest.Collector` 和 `pytest.Item` 之间的菱形继承¶

自定义 `Node` 子类的构造函数应接受 `**kwargs`¶

`yield_fixture` 函数/装饰器¶

`compat_co_firstlineno` 属性¶

将 `msg=` 传递给 `pytest.skip`、`pytest.fail` 或 `pytest.exit`¶

`pytest.Instance` collector¶

使用 `pytest.warns(None)`¶

`Parser.addoption` 中的向后兼容性¶

`--strict` 命令行选项¶

实现 `pytest_cmdline_preparse` hook¶

`pytest.Package` 不再是 `pytest.Module` 或 `pytest.File`¶

收集 `init.py` 文件不再收集包¶

`pytest.collect` 模块¶

`pytest_warning_captured` 钩子¶

`pytest._fillfuncargs` 函数¶

`--no-print-logs` 命令行选项¶

结果日志 (`--result-log`)¶

`pytest_collect_directory` 钩子¶

`junit_family` 默认值更改为 “xunit2”¶

节点构造已更改为 `Node.from_parent`¶

`pytest.fixture` 参数仅为关键字参数¶

`funcargnames` 是 `fixturenames` 的别名¶

`pytest.config` 全局对象¶

`pytest.raises` 的 `"message"` 参数¶

`raises` / `warns` 的第二个参数是字符串¶

在自定义 Collector 中使用 `Class`¶

`pytest.mark.parametrize` 中的 marks¶

`pytest_funcarg__` 前缀¶

`cached_setup`¶

`Config.warn` 和 `Node.warn`¶

将命令行字符串传递给 `pytest.main()`¶

`yield` 测试¶

通过 `Node` 访问的内部类¶

`Node.get_marker`¶

`somefunction.markname`¶

`pytest_namespace`¶