完整的 pytest 文档¶

Download latest version as PDF

这里开始¶

快速上手

学习指南¶

如何调用 pytest
- 指定要运行的测试
- 获取关于版本、选项名称、环境变量的帮助
- 分析测试执行持续时间
- 管理插件的加载
- 调用 pytest 的其他方法
如何编写和报告测试中的断言
- 使用 assert 语句断言
- 关于预期异常的断言
- 关于预期警告的断言
- 使用上下文敏感的比较
- 为失败的断言定义自己的解释
- 断言内省的细节
如何使用 fixtures
- “Requesting” fixtures
- Autouse fixture(不必请求的 fixture)
- 范围：跨类、模块、包或会话共享 fixture
- Teardown/Cleanup（又名 Fixture 终结）
- 安全拆解
- Running multiple assert statements safely
- Fixtures can introspect the requesting test context
- 使用标记将数据传递给 fixture
- fixtures 工厂
- 参数化 fixtures
- Using marks with parametrized fixtures
- Modularity: using fixtures from a fixture function
- Automatic grouping of tests by fixture instances
- Use fixtures in classes and modules with usefixtures
- Overriding fixtures on various levels
- Using fixtures from other projects
如何用属性标记测试函数
- 注册标记
- Raising errors on unknown marks
如何参数化 fixtures 和测试函数
- @pytest.mark.parametrize：参数化测试函数
- pytest_generate_tests 基本例子
- 更多例子
如何在测试中使用临时目录和文件
- tmp_path fixture
- tmp_path_factory fixture
- tmpdir 和 tmpdir_factory fixtures
- 默认的基本临时目录
How to monkeypatch/mock modules and environments
- Monkeypatching functions
- Monkeypatching returned objects: building mock classes
- Global patch example: preventing “requests” from remote operations
- Monkeypatching environment variables
- Monkeypatching dictionaries
- API Reference
How to run doctests
- Encoding
- Using ‘doctest’ options
- Continue on failure
- Output format
- pytest-specific features
- Alternatives
如何重新运行失败的测试并在测试运行之间保持状态
- 用法
- Rerunning only failures or failures first
- Behavior when no tests failed in the last run
- The new config.cache object
- Inspecting Cache content
- Clearing Cache content
- Stepwise
如何管理日志记录
- caplog fixture
- Live Logs
- Customizing Colors
- Release notes
- Incompatible changes in pytest 3.4
How to capture stdout/stderr output
- Default stdout/stderr/stdin capturing behaviour
- Setting capturing methods or disabling capturing
- Using print statements for debugging
- Accessing captured output from a test function
How to capture warnings
- Controlling warnings
- @pytest.mark.filterwarnings
- Disabling warnings summary
- Disabling warning capture entirely
- DeprecationWarning and PendingDeprecationWarning
- Ensuring code triggers a deprecation warning
- Asserting warnings with the warns function
- Recording warnings
- Additional use cases of warnings in tests
- Custom failure messages
- Internal pytest warnings
- Resource Warnings
How to use skip and xfail to deal with tests that cannot succeed
- Skipping test functions
- XFail: mark test functions as expected to fail
- Skip/xfail with parametrize
如何安装并使用插件
- Requiring/Loading plugins in a test module or conftest file
- Finding out which plugins are active
- Deactivating / unregistering a plugin by name
Writing plugins
- Plugin discovery order at tool startup
- conftest.py: local per-directory plugins
- Writing your own plugin
- Making your plugin installable by others
- Assertion Rewriting
- Requiring/Loading plugins in a test module or conftest file
- Accessing another plugin by name
- Registering custom markers
- Testing plugins
Writing hook functions
- hook function validation and execution
- firstresult: stop at first non-None result
- hookwrapper: executing around other hooks
- Hook function ordering / call example
- Declaring new hooks
- Using hooks in pytest_addoption
- Optionally using hooks from 3rd party plugins
- Storing data on items across hook functions
How to use pytest with an existing test suite
- Running an existing test suite with pytest
How to use unittest-based tests with pytest
- Benefits out of the box
- pytest features in unittest.TestCase subclasses
- Mixing pytest fixtures into unittest.TestCase subclasses using marks
- Using autouse fixtures and accessing other fixtures
How to run tests written for nose
- 用法
- Supported nose Idioms
- Unsupported idioms / known issues
- Migrating from nose to pytest
How to implement xunit-style set-up
- Module level setup/teardown
- Class level setup/teardown
- Method and function level setup/teardown
如何设置 bash 自动补全

进一步主题¶

Release announcements