完整的 pytest 文档¶

下载最新版本的 PDF

从这里开始¶

开始

使用指南¶

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

更多主题¶

发布公告