【Python】クラスをJSONにシリアライズする方法

2023-12-132023-12-14

この記事では、PythonでクラスオブジェクトをJSONにシリアライズする方法について解説します。

具体的には、クラスを辞書に変換し、辞書をJSON文字列に変換する方法や、クラスの属性を制御する方法について説明します。

さらに、JSONシリアライズの注意点も紹介します。

初心者の方でもわかりやすく解説しているので、ぜひ参考にしてください。

目次から探す

JSONライブラリのインポート

PythonでクラスオブジェクトをJSONにシリアライズするためには、まずJSONライブラリをインポートする必要があります。

Pythonには標準ライブラリとしてjsonモジュールが用意されており、これを使ってJSONの操作ができます。

JSONライブラリをインポートするには、以下のようにimport文を使用します。

import json

jsonモジュールをインポートすることで、JSONのシリアライズやデシリアライズなどの操作が可能になります。

クラスをJSONにシリアライズする方法

Pythonでは、クラスオブジェクトをJSON形式に変換してシリアライズすることができます。

これにより、クラスのインスタンスをファイルに保存したり、ネットワークを介してデータを送受信したりする際に便利です。

クラスを辞書に変換する

まず、クラスオブジェクトをJSONにシリアライズするためには、クラスを辞書に変換する必要があります。

これは、クラスの属性を辞書のキーとして、属性の値を辞書の値として持つようにします。

以下は、例としてPersonというクラスを定義し、そのインスタンスを辞書に変換する方法です。

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

person = Person("John", 25)
person_dict = vars(person)

vars()関数を使うことで、クラスのインスタンスを辞書に変換することができます。

person_dictには、{name: John, age: 25}という辞書が格納されます。

辞書をJSON文字列に変換する

次に、辞書をJSON文字列に変換する必要があります。

Pythonには、jsonモジュールが組み込まれており、これを使用することで簡単に辞書をJSON文字列に変換することができます。

以下は、先ほどのperson_dictをJSON文字列に変換する方法です。

import json

person_json = json.dumps(person_dict)

json.dumps()関数を使うことで、辞書をJSON文字列に変換することができます。

person_jsonには、'{name: "John", age: 25}'というJSON文字列が格納されます。

これで、クラスオブジェクトを辞書に変換し、さらにJSON文字列に変換することができました。

json.dumps()関数の引数には、オプションとしてindentやsort_keysなどを指定することができます。

これにより、JSON文字列の整形やキーのソートなどを行うことができます。

クラスの属性を制御する

クラスをJSONにシリアライズする際、シリアライズ対象となる属性を制御することができます。

以下では、いくつかの方法を紹介します。

シリアライズ対象の属性を制限する

クラスの一部の属性のみをJSONにシリアライズしたい場合、__dict__属性を利用してクラスの属性を辞書に変換し、シリアライズ対象の属性のみを含む新しい辞書を作成することができます。

例えば、以下のようなクラスがあるとします。

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

このクラスのインスタンスをJSONにシリアライズする際、nameとageの属性のみを含めたい場合、次のようにします。

person = Person("John", 25, "Tokyo")
serialized_data = json.dumps(person.__dict__, indent=4)

このようにすることで、address属性は含まれず、nameとageの属性のみがJSONにシリアライズされます。

シリアライズ対象外の属性を指定する

逆に、クラスの一部の属性をシリアライズ対象外にしたい場合もあります。

その場合は、__dict__属性を利用してクラスの属性を辞書に変換し、シリアライズ対象外の属性を削除することができます。

例えば、以下のようなクラスがあるとします。

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

このクラスのインスタンスをJSONにシリアライズする際、address属性を含めたくない場合、次のようにします。

person = Person("John", 25, "Tokyo")
data = person.__dict__
del data['address']
serialized_data = json.dumps(data, indent=4)

このようにすることで、address属性は含まれず、nameとageの属性のみがJSONにシリアライズされます。

シリアライズ時に属性名を変更する

クラスの属性名をJSONにシリアライズする際、別の名前に変更したい場合もあります。

その場合は、json.dumps()のdefault引数を利用して、属性名を変更する関数を指定することができます。

例えば、以下のようなクラスがあるとします。

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

このクラスのインスタンスをJSONにシリアライズする際、name属性をfull_nameという名前に変更したい場合、次のようにします。

def rename_attribute(obj):
    if isinstance(obj, Person):
        return {
            'full_name': obj.name,
            'age': obj.age,
            'address': obj.address
        }
    return obj

person = Person("John", 25, "Tokyo")
serialized_data = json.dumps(person, default=rename_attribute, indent=4)

このようにすることで、name属性はfull_nameという名前に変更され、JSONにシリアライズされます。

以上が、クラスの属性を制御してJSONにシリアライズする方法の一部です。

必要に応じてこれらの方法を組み合わせて利用することで、より柔軟なシリアライズが可能となります。