良好的集成实践¶

使用 pip 安装包¶

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

在您的仓库根目录中创建一个 pyproject.toml 文件，如打包 Python 项目中所述。前几行应如下所示

[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，虚拟环境测试自动化工具。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 代码中的常见错误和编码风格违规，例如 fixture 的不正确使用、测试函数名称和标记。通过使用此插件，您可以尽早发现开发过程中的这些错误，并确保您的 pytest 代码一致且易于维护。

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

注意

flake8-pytest-style 不是官方的 pytest 项目。某些规则强制执行某些样式选择，例如使用 @pytest.fixture() 而不是 @pytest.fixture，但您可以配置插件以适应您喜欢的样式。