pytest-pretty

1.3.0 · active · verified Sat Apr 11

pytest-pretty is an opinionated pytest plugin designed to enhance the readability of test output and simplify the process of identifying and resolving errors. It provides features such as a real-time error summary, a rich, tabulated display of failures, and a more visually appealing overall summary of the test run. The current version is 1.3.0, and while its release cadence is irregular, the project is actively maintained.

Warnings

gotcha When running pytest-pretty in CI/CD environments such as GitHub Actions, the default terminal width might truncate the rich output. This can make the enhanced summary tables and error details less readable.
Fix: Set the `COLUMNS` environment variable in your CI/CD workflow file to a larger value (e.g., `COLUMNS: 120`) to ensure the output is displayed fully.
gotcha If you intend to use the `pytester_pretty` fixture (which replaces pytest's built-in `pytester` for interacting with `pytest-pretty`'s modified output), you must explicitly enable the `pytester` plugin.
Fix: Add `pytest_plugins = "pytester"` to your `conftest.py` file to make the `pytester_pretty` fixture available to your tests.
breaking As a pytest plugin, `pytest-pretty`'s compatibility and behavior can be indirectly affected by breaking changes in the core `pytest` framework, particularly with major `pytest` version upgrades.
Fix: Always consult the `pytest` changelog (e.g., for `pytest 8.0.0` and subsequent versions) for breaking changes, especially concerning test collection, hooks, and plugin APIs. Test your suite thoroughly after upgrading `pytest`.

Install

pip install -U pytest-pretty Install latest version

Imports

pytest-pretty (plugin)
```
No explicit import usually needed, automatically activated by pytest.
```
As a pytest plugin, pytest-pretty automatically integrates upon installation. Direct imports are typically not required for its core functionality.
pytester_pretty (fixture)
```
from pytest_pretty import pytester_pretty
```
While pytest_pretty provides a pytester_pretty fixture, it is typically made available by setting pytest_plugins = "pytester" in conftest.py, allowing it to be used directly in tests without explicit import statements in test files.

Quickstart

After installing `pytest-pretty`, simply run `pytest` from your terminal in a directory containing your test files (e.g., `test_example.py`). The plugin will automatically enhance the test summary, error reporting, and overall output. For optimal display in CI/CD environments like GitHub Actions, it's recommended to set the `COLUMNS` environment variable to a sufficient width.

# test_example.py

def test_passing_example():
    assert 1 + 1 == 2

def test_failing_example():
    # This assertion will fail to demonstrate the pretty failure output
    assert {"a": 1, "b": 2} == {"a": 1, "b": 3}

# To run the tests, navigate to the directory containing test_example.py
# and run the following command in your terminal:
# pytest

# For GitHub Actions, consider adding:
# env:
#   COLUMNS: 120
# to your workflow .yml file for better output formatting.

view raw JSON →