Note that ANSI code support depends on the ansi2html package. Due to the use of a less permissive license, this package is not included as a dependency. If you have this package installed, then ANSI codes will be converted to HTML in your report.
Creating a self-contained report¶
In order to respect the Content Security Policy (CSP), several assets such as CSS and images are stored separately by default. You can alternatively create a self-contained report, which can be more convenient when sharing your results. This can be done in the following way:
$ pytest --html=report.html --self-contained-html
Images added as files or links are going to be linked as external resources, meaning that the standalone report HTML file may not display these images as expected.
The plugin will issue a warning when adding files or links to the standalone report.
Custom CSS (Cascasding Style Sheets) can be passed on the command line using
--css option. These will be applied in the order specified, and can
be used to change the appearance of the report.
$ pytest --html=report.html --css=highcontrast.css --css=accessible.css
By default the report title will be the filename of the report, you can edit it by using the
def pytest_html_report_title(report): report.title = "My very own title!"
The Environment section is provided by the pytest-metadata plugin, and can be accessed
To modify the Environment section before tests are run, use
def pytest_configure(config): config._metadata["foo"] = "bar"
To modify the Environment section after tests are run, use
import pytest @pytest.hookimpl(tryfirst=True) def pytest_sessionfinish(session, exitstatus): session.config._metadata["foo"] = "bar"
Note that in the above example @pytest.hookimpl(tryfirst=True) is important, as this ensures that a best effort attempt is made to run your
pytest_sessionfinish before any other plugins ( including
pytest-metadata ) run theirs.
If this line is omitted, then the Environment table will not be updated since the
pytest_sessionfinish of the plugins will execute first,
and thus not pick up your change.
The generated table will be sorted alphabetically unless the metadata is a
It is possible to redact variables from the environment table. Redacted variables will have their names displayed, but their values grayed out.
This can be achieved by setting
environment_table_redact_list in your INI configuration file (e.g.:
environment_table_redact_list is a
linelist of regexes. Any environment table variable that matches a regex in this list has its value redacted.
For example, the following will redact all environment table variables that match the regexes
[pytest] environment_table_redact_list = ^foo$ .*redact.* bar
Additional summary information¶
You can edit the Summary section by using the
from py.xml import html def pytest_html_results_summary(prefix, summary, postfix): prefix.extend([html.p("foo: bar")])
You can add details to the HTML report by creating an ‘extra’ list on the report object. Here are the types of extra content that can be added:
Note: When adding an image from file, the path can be either absolute or relative.
Note: When using
--self-contained-html, images added as files or links
may not work as expected, see section Creating a self-contained report for
There are also convenient types for several image formats:
The following example adds the various types of extras using a
pytest_runtest_makereport hook, which can be implemented in a plugin or
import pytest @pytest.hookimpl(hookwrapper=True) def pytest_runtest_makereport(item, call): pytest_html = item.config.pluginmanager.getplugin("html") outcome = yield report = outcome.get_result() extra = getattr(report, "extra", ) if report.when == "call": # always add url to report extra.append(pytest_html.extras.url("http://www.example.com/")) xfail = hasattr(report, "wasxfail") if (report.skipped and xfail) or (report.failed and not xfail): # only add additional html on failure extra.append(pytest_html.extras.html("<div>Additional HTML</div>")) report.extra = extra
You can also specify the
name argument for all types other than
html which will change the title of the
created hyper link:
extra.append(pytest_html.extras.text("some string", name="Different title"))
It is also possible to use the fixture
extra to add content directly
in a test function without implementing hooks. These will generally end up
before any extras added by plugins.
from pytest_html import extras def test_extra(extra): extra.append(extras.text("some string"))
Modifying the results table¶
You can modify the columns of the report by implementing custom hooks for the header and rows.
The following example
conftest.py adds a description column with the test function docstring,
adds a sortable time column, and removes the links column:
from datetime import datetime from py.xml import html import pytest def pytest_html_results_table_header(cells): cells.insert(2, html.th("Description")) cells.insert(1, html.th("Time", class_="sortable time", col="time")) cells.pop() def pytest_html_results_table_row(report, cells): cells.insert(2, html.td(report.description)) cells.insert(1, html.td(datetime.utcnow(), class_="col-time")) cells.pop() @pytest.hookimpl(hookwrapper=True) def pytest_runtest_makereport(item, call): outcome = yield report = outcome.get_result() report.description = str(item.function.__doc__)
You can also remove results by implementing the
pytest_html_results_table_row hook and removing all cells. The
following example removes all passed results from the report:
def pytest_html_results_table_row(report, cells): if report.passed: del cells[:]
The log output and additional HTML can be modified by implementing the
pytest_html_results_html hook. The following example replaces all
additional HTML and log output with a notice that the log is empty:
from py.xml import html def pytest_html_results_table_html(report, data): if report.passed: del data[:] data.append(html.div("No log output captured.", class_="empty log"))
Auto Collapsing Table Rows¶
By default, all rows in the Results table will be expanded except those that have
This behavior can be customized either with a query parameter:
or by setting the
render_collapsed in a configuration file (pytest.ini, setup.cfg, etc).
[pytest] render_collapsed = True
render_collapsed will, unlike the query parameter, affect all statuses.
Controlling Test Result Visibility Via Query Params¶
By default, all tests are visible, regardless of their results. It is possible to control which tests are visible on
page load by passing the
visible query parameter. To use this parameter, please pass a comma separated list
of test results you wish to be visible. For example, passing
?visible=passed,skipped will show only those
tests in the report that have outcome
Note that this match is case insensitive, so passing
passed has the same effect.
The following query parameters may be passed:
Formatting the Duration Column¶
The formatting of the timestamp used in the
Durations column can be modified by setting
report attribute. All time.strftime formatting directives are supported. In addition, it is possible
%f to get duration milliseconds. If this value is not set, the values in the
Durations column are
%S.%f format where
%S is the total number of seconds a test ran for.
Below is an example of a
conftest.py file setting
import pytest @pytest.hookimpl(hookwrapper=True) def pytest_runtest_makereport(item, call): outcome = yield report = outcome.get_result() setattr(report, "duration_formatter", "%H:%M:%S.%f")
NOTE: Milliseconds are always displayed with a precision of 2