完整的 pytest 文档¶

下载最新版本（PDF）

从这里开始¶

入门

操作指南¶

如何调用 pytest
- 指定要运行的测试
- 获取版本、选项名称、环境变量的帮助
- 分析测试执行持续时间
- 管理插件加载
- 其他调用 pytest 的方式
如何在测试中编写和报告断言
- 使用 assert 语句进行断言
- 关于近似相等的断言
- 关于预期异常的断言
- 关于预期警告的断言
- 利用上下文敏感的比较
- 为失败断言定义自己的解释
- 在测试函数中返回非 None 值
- 断言内省详情
如何使用 fixtures
- “请求”fixtures
- 自动使用 fixtures（无需请求的 fixtures）
- 范围：在类、模块、包或会话之间共享 fixtures
- 拆卸/清理（又称 Fixture 终结）
- 安全拆卸
- 安全运行多个 assert 语句
- Fixtures 可以自省请求测试上下文
- 使用标记将数据传递给 fixtures
- 工厂作为 fixtures
- 参数化 fixtures
- 将标记与参数化 fixtures 一起使用
- 模块化：从 fixture 函数中使用 fixtures
- 按 fixture 实例自动分组测试
- 在类和模块中使用 usefixtures
- 在各个级别覆盖 fixtures
- 使用其他项目的 fixtures
如何用属性标记测试函数
- 注册标记
- 对未知标记抛出错误
如何参数化 fixtures 和测试函数
- @pytest.mark.parametrize: 参数化测试函数
- 基本 pytest_generate_tests 示例
- 更多示例
如何在测试中使用临时目录和文件
- The tmp_path fixture
- The tmp_path_factory fixture
- The tmpdir and tmpdir_factory fixtures
- 临时目录位置和保留
如何猴子补丁/模拟模块和环境
- 猴子补丁函数
- 猴子补丁返回对象：构建模拟类
- 全局补丁示例：阻止“请求”远程操作
- 猴子补丁环境变量
- 猴子补丁字典
- API 参考
如何运行 doctests
- 编码
- 使用“doctest”选项
- 失败时继续
- 输出格式
- pytest 特有功能
- 替代方案
如何重新运行失败的测试并在测试运行之间保持状态
- 用法
- 只重新运行失败或优先运行失败的测试
- 上次运行没有测试失败时的行为
- 新的 config.cache 对象
- 检查缓存内容
- 清除缓存内容
- 逐步执行
如何管理日志
- caplog fixture
- 实时日志
- 自定义颜色
- 发布说明
- pytest 3.4 中的不兼容变更
如何捕获 stdout/stderr 输出
- 默认 stdout/stderr/stdin 捕获行为
- 设置捕获方法或禁用捕获
- 使用 print 语句进行调试
- 从测试函数访问捕获的输出
如何捕获警告
- 控制警告
- @pytest.mark.filterwarnings
- 禁用警告摘要
- 完全禁用警告捕获
- DeprecationWarning 和 PendingDeprecationWarning
- 确保代码触发弃用警告
- 使用 warns 函数断言警告
- 记录警告
- 测试中警告的其他用例
- 自定义失败消息
- 内部 pytest 警告
- 资源警告
如何使用 skip 和 xfail 处理无法成功的测试
- 跳过测试函数
- XFail：将测试函数标记为预期失败
- 使用 parametrize 跳过/xfail
如何安装和使用插件
- 在测试模块或 conftest 文件中要求/加载插件
- 找出哪些插件是活动的
- 按名称停用/注销插件
- 禁用插件自动加载
编写插件
- 工具启动时的插件发现顺序
- conftest.py：本地每目录插件
- 编写自己的插件
- 使你的插件可供他人安装
- 断言重写
- 在测试模块或 conftest 文件中要求/加载插件
- 按名称访问另一个插件
- 注册自定义标记
- 测试插件
编写钩子函数
- 钩子函数验证和执行
- firstresult：在第一个非 None 结果处停止
- 钩子包装器：围绕其他钩子执行
- 钩子函数排序/调用示例
- 声明新钩子
- 在 pytest_addoption 中使用钩子
- 选择性地使用第三方插件的钩子
- 在钩子函数之间存储项目数据
如何将 pytest 与现有测试套件一起使用
- 使用 pytest 运行现有测试套件
如何将基于 unittest 的测试与 pytest 一起使用
- 开箱即用的优势
- unittest.TestCase 子类中的 pytest 功能
- 使用标记将 pytest fixtures 混入 unittest.TestCase 子类
- 使用自动使用 fixtures 和访问其他 fixtures
如何实现 xunit 风格的设置
- 模块级设置/拆卸
- 类级设置/拆卸
- 方法和函数级设置/拆卸
如何设置 bash 自动补全

更多主题¶

发布公告