Skip to main content

pytest plugin to display BDD info in HTML test report

Project description

PyPI release Issues License

A pytest plugin to display BDD info in the pytest-html-generated HTML test report.

Apart from pytest-html, it plugs into pytest-bdd plugin’s hooks.


To use the plugin, just install it:

# source .venv/bin/activate
pip install pytest-bdd-html
pytest -vv ...

If you use tox, list the plugin as a dependency:

; tox.ini
deps = ...

commands = pytest -vv ...

There will be a new 3rd column with label “Description” in the test report specified by --html=... command line option of pytest-html.

Command line options

Available command line options are as follows.


Specifies a path to a custom CSS file for styling of the Description column. pytest_bdd_html/resources/style.css is used by default if PATH does not exist or is not specified. See CSS classes for how the column cells are structured.

CSS classes

For each test case (one row in the pytest-html-generated HTML report), the Description column’s cell has one of the following structures, differing for BDD and non-BDD tests (.XXX denotes a HTML element with CSS class="XXX").

Structure of cell for BDD test

    /* Feature */
         div /* feature name */
         div /* feature description; optional */

    /* Scenario */

    /* Steps */
        .step /* one or more steps */

Structure of cell for non-BDD test with functional comment


Structure of cell for non-BDD test without functional comment

  .col-description-no-doc /* an empty div */

Version update

bumpver test -p 0.1.13a0 "MAJOR.MINOR.PATCH[PYTAGNUM]"
bumpver update -n -d -p
bumpver update -n -p

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest-bdd-html-0.1.14a0.tar.gz (5.7 kB view hashes)

Uploaded source

Built Distribution

pytest_bdd_html-0.1.14a0-py3-none-any.whl (6.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page