Python で JSON ファイルをきれいに出力する方法

Jinku Hu 2023年1月30日 2019年11月3日

Python Python JSON

json.dumps メソッド
pprint メソッド

JSON ファイルを文字列に読み込むかロードすると、JSON ファイルの内容が乱雑になる可能性があります。

たとえば、1つの JSON ファイルでは、

[{"foo": "Etiam", "bar": ["rhoncus", 0, "1.0"]}]

ロードしてから出力する場合。

import json

with open(r'C:\test\test.json', 'r') as f:
    json_data = json.load(f)
    
print(json_data)

[{'foo': 'Etiam', 'bar': ['rhoncus', 0, '1.0']}]

結果は、通常見られる標準形式に比べて読みやすくなっています。

[
  {
    "foo": "Etiam",
    "bar": [
      "rhoncus",
      0,
      "1.0"
    ]
  }
]

`json.dumps` メソッド

json.dumps() 関数は、指定された obj を JSON 形式の str にシリアル化します。

指定されたインデントレベルで obj をきれいに出力するには、json.dumps() 関数のキーワードパラメーターindent に正の整数を与える必要があります。ident が 0 に設定されている場合、新しい行のみが挿入されます。

import json

with open(r'C:\test\test.json', 'r') as f:
    json_data = json.load(f)
    
print(json.dumps(json_data, indent=2))

[
  {
    "foo": "Etiam",
    "bar": [
      "rhoncus",
      0,
      "1.0"
    ]
  }
]

`pprint` メソッド

pprint モジュールは Python データ構造をきれいに出力する機能を提供します。pprint.pprint は Python オブジェクトをストリームにきれいに出力し、その後に改行が続きます。

import json
import pprint

with open(r'C:\test\test.json', 'r') as f:
    json_data = f.read()
    json_data = json.loads(json_data)
    
pprint.pprint(json_data)

JSON ファイルのデータコンテンツはきれいに出力されます。また、indent パラメーターを割り当てることでインデントを定義することもできます。

pprint.pprint(json_data, indent=2)

注意

pprint は一重'と二重引用符"を同じように扱いますが、JSON は"のみを使用するため、pprinted JSON ファイルの内容をファイルに直接保存することはできません。

そうしないと、新しいファイルは有効な JSON 形式として解析されません。

Author: Jinku Hu

Founder of DelftStack.com. Jinku has worked in the robotics and automotive industries for over 8 years. He sharpened his coding skills when he needed to do the automatic testing, data collection from remote servers and report creation from the endurance test. He is from an electrical/electronics engineering background but has expanded his interest to embedded electronics, embedded programming and front-/back-end programming.

json.dumps メソッド

pprint メソッド

関連記事 - Python JSON

`json.dumps` メソッド

`pprint` メソッド