pytest + emoji == ๐
Do you find writing tests tedious or boring? It can be - but it doesn't need to be.
pytest is a mature testing framework for Python that is developed by a thriving and ever-growing community of volunteers. It uses plain assert statements and regular Python comparisons. Writing tests with pytest requires little to no boilerplate code and powerful features allow easy parametrization and intelligent test selection.
It can be easily extended and has hundreds of plugins available. Distributed under the terms of the MIT license, pytest is free and open source software.
Check out pytest if you haven't already and if you're not sold just yet, install this plugin. Maybe that will get you motivated ๐
This pytest plugin was generated with Cookiecutter along with @hackebrot's Cookiecutter-pytest-plugin template.
pytest-emoji is available for Python 3. ๐
You can install pytest-emoji via pip from PyPI:
$ pip install pytest-emoji
This will automatically install pytest of version 3.0.1 or higher.
This plugin adds a --emoji
CLI flag to pytest, which replaces the test
result indicator to emojis, both for normal and verbose mode.
๐ / PASSED ๐
for passed tests๐ฐ / FAILED ๐ฐ
for failed tests๐ / xfail ๐
for xfailed tests๐ฒ / XPASS ๐ฒ
for xpassed tests๐ / SKIPPED ๐
for skipped tests๐ก / ERROR ๐ก
for tests with errors
Normal mode:
$ pytest --emoji
tests/test_emoji.py ๐ ๐ฐ ๐ ๐ฒ ๐ ๐ก
Verbose mode:
$ pytest --verbose --emoji
tests/test_emoji.py::test_passed PASSED ๐
tests/test_emoji.py::test_failed FAILED ๐ฐ
tests/test_emoji.py::test_xfailed xfail ๐
tests/test_emoji.py::test_xpassed XPASS ๐ฒ
tests/test_emoji.py::test_skipped SKIPPED ๐
tests/test_emoji.py::test_error ERROR ๐ก
You can also change the emojis, if you want. ๐
Add a conftest.py
to your tests folder and implement the following hooks.
If you wish to use the default, omit the according hook.
def pytest_emoji_passed(config):
return u'๐ช ', u'PASSED ๐ช '
def pytest_emoji_failed(config):
return u'๐ฟ ', u'FAILED ๐ฟ '
def pytest_emoji_skipped(config):
return u'๐ ', u'SKIPPED ๐ '
def pytest_emoji_error(config):
return u'๐ฉ ', u'ERROR ๐ฉ '
def pytest_emoji_xfailed(config):
return u'๐ค ', u'xfail ๐ค '
def pytest_emoji_xpassed(config):
return u'๐ ', u'XPASS ๐ '
Naming is important, make sure you don't make any typos!
All of these hooks receive the pytest config
object, which allows you to
check options and further customize the output. All hooks need to return a
tuple of str
as in ('<shortletter>', '<verbose-word>')
.
It's recommended for emoji to add an extra ' '
(blank) for better formatting.
Contributions are very welcome. Tests can be run with tox.
Distributed under the terms of the MIT license, pytest-emoji is free and open source software
If you encounter any problems, please file an issue along with a detailed description.
Everyone interacting in the pytest-emoji project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PyPA Code of Conduct.