python / python/cpython

Add colour to `pprint` output

Open
#145,217 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

stdlib type-feature
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

Feature or enhancement

Proposal:

We can use the existing syntax theme to add colour to the output of:

  • pprint.pp(data)
  • pprint.pprint(data)
  • pprint.PrettyPrinter().pprint(data)

https://github.com/python/cpython/blob/9b22261a86b54f198225426e86390ef8dd85e091/Lib/_colorize.py#L312-L323

As usual, this will respect the environment variables to control colour and the output stream's capabilities.

Has this already been discussed elsewhere?

This is a minor feature, which does not need previous discussion elsewhere

Links to previous discussion of this feature:

No response

Linked PRs
  • gh-145218

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 reviewing the syntax theme implementation in Lib/_colorize.py at the referenced lines, then inspect the linked PR gh-145218 for the current implementation context. Check how pprint.pp, pprint.pprint, and PrettyPrinter().pprint produce output, and confirm that the completed behavior respects environment variables and output-stream capabilities.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.