pytest-html

library4.2.0pypypi✓ verified 27d ago

pytest-html is a plugin for the pytest testing framework that generates comprehensive HTML reports for test results. It provides a visual overview of test runs, including pass/fail status, durations, and detailed information for each test. The library is actively maintained, with version 4.2.0 being the current release, and follows a frequent release cadence, addressing bug fixes and improvements regularly.

testing

pip install pytest-html

github ↗package ↗

INSTALL

IMPORT

SIG · PYTEST-HTML

pytest-html

testingpythonv4.2.0

Install

3.1s avg

Import

—

Disk

31MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v4.2.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 32.5MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 3.1s · import 0.000s · 33MB

31MB installed

● package 31MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

pytest_html

✓ import pytest_html

✗ import pytest_html from py.xml import html # For HTML content in hooks

Create a test file (e.g., `test_example.py`). Run pytest from your terminal, specifying the `--html` option to define the report filename and `--self-contained-html` to embed all CSS/JS directly into the HTML, making it easier to share.

import pytest # test_example.py def test_pass(): assert True def test_fail(): assert False def test_skipped(): pytest.skip("This test is skipped") # To run tests and generate a self-contained HTML report: # $ pytest --html=report.html --self-contained-html # (Run this command in your terminal where test_example.py is located)

Debug

Known issues

breakingPython 3.7 support was dropped in `pytest-html` v4.0.0. Ensure your Python environment is 3.8+ to use versions 4.x.x.

fix

Upgrade Python to 3.8 or newer, or downgrade pytest-html to a 3.x.x version.

affects: >=4.0.0

breakingThe `py` module was removed as a dependency in `pytest-html` v4.0.0. If your `conftest.py` or custom plugins directly imported `py` for XML/HTML generation (e.g., `from py.xml import html`), you may need to adjust your code. While `py.xml.html` is still commonly used in examples, its direct dependency on `py` is gone.

fix

Remove explicit dependencies on `py` if no longer needed. The `py.xml.html` module is still implicitly available via `pytest-html`'s internal usage or if `pytest` itself provides it, but consider direct HTML string generation for custom content where possible to reduce implicit dependencies.

affects: >=4.0.0

deprecatedConfiguration options `duration_formatter` and `render_collapsed = True` were deprecated in v4.0.0. `duration_formatter` has no effect, and `render_collapsed = True` should be replaced with `render_collapsed = all` for consistency with query parameters.

fix

Remove `duration_formatter` as it's no longer supported. Update `render_collapsed = True` in your `pytest.ini` or `pyproject.toml` to `render_collapsed = all`.

affects: >=4.0.0

deprecatedThe `report.extra` attribute and the `extra` fixture were deprecated in v4.0.0. Use `report.extras` and the `extras` fixture instead for adding custom content to reports.

fix

Update your `conftest.py` hooks or test functions to use `report.extras.append(...)` and inject content via the `extras` fixture instead of `extra`.

affects: >=4.0.0

gotchaWhen using `--self-contained-html`, images or links added as external resources (e.g., screenshots saved to separate files) may not display correctly as they are not embedded into the report. The plugin will issue a warning.

fix

For truly self-contained reports with images, embed images directly into the HTML using base64 encoding if possible, or ensure external image files are bundled and accessible alongside the report.

affects: All versions

gotchaCustomizing the report table using hooks like `pytest_html_results_table_header` might lead to empty result tables when running tests with tags in `pytest-html` v4.1.1 and v4.2.0 due to the hook not being invoked.

fix

This is a known issue (GitHub #849). Check the project's issue tracker for updates. Downgrading to v3.2.0 might temporarily resolve it, or refactor custom column additions to a different hook or mechanism if available.

affects: 4.1.1, 4.2.0

Upgrade

Version history

4.2.0latest on PyPI · released Jan 19, 2026

Audit

Dependencies

pytestrequiredpytest-html is a plugin for the pytest testing framework.

ansi2htmloptionalRequired for converting ANSI escape codes to HTML in reports. Not a direct dependency due to licensing.

pytest-metadataoptionalProvides the 'Environment' section in the HTML report.

Agent activity

15 hits · last 30 days

node

Resources

githubhttps://github.com/pytest-dev/pytest-html ↗

packagehttps://pypi.org/project/pytest-html/ ↗