Skip to main content

A pytest plugin that adds emojis to your test result report

Project description


A pytest plugin that adds emojis to your test result report ๐Ÿ˜


pytest is a mature testing framework for Python that is developed by a thriving 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.

There are hundreds of plugins available for pytest with which you can extend and customize your testing harness. 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 to write more tests! ๐Ÿ˜

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 4.2.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/ ๐Ÿ˜ƒ ๐Ÿ˜ฐ ๐Ÿ˜ž ๐Ÿ˜ฒ ๐Ÿ™„ ๐Ÿ˜ก

Verbose mode:

$ pytest --verbose --emoji
tests/ PASSED ๐Ÿ˜ƒ
tests/ FAILED ๐Ÿ˜ฐ
tests/ XFAIL ๐Ÿ˜ž
tests/ XPASS ๐Ÿ˜ฒ
tests/ SKIPPED ๐Ÿ™„
tests/ ERROR ๐Ÿ˜ก


You can also change the emojis, if you want. ๐Ÿ˜›

Add a 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 "๐Ÿช ", "PASSED ๐Ÿช "

def pytest_emoji_failed(config):
    return "๐Ÿ˜ฟ ", "FAILED ๐Ÿ˜ฟ "

def pytest_emoji_skipped(config):
    return "๐Ÿ™ˆ ", "SKIPPED ๐Ÿ™ˆ "

def pytest_emoji_error(config):
    return "๐Ÿ’ฉ ", "ERROR ๐Ÿ’ฉ "

def pytest_emoji_xfailed(config):
    return "๐Ÿค“ ", "XFAIL ๐Ÿค“ "

def pytest_emoji_xpassed(config):
    return "๐Ÿ˜œ ", "XPASS ๐Ÿ˜œ "

Naming the hooks correctly 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.


Are you interested in contributing to pytest-emoji? Your contributions are greatly appreciated! Every little bit helps, and credit will always be given!

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.


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


Distributed under the terms of the MIT license, pytest-emoji is free and open source software

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-emoji-0.2.0.tar.gz (6.2 kB view hashes)

Uploaded source

Built Distribution

pytest_emoji-0.2.0-py3-none-any.whl (5.7 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