HOWTO · Python
Python で辞書を文字列に変換する
このチュートリアルでは、Python で辞書を文字列に変換する方法とその逆の方法を示します
このページの内容
辞書を文字列に変換する方法は、表示、ログへの記録、データ交換など、用途によって異なります。str() はPythonの表現を返し、json.dumps() はデータ交換用のJSONテキストを生成し、pprint.pformat() は読みやすい形式に整えます。また、ループを使えば表示形式を独自に定義できます。どの方法でも結果は文字列ですが、元の型がすべて保たれるわけではなく、辞書を再構築できるとも限りません。
辞書を文字列に変換する方法を選ぶ
デバッグメッセージなど、手早くPython向けの表現を得たい場合は str() を使います。別のシステムがJSONを想定しており、値がJSONで扱える型なら json.dumps() を使います。入れ子になったPythonデータを見やすくしたい場合は pprint.pformat() が適しています。name: Alice, score: 9 のように出力形式を指定したい場合は、独自の文字列を組み立てます。
これらは互いに置き換えられるシリアライズ形式ではありません。独自の表示用文字列や str() の結果は、曖昧であったり、別のプログラムで解析する用途に適さなかったりすることがあります。JSONが扱えるのはオブジェクト、配列、文字列、数値、真偽値、nullです。タプルやセットなどPython固有の値は、変換するか、別の方法を選ぶ必要があります。pickleも文字列への変換ではありません。シリアライズ結果はバイト列であり、信頼できない入手元のpickleデータを読み込むと、有害なコードが実行されるおそれがあります。
Pythonの表現を得るには str() を使う
読みやすいPythonの表現で十分なら、簡潔に使えるのが str(dictionary) です。辞書の波括弧と、キーや値のPython形式の表現が含まれます。この書式はPython向けであり、言語をまたいで使えるデータ形式ではありません。たとえば、Pythonでは True と None を使いますが、JSONでは true と null を使います。
次の例を実行します。
このセクションのコードと表示されるラベルや出力は英語のままです。
details = {"name": "Ada", "active": True}
text = str(details)
print(type(text).__name__)
print(text)
str
{'name': 'Ada', 'active': True}
辞書を dict という名前の変数に代入するのは避けてください。Python組み込みの型がその名前で参照できなくなります。また、オブジェクトを文字列に変換しても、その文字列から元に戻せるとは限りません。
json.dumps() で辞書をJSONにシリアライズする
標準的なデータ交換用の文字列には json.dumps() を使います。対応する json.loads() 関数を使うと、JSONテキストをPythonの値に戻せます。JSONで往復できるのはJSON互換のデータであり、すべてのPython型が保たれるわけではありません。タプルは配列になり、読み込み後はリストになります。また、辞書のキーにはJSONでサポートされる型を使う必要があります。既定ではASCII以外の文字はエスケープされます。文字をそのまま出力するには ensure_ascii=False を指定します。indent を指定するとJSONが読みやすくなり、用途に合えば sort_keys=True でキーの順序を安定させられます。
次の例を実行します。
このセクションのコードと表示されるラベルや出力は英語のままです。
import json
record = {"name": "Ada", "score": 9}
text = json.dumps(record)
restored = json.loads(text)
print(text)
print(restored == record)
{"name": "Ada", "score": 9}
True
json.dumps() が返す値は文字列です。辞書にJSONでエンコードできない値が含まれる場合は、意図した変換方法を用意するか、そのデータに適した形式を選んでください。JSONがあらゆるPythonオブジェクトを扱えると考えてはいけません。
読みやすい出力に整えるには pprint.pformat() を使う
コンソールへ直接出力するのではなく、整形済みの文字列が必要な場合は pprint.pformat() を使います。入れ子のデータにも便利で、長い構造を複数行に分けて表示できます。結果はPython向けの表示形式であり、JSONではありません。オプションで幅、インデント、深さ、コンパクトさを調整できます。深さに上限を設けると入れ子の内容が省略されるため、整形後の文字列にすべての値が表示されるとは限りません。
次の例を実行します。
このセクションのコードと表示されるラベルや出力は英語のままです。
import pprint
record = {"user": {"name": "Ada", "roles": ["author", "editor"]}}
text = pprint.pformat(record, sort_dicts=False)
print(type(text).__name__)
print(text)
str
{'user': {'name': 'Ada', 'roles': ['author', 'editor']}}
返された文字列は、ログメッセージなど必要な場所で使えます。一方、pprint.pprint() は整形済みのテキストをストリームに書き込みます。結果を変数に保存するのではなく、その場で出力したい場合に便利です。
ループで独自の文字列を組み立てる
独自の形式なら、区切り記号やラベルを自由に指定できます。str.join() を使った内包表記は、文字列の連結を繰り返さずに済み、末尾に余分な区切り記号を付けずに済む方法も簡潔です。別のプログラムが結果を解析する場合は、値に指定した区切り記号が含まれるときの扱いを決めてください。単純な表示形式では、エスケープ規則は自動的に用意されません。
次の例を実行します。
このセクションのコードと表示されるラベルや出力は英語のままです。
scores = {"Ada": 9, "Lin": 8}
text = ", ".join(f"{name}: {score}" for name, score in scores.items())
print(text)
Ada: 9, Lin: 8
この方法は人が読む1行の表示に適しています。結果を別のシステムと交換したり、後で解析できるように保存したりする場合は、JSONを使うか、引用符やエスケープの規則を明確に定めた形式を設計して実装してください。
文字列を辞書に戻す
JSON文字列の解析には json.loads() を使います。これはJSON構文を受け付けますが、str() が返す任意のPython出力を解析できるわけではありません。自分で管理しているPythonリテラルの文字列であれば、ast.literal_eval() を使って辞書などの対応するリテラル構造を解析できます。任意のPython式を実行することはありません。ただし、汎用パーサーではないため、信頼できない入力や、非常に大きい入力、処理負荷の高い入力には使わないでください。解析後の型と内容が、アプリケーションの要件を満たすことも確認します。
次の例を実行します。
このセクションのコードと表示されるラベルや出力は英語のままです。
import ast
import json
json_text = '{"name": "Ada", "score": 9}'
python_text = "{'name': 'Ada', 'score': 9}"
print(json.loads(json_text))
print(ast.literal_eval(python_text))
{'name': 'Ada', 'score': 9}
{'name': 'Ada', 'score': 9}
文字列の生成に使った形式に対応するパーサーを選んでください。明確な規則を定め、それに対応するパーサーを用意しない限り、任意の独自表示文字列から辞書を確実に復元することはできません。