================= pytest-clarity

.. image:: https://img.shields.io/pypi/v/pytest-clarity.svg :target: https://pypi.org/project/pytest-clarity :alt: PyPI version

.. image:: https://img.shields.io/conda/vn/conda-forge/pytest-clarity.svg :target: https://anaconda.org/conda-forge/pytest-clarity :alt: conda-forge version

.. image:: https://img.shields.io/pypi/pyversions/pytest-clarity.svg :target: https://pypi.org/project/pytest-clarity :alt: Python versions

.. image:: https://travis-ci.org/darrenburns/pytest-clarity.svg?branch=master :target: https://travis-ci.org/darrenburns/pytest-clarity :alt: 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:

.. image:: https://raw.githubusercontent.com/darrenburns/pytest-clarity/master/pytest-clarity.png :alt: Example output with clarity

The same test, without pytest-clarity:

.. image:: https://raw.githubusercontent.com/darrenburns/pytest-clarity/master/without-clarity.png :alt: 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 :code:--diff-type (auto (default), split or unified):

::

pytest -vv --diff-type=split

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

::

pytest -vv --no-hints

You can configure the width of the output with the :code:--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.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter .. _@hackebrot: https://github.com/hackebrot .. _MIT: http://opensource.org/licenses/MIT .. _BSD-3: http://opensource.org/licenses/BSD-3-Clause .. _GNU GPL v3.0: http://www.gnu.org/licenses/gpl-3.0.txt .. _Apache Software License 2.0: http://www.apache.org/licenses/LICENSE-2.0 .. _cookiecutter-pytest-plugin: https://github.com/pytest-dev/cookiecutter-pytest-plugin .. _file an issue: https://github.com/darrenburns/pytest-clarity/issues .. _pytest: https://github.com/pytest-dev/pytest .. _tox: https://tox.readthedocs.io/en/latest/ .. _pip: https://pypi.org/project/pip/ .. _PyPI: https://pypi.org/project