HOWTO · Python

Python のクラスオブジェクトを JSON にシリアライズする方法

このチュートリアルでは、Python におけるシリアライゼーションについて説明し、Python クラスの JSON シリアライゼーションを実演します。

このページの内容

カスタムの Python インスタンスは、標準の json エンコーダーに直接渡すことはできません。まず JSON 互換の値に変換し、JSON テキストが必要な場合は json.dumps() を使用してください。そのテキストを代わりにファイルライクオブジェクトに書き込むには、json.dump() を使用します。

Python におけるシリアライゼーション

シリアライゼーションは、データを、保存や転送が可能で後から再構築できる表現に変換します。JSON はオブジェクト、配列、文字列、数値、ブール値、null をサポートします。Python ではこれらは辞書、リスト、文字列、数値、ブール値、None に対応します。カスタムクラスのインスタンスには自動的な JSON 表現がないため、その属性のどれを公開し、それらをサポートされる値に変換するかを決める必要があります。

Python クラスを JSON シリアライズ可能にする

JSON エンコーダーは、ネストされた辞書やリストを含む Python の組み込み値を処理します。カスタムインスタンスについては、見つかった各インスタンスを辞書に変換する default 関数を json.dumps() に渡してください。これはネストされたカスタムオブジェクトでも機能しますが、変換がエンコーダーの処理できる値を返すことが条件です。

toJSON() メソッドを使用して JSON クラスをシリアライズ可能にする

toJSON() は、クラスの作成者が選ぶ通常のメソッド名です。Python の json モジュールが自動的に呼び出すことはありません。1 つの選択肢は、エンコーダーの default 引数を使い、このメソッドに JSON テキストを返させることです。

この例を実行してください。

import json


class Pet:
    def __init__(self, name):
        self.name = name


class Person:
    def __init__(self, name, age, pet):
        self.name = name
        self.age = age
        self.pet = pet

    def toJSON(self):
        return json.dumps(self, default=lambda value: value.__dict__, sort_keys=True)


person = Person("Kelvin", 20, Pet("Brunno"))
print(person.toJSON())

この例は実行可能なコードとして提供されていますが、その実行結果は示されていません。そのため、その出力はここでは検証されていません。default コールバックは Person とネストされた Pet の両方に適用されます。属性自体がサポートされていない場合は、その値についても変換ルールを追加してください。

JSON シリアライゼーションをクラス内にラップする

クラスが変換ステップ自体を担い、JSON 互換の値の辞書を返すこともできます。その辞書を json.dumps() に渡します。dataclass は、そのフィールドがすでに公開するデータを表している場合に便利です。

from dataclasses import asdict, dataclass
import json


@dataclass
class Student:
    id: int
    name: str

    def toJSON(self):
        return asdict(self)


student = Student(id=1, name="Kelvin")
json_text = json.dumps(student.toJSON())
print(json_text)

この例も、ここでは実行されていません。asdict() は dataclass のフィールドを辞書に変換し、json.dumps() が JSON テキストを返します。ファイル出力には、返された文字列を出力する代わりに、開いたファイルライクオブジェクトで json.dump(student.toJSON(), file_object) を呼び出してください。どちらの方法でも、任意のネストされた Python オブジェクトがシリアライズ可能になるわけではありません。その値も変換されている必要があります。