Full pytest documentation¶

Download latest version as PDF

Start here¶

入门

How-to guides¶

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

Further topics¶

Release announcements