Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

A plugin providing an alternative, colourful diff output for failing assertions.

Project description

PyPI version conda-forge version Python versions See Build Status on Travis CI

A plugin to improve the readability of pytest output.

Features

  • Enables an easier to parse and more understandable diff for your failing tests.
  • Can display unified diffs or split diffs, and chooses them depending on the context.
  • Adds helpful hints to the output for failing tests to help you track down common issues.

With pytest-clarity:

Example output with clarity

The same test, without pytest-clarity:

Example output without clarity

Requirements

Supports Python 2.7 and 3.4+

Installation

You can install “pytest-clarity” via pip from PyPI:

$ pip install pytest-clarity

Usage

Install the plugin as described above.

** The plugin will only be activated when the -vv option is supplied to pytest.**

You can choose which type of diff you want with --diff-type (auto (default), split or unified):

pytest -vv --diff-type=split

You can disable hints using the --no-hints flag:

pytest -vv --no-hints

You can configure the width of the output with the --diff-width option:

pytest -vv --diff-width=60

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the MIT license, “pytest-clarity” is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

This pytest plugin was generated with Cookiecutter along with @hackebrot’s cookiecutter-pytest-plugin template.

Project details


Download files

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

Files for pytest-clarity, version 0.3.0a0
Filename, size File type Python version Upload date Hashes
Filename, size pytest-clarity-0.3.0a0.tar.gz (6.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page