Pytest Check

2.8.0 · active · verified Fri Apr 10

pytest-check is a pytest plugin that extends standard pytest functionality to allow multiple assertion failures within a single test function without immediately stopping test execution. Instead of failing on the first `assert`, it collects all 'checks' and reports them at the end of the test. The current version is 2.8.0, and it maintains an active release cadence with regular updates.

Warnings

deprecated The import pattern `import pytest_check as check` for using helper functions (e.g., `check.equal()`, `check.is_true()`) is deprecated. While it currently works, it will be removed in a future major version without a deprecation warning being emitted.
Fix: Change imports to `from pytest_check import check` or pass `check` as a fixture to your test functions (e.g., `def test_my_func(check):`).
breaking The default behavior for displaying pseudo-tracebacks changed in version 2.x. Only the first failure per test will now include a pseudo-traceback by default (`--check-max-tb=1`). Previously, more might have been shown.
Fix: If you require more pseudo-tracebacks for debugging, configure the `--check-max-tb=N` command-line option, where `N` is the desired number of tracebacks. Setting it to a large number like 1000 will show all.
gotcha The pseudo-tracebacks used by `pytest-check` for multiple failures are generated via introspection, which can be slower than standard assert tracebacks. Limiting the number of pseudo-tracebacks (via `--check-max-tb`) is a performance optimization.
Fix: Be mindful of performance if `--check-max-tb` is set to a very high number in test suites with many failures. The default of 1 is chosen for speed. You can also limit the total reported failures per test with `--check-max-report=N`.

Install

pip install pytest-check Install with pip

Imports

check
```
from pytest_check import check
```
The pattern `import pytest_check as check` for accessing helper functions (e.g., `check.equal()`) is deprecated and will be removed in a future version. Use `from pytest_check import check` or request `check` as a fixture (e.g., `def test_my_func(check):`).

Quickstart

This example demonstrates how to use `pytest-check` with both its `with check:` context manager for standard assertions and its direct helper functions like `check.equal()`. A normal `assert` outside of `with check:` will stop the test immediately, while checks inside the context manager or using `check.` methods will collect all failures before reporting them at the end of the test.

import httpx
from pytest_check import check

def test_httpx_get():
    # This assert will stop the test immediately if it fails
    r = httpx.get('https://www.example.org/')
    assert r.status_code == 200

    # These 'checks' will all run, collecting failures, 
    # even if one of them fails
    with check: 
        assert r.is_redirect is False
    with check: 
        assert r.encoding == 'utf-8'
    with check: 
        assert 'Example Domain' in r.text
    
    # pytest-check also provides helper functions for common assertions
    check.equal(r.status_code, 200, msg='Status code not 200')

view raw JSON →