12 pytest的安装和配置

在上一篇教程中，我们学习了如何使用 unittest 进行测试，尤其是创建和组织测试用例与测试套件。现在，我们将重点介绍如何安装和配置 pytest，并为我们接下来的教程打下坚实的基础。pytest 是一个强大的测试框架，它提供了许多便利的功能，使得测试编写和执行更加高效。

1. 安装pytest

使用 pytest 进行自动化测试的第一步是安装它。你可以通过 pip 这一个包管理工具来安装 pytest。

安装步骤

打开你的命令行工具，输入以下命令：

pip install pytest

这条命令会从 Python 的软件包索引（PyPI）下载并安装最新版的 pytest。完成后，你可以通过以下命令来验证安装是否成功：

pytest --version

如果安装成功，你将看到类似于以下的输出，显示 pytest 的版本号：

pytest 6.2.4

使用虚拟环境

为了避免与其他项目的依赖冲突，建议你在虚拟环境中安装 pytest。可以使用 venv 来创建一个虚拟环境：

python -m venv myenv
source myenv/bin/activate  # 在Linux和macOS上
myenv\Scripts\activate  # 在Windows上
pip install pytest

2. pytest的基本配置

pytest 不需要复杂的配置，但你可以创建一个配置文件，来自定义一些设置。配置文件通常是一个名为 pytest.ini 或 pyproject.toml 的文件，放在你的项目根目录中。

创建pytest.ini示例

在你的项目目录中创建一个名为 pytest.ini 的文件，内容如下：

[pytest]
addopts = -v  # 启用详细模式
testpaths = tests  # 指定测试文件夹

• addopts 用于指定一些命令行参数，比如 -v 表示输出详细的测试信息。
• testpaths 用于告诉 pytest 从哪个目录查找测试文件。

文件组织结构

pytest 推荐的测试文件结构如下：

my_project/
│
├── tests/
│   ├── test_sample.py
│
├── pytest.ini
└── main.py

在上述结构中，tests 目录包含你的测试文件。每个测试文件通常以 test_ 开头，测试函数也应以 test_ 开头，以使 pytest 能够自动识别它们。

3. 运行pytest

一旦你安装并配置好了 pytest，你可以非常简单地运行它来执行测试。

pytest

默认情况下，pytest 会查找以 test_ 开头的文件，并运行其中以 test_ 开头的函数。

运行特定测试文件

如果你只想运行某个特定的测试文件，可以指定文件名，例如：

pytest tests/test_sample.py

这样，pytest 只会运行指定文件中的测试用例。

4. 常用命令行选项

为了更好地使用 pytest，了解一些常用的命令行选项是非常重要的。以下是一些常用的选项：

• -v / --verbose：以详细模式输出测试结果。
• -q / --quiet：只输出失败的测试信息。
• --maxfail=N：在达到 N 个失败后停止测试。
• --disable-warnings：禁用警告信息的输出。

示例

例如，如果你希望在运行测试时仅显示错误信息，并限制最多只进行 3 次失败后停止测试，可以使用如下命令：

pytest -q --maxfail=3 --disable-warnings

小结

通过本文的学习，我们实现了 pytest 的安装和基础配置。了解了如何组织测试文件及使用基本命令行选项。接下来，我们将在下一篇教程中介绍 pytest 的基础用法，进一步探索如何编写测试用例并利用 pytest 的丰富功能。

希望这些指导能帮助你顺利开始使用 pytest 进行测试！