pallets / pallets/click

[Feature] Color support for Exceptions

Open
#944 4 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help output
Dominant language
Python
Stars
17.7k
Forks
2.3k
Avg merge
1d 30m
Merged PRs (30d)
18

Description

Right now, the click module gives us the option of using colors only through click.echo and click.secho commands. I was thinking that if we can tweak the classes inside the exceptions.py file and use secho inside them in place of echo, then we can give the users an option of colorizing error/exception messages.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the classes in exceptions.py and the existing click.echo and click.secho behavior. Clarify how users would opt into colorized exception messages and what existing output must remain unchanged; the issue names no test file, so identify focused coverage for both colored and default output.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.