Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hjwp/pytest-icdiff

better error messages for assert equals in pytest
https://github.com/hjwp/pytest-icdiff

Last synced: 25 days ago
JSON representation

better error messages for assert equals in pytest

Awesome Lists containing this project

README

        

=============
pytest-icdiff
=============

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

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

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

Better diffs in `pytest`_ assertion error messages using `ICDiff`_.

Usage
-----

pip install pytest-icdiff

Once you've installed it, ``pytest`` will produce nice colourised diffs for any ``assert ==`` :

.. image:: https://raw.githubusercontent.com/hjwp/pytest-icdiff/main/example_output.png?raw=true
:alt: example colourised diff

Issues and PRs welcome.

Thanks to the maintainers of `ICDiff`_ and also `pprintpp`_ !

License
-------

Distributed under the terms of the `Unlicense`_ license, "pytest-icdiff" is free and open source software

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
.. _`cookiecutter-pytest-plugin`: https://github.com/pytest-dev/cookiecutter-pytest-plugin
.. _`pytest`: https://github.com/pytest-dev/pytest
.. _`Unlicense`: http://unlicense.org
.. _`icdiff`: https://www.jefftk.com/icdiff
.. _`pprintpp`: https://github.com/wolever/pprintpp