Skip to main content

A pytest plugin for colorful print statements

Project description

pytest-crayons

A pytest plugin for colorful print statements.

Installation

pip install pytest-crayons

Usage

  1. Include a color fixture in the param list of a test.
  2. Then use it instead of print.
def test_magenta(magenta):
    blue("this should be magenta")

Just like normal print statements, you only see the output if:

  • There's an failure in the test.
  • or you pass in -s or --capture=no
  • or you wrap the statement in a with capsys.disabled(): block.

For our examples, we'll use -s:

output of test_something

Available colors

  • red
  • green
  • yellow
  • blue
  • magenta
  • cyan

Example with all colors:

def test_colors(red, green, yellow, blue, magenta, cyan):
    print("") # for the newline
    red("this should be red")
    green("this should be green")
    yellow("this should be yellow")
    blue("this should be blue")
    magenta("this should be magenta")
    cyan("this should be cyan")

output of test_colors

This was included in a talk for PyCascades 2023

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-crayons-0.0.7.tar.gz (93.3 kB view details)

Uploaded Source

Built Distribution

pytest_crayons-0.0.7-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

Details for the file pytest-crayons-0.0.7.tar.gz.

File metadata

  • Download URL: pytest-crayons-0.0.7.tar.gz
  • Upload date:
  • Size: 93.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for pytest-crayons-0.0.7.tar.gz
Algorithm Hash digest
SHA256 c1f1c13c00a4b71005f67ae6605c6f44019c961372f78e622bcfbe8a7229ed9c
MD5 d8d01df51387a4916186948102b3c167
BLAKE2b-256 f87bf31ff22a5f5d066f57cc055ac282069e87ffe011d1e6c31674d5f5505910

See more details on using hashes here.

File details

Details for the file pytest_crayons-0.0.7-py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_crayons-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 f33b6ce9e45a7c41dd54790b8161448df2a51b24090a66fd83e147e8496b95da
MD5 2ec7a59d1be5b3977d78c532eb0f614a
BLAKE2b-256 2f747d5544154d496b506384abc8dd7fbae9de528b92b05ee9819515769390b9

See more details on using hashes here.

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