40

In python, If I have a JSON object obj, then I can

print json.dumps(obj, sort_keys=True, indent=4)

in order to get a pretty printout of the object. Is it possible to prettify the output even further: add some colors in particular? Something like the result of [1]

cat foo.json | jq '.'

[1] jq the JSON Swiss Army toolbox: http://stedolan.github.io/jq/

8
  • What is jq? What does it do? Commented Sep 3, 2014 at 7:45
  • Maybe ipython has something for this, buy i don't know exactly Commented Sep 3, 2014 at 7:52
  • @Tichodroma: Added a reference Commented Sep 3, 2014 at 7:53
  • @stalk: I want it to be integrated in the script, such that the output to the console will be colored. Commented Sep 3, 2014 at 7:54
  • 2
    It is definitely possible (you can just call this jq as a subprocess from Python) but if you are asking: "is there a way to do that with the built-in json library" then the answer is "no". Commented Sep 3, 2014 at 8:00

4 Answers 4

66

You can use Pygments to color your JSON output. Based on what you have:

formatted_json = json.dumps(obj, sort_keys=True, indent=4)

from pygments import highlight, lexers, formatters
colorful_json = highlight(unicode(formatted_json, 'UTF-8'), lexers.JsonLexer(), formatters.TerminalFormatter())
print(colorful_json)

Output example:

Output example of pygments colored code

Sign up to request clarification or add additional context in comments.

4 Comments

What do I need in order to avoid NameError: name 'unicode' is not defined?
Then you are using python 3 and should simply use colorful_json = highlight(formatted_json, lexers.JsonLexer(), formatters.TerminalFormatter())
How can I achieve this on Windows?
NameError: name 'unicode' is not defined ---> import unicode
12

I like using rich which has a dependency on pyments. But it covers all your console coloring needs, used in pip to show progress and also autoformats json: enter image description here

1 Comment

Shorthand: rich.print_json(data=d)
9

The accepted answer doesn't seem to be working with more recent versions of Pygments and Python. So here's how you can do it in Pygments 2.7.2+:

import json
from pygments import highlight
from pygments.formatters.terminal256 import Terminal256Formatter
from pygments.lexers.web import JsonLexer

d = {"test": [1, 2, 3, 4], "hello": "world"}

# Generate JSON
raw_json = json.dumps(d, indent=4)

# Colorize it
colorful = highlight(
    raw_json,
    lexer=JsonLexer(),
    formatter=Terminal256Formatter(),
)

# Print to console
print(colorful)

Comments

1

For python3 :

#!/usr/bin/python3
#coding: utf-8

from pygments import highlight, lexers, formatters
import json

d = {"test": [1, 2, 3, 4], "hello": "world"}

formatted_json = json.dumps(d, indent=4)
colorful_json = highlight(formatted_json, lexers.JsonLexer(), formatters.TerminalFormatter())
print(colorful_json)

Comments

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.