良好的集成实践¶

使用 pip 安装包¶

对于开发，我们建议您使用 venv 创建虚拟环境，并使用 pip 安装您的应用程序和所有依赖项，以及 pytest 包本身。这可以确保您的代码和依赖项与系统 Python 安装隔离。

在您的仓库根目录中创建一个 pyproject.toml 文件，具体说明请参见 Packaging Python Projects。前几行应该如下所示：

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "PACKAGENAME"
version = "PACKAGEVERSION"

其中 PACKAGENAME 和 PACKAGEVERSION 分别是您的包的名称和版本。

然后，您可以从同一目录运行以下命令以“可编辑”模式安装您的包：

pip install -e .

这使您可以随意更改源代码（包括测试和应用程序）并重新运行测试。

Python 测试发现约定¶

pytest 实现以下标准测试发现：

如果未指定任何参数，则收集从 testpaths（如果已配置）或当前目录开始。此外，命令行参数可以以目录、文件名或节点 ID 的任意组合形式使用。
递归进入目录，除非它们与 norecursedirs 匹配。
在这些目录中，搜索 test_*.py 或 *_test.py 文件，通过其测试包名称导入。
从这些文件中，收集测试项：
- 类外部以 test 为前缀的测试函数或方法。
- Test 前缀测试类（没有 __init__ 方法）内部以 test 为前缀的测试函数或方法。使用 @staticmethod 和 @classmethods 装饰的方法也会被考虑。

有关如何自定义测试发现的示例，请参阅更改标准（Python）测试发现。

在 Python 模块中，pytest 也使用标准的 unittest.TestCase 子类化技术来发现测试。

选择测试布局¶

pytest 支持两种常见的测试布局：

应用程序代码之外的测试¶

如果您有许多功能测试，或者出于其他原因希望将测试与实际应用程序代码分开（通常是个好主意），那么将测试放到应用程序代码之外的额外目录中可能会很有用。

pyproject.toml
src/
    mypkg/
        __init__.py
        app.py
        view.py
tests/
    test_app.py
    test_view.py
    ...

这有以下优点：

在执行 pip install . 后，您的测试可以针对已安装的版本运行。
在执行 pip install --editable . 后，您的测试可以针对可编辑安装的本地副本运行。

对于新项目，我们建议使用 importlib 导入模式（详见 which-import-mode）。为此，请将以下内容添加到您的 pyproject.toml 文件中：

[tool.pytest.ini_options]
addopts = [
    "--import-mode=importlib",
]

通常，特别是当您使用默认导入模式 prepend 时，强烈建议使用 src 布局。在这种布局中，您的应用程序根包位于根目录的子目录中，例如 src/mypkg/ 而不是 mypkg。

这种布局避免了许多常见陷阱，并具有许多优点，Ionel Cristian Mărieș 在这篇出色的博客文章中对此有更好的解释。

注意

如果您不使用可编辑安装并使用上述的 src 布局，则需要扩展 Python 的模块文件搜索路径，以便直接针对本地副本执行测试。您可以通过设置 PYTHONPATH 环境变量以临时方式完成此操作：

PYTHONPATH=src pytest

或者通过使用 pythonpath 配置变量并将以下内容添加到您的 pyproject.toml 中以永久方式完成此操作：

[tool.pytest.ini_options]
pythonpath = "src"

注意

如果您不使用可编辑安装且不使用 src 布局（即 mypkg 直接位于根目录中），您可以依赖 Python 默认将当前目录添加到 sys.path 中的事实来导入您的包，并运行 python -m pytest 直接针对本地副本执行测试。

有关调用 pytest 和 python -m pytest 之间差异的更多信息，请参阅调用 pytest 与 python -m pytest。

作为应用程序代码一部分的测试¶

如果测试与应用程序模块之间存在直接关系，并且您希望将它们与应用程序一起分发，则将测试目录内联到应用程序包中会很有用。

pyproject.toml
[src/]mypkg/
    __init__.py
    app.py
    view.py
    tests/
        __init__.py
        test_app.py
        test_view.py
        ...

在此方案中，使用 --pyargs 选项运行测试很容易：

pytest --pyargs mypkg

pytest 将发现 mypkg 的安装位置并从那里收集测试。

请注意，此布局也与上一节中提到的 src 布局结合使用。

注意

您可以为您的应用程序使用命名空间包（PEP420），但 pytest 仍将根据 __init__.py 文件的存在执行测试包名称发现。如果您使用上述两种推荐的文件系统布局之一，但从目录中省略了 __init__.py 文件，它应该能正常工作。但是，对于“内联测试”，您需要使用绝对导入来访问您的应用程序代码。

注意

在 prepend 和 append 导入模式下，如果 pytest 在递归文件系统时找到一个 "a/b/test_module.py" 测试文件，它会按如下方式确定导入名称：

确定 basedir：这是第一个“向上”（朝向根目录）不包含 __init__.py 的目录。例如，如果 a 和 b 都包含一个 __init__.py 文件，那么 a 的父目录将成为 basedir。
执行 sys.path.insert(0, basedir) 以使测试模块在完全限定的导入名称下可导入。
import a.b.test_module，其中路径是通过将路径分隔符 / 转换为“.”字符来确定的。这意味着您必须遵循目录和文件名直接映射到导入名称的约定。

这种稍微复杂的导入技术的原因是，在大型项目中，多个测试模块可能会相互导入，因此派生一个规范的导入名称有助于避免诸如测试模块被导入两次之类的意外。

使用 --import-mode=importlib 时，事情会变得不那么复杂，因为 pytest 不需要更改 sys.path，从而减少了意外情况。

选择导入模式¶

出于历史原因，pytest 默认为 prepend 导入模式，而不是我们为新项目推荐的 importlib 导入模式。原因在于 prepend 模式的工作方式：

由于没有包可以从中派生完整的包名，pytest 会将您的测试文件作为顶层模块导入。第一个示例（src 布局）中的测试文件将通过将 tests/ 添加到 sys.path 来作为 test_app 和 test_view 顶层模块导入。

与 importlib 导入模式相比，这会导致一个缺点：您的测试文件必须具有唯一名称。

如果您需要同名的测试模块，作为一种变通方法，您可以将 __init__.py 文件添加到您的 tests 文件夹及其子文件夹中，将它们更改为包：

pyproject.toml
mypkg/
    ...
tests/
    __init__.py
    foo/
        __init__.py
        test_view.py
    bar/
        __init__.py
        test_view.py

现在 pytest 将把模块加载为 tests.foo.test_view 和 tests.bar.test_view，允许您拥有同名模块。但这引入了一个微妙的问题：为了从 tests 目录加载测试模块，pytest 会将仓库的根目录预置到 sys.path 中，这带来了 mypkg 现在也可导入的副作用。

如果您使用 tox 等工具在虚拟环境中测试您的包，这会带来问题，因为您希望测试包的已安装版本，而不是仓库中的本地代码。

importlib 导入模式没有上述任何缺点，因为导入测试模块时 sys.path 不会改变。

tox¶

完成工作并希望确保您的实际包通过所有测试后，您可能需要了解一下 tox，这是一个 virtualenv 测试自动化工具。tox 帮助您设置具有预定义依赖项的 virtualenv 环境，然后执行带有选项的预配置测试命令。它将针对已安装的包运行测试，而不是针对您的源代码检出，这有助于检测打包故障。

不要通过 setuptools 运行¶

不建议与 setuptools 集成，即您不应使用 python setup.py test 或 pytest-runner，并且将来可能会停止工作。

此方法已弃用，因为它依赖于 setuptools 中已弃用的功能，并依赖于破坏 pip 安全机制的功能。例如，'setup_requires' 和 'tests_require' 会绕过 pip --require-hashes。有关更多信息和迁移说明，请参阅 pytest-runner 通知。另请参阅 pypa/setuptools#1684。

setuptools 计划移除 test 命令。

使用 flake8-pytest-style 进行检查¶

为了确保在项目中正确使用 pytest，使用 flake8-pytest-style flake8 插件可能会有所帮助。

flake8-pytest-style 检查 pytest 代码中常见的错误和编码风格违规，例如 fixtures 的不正确使用、测试函数名称和标记。通过使用此插件，您可以在开发过程的早期捕获这些错误，并确保您的 pytest 代码一致且易于维护。

flake8-pytest-style 检测到的 lint 列表可在其 PyPI 页面上找到。

注意

flake8-pytest-style 不是 pytest 的官方项目。有些规则强制执行某些风格选择，例如优先使用 @pytest.fixture() 而不是 @pytest.fixture，但您可以配置该插件以适应您偏好的风格。