[Python] jsonとクラス間で変換(Encode/Decode)する方法

Q: カスタムエンコーダーとデコーダーはどのように作成するのか？

カスタムエンコーダーは、json.JSONEncoderを継承してdefaultメソッドをオーバーライドすることで作成します。 このメソッドで、特定のクラスのインスタンスを辞書に変換する処理を実装します。 カスタムデコーダーは、json.loads()関数のobject_hookパラメータに関数を渡すことで実装します。 この関数内で、辞書をクラスのインスタンスに変換する処理を行います。 例：json.dumps(obj, cls=CustomEncoder)やjson.loads(json_str, object_hook=custom_decoder)のように使用します。

2023-12-132024-08-25

Pythonでは、クラスのインスタンスをJSON形式に変換するために、jsonモジュールを使用します。通常、json.dumps()関数を用いてクラスのインスタンスを辞書に変換し、その辞書をJSON文字列にエンコードします。

逆に、JSON文字列をクラスのインスタンスにデコードするには、json.loads()関数を使用して辞書に変換し、その辞書を用いてクラスのインスタンスを生成します。

これにより、クラスとJSONの間でデータを簡単にやり取りすることが可能になります。

この記事でわかること

PythonクラスをJSONにエンコードする方法
JSONをPythonクラスにデコードする方法
複雑なネスト構造やデータバリデーションの実装例
JSON Schemaを用いたクラス設計の利点
外部APIやデータベースとのデータ交換方法

目次から探す

PythonクラスをJSONにエンコードする方法

PythonでクラスのインスタンスをJSON形式にエンコードする方法について解説します。

JSONはデータ交換フォーマットとして広く利用されており、PythonのクラスをJSONに変換することで、データの保存や通信が容易になります。

クラスのインスタンスを辞書に変換

まず、クラスのインスタンスをJSONにエンコードするためには、インスタンスを辞書形式に変換する必要があります。

以下に、クラスのインスタンスを辞書に変換する方法を示します。

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age
    def to_dict(self):
        # クラスの属性を辞書に変換
        return {"name": self.name, "age": self.age}
# Personクラスのインスタンスを作成
person = Person("太郎", 30)
# インスタンスを辞書に変換
person_dict = person.to_dict()
print(person_dict)

{'name': '太郎', 'age': 30}

この例では、Personクラスのインスタンスを辞書に変換するために、to_dictメソッドを定義しています。

このメソッドは、クラスの属性を辞書形式で返します。

json.dumps()を使用したエンコード

辞書に変換したクラスのインスタンスをJSON形式にエンコードするには、Pythonの標準ライブラリであるjsonモジュールのdumps関数を使用します。

import json
# 辞書をJSON文字列にエンコード
person_json = json.dumps(person_dict, ensure_ascii=False)
print(person_json)

{"name": "太郎", "age": 30}

json.dumps()関数は、辞書をJSON形式の文字列に変換します。

ensure_ascii=Falseを指定することで、日本語などの非ASCII文字をそのまま出力することができます。

カスタムエンコーダーの作成

クラスのインスタンスを直接JSONにエンコードしたい場合は、カスタムエンコーダーを作成することができます。

以下にその方法を示します。

import json
class PersonEncoder(json.JSONEncoder):
    def default(self, obj):
        if isinstance(obj, Person):
            # Personクラスのインスタンスを辞書に変換
            return obj.to_dict()
        # デフォルトのエンコーディングを使用
        return super().default(obj)
# PersonクラスのインスタンスをJSON文字列にエンコード
person_json_custom = json.dumps(person, cls=PersonEncoder, ensure_ascii=False)
print(person_json_custom)

{"name": "太郎", "age": 30}

この例では、json.JSONEncoderを継承したPersonEncoderクラスを作成し、defaultメソッドをオーバーライドしています。

defaultメソッドでは、Personクラスのインスタンスを辞書に変換し、それ以外のオブジェクトはスーパークラスのdefaultメソッドに委譲しています。

これにより、json.dumps()関数でカスタムエンコーダーを指定して、クラスのインスタンスを直接JSONにエンコードすることができます。

JSONをPythonクラスにデコードする方法

JSON形式のデータをPythonのクラスにデコードする方法について解説します。

JSONデータをクラスのインスタンスに変換することで、データをオブジェクト指向的に扱うことが可能になります。

JSON文字列を辞書に変換

まず、JSON形式の文字列をPythonの辞書に変換します。

これには、Pythonの標準ライブラリであるjsonモジュールのloads関数を使用します。

import json
# JSON文字列
json_string = '{"name": "太郎", "age": 30}'
# JSON文字列を辞書に変換
person_dict = json.loads(json_string)
print(person_dict)

{'name': '太郎', 'age': 30}

json.loads()関数は、JSON形式の文字列をPythonの辞書に変換します。

この辞書を使って、次にクラスのインスタンスを生成します。

辞書をクラスのインスタンスに変換

辞書形式のデータをクラスのインスタンスに変換するには、クラスのコンストラクタを使用します。

以下にその方法を示します。

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age
    @classmethod
    def from_dict(cls, data):
        # 辞書からクラスのインスタンスを生成
        return cls(name=data['name'], age=data['age'])
# 辞書をクラスのインスタンスに変換
person_dict = {'name': 'Taro', 'age': 20}
person = Person.from_dict(person_dict)
print(f"Name: {person.name}, Age: {person.age}")

Name: 太郎, Age: 30

この例では、Personクラスにfrom_dictというクラスメソッドを定義し、辞書からクラスのインスタンスを生成しています。

これにより、辞書形式のデータを簡単にクラスのインスタンスに変換できます。

カスタムデコーダーの作成

JSONデータを直接クラスのインスタンスにデコードするために、カスタムデコーダーを作成することができます。

以下にその方法を示します。

import json

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age
    @classmethod
    def from_dict(cls, data):
        # 辞書からクラスのインスタンスを生成
        return cls(name=data['name'], age=data['age'])
    
def decode_person(dct):
    # 辞書がPersonクラスのデータであるかを確認
    if 'name' in dct and 'age' in dct:
        return Person.from_dict(dct)
    return dct

# JSON文字列
json_string = '{"name": "太郎", "age": 30}'
# JSON文字列をクラスのインスタンスにデコード
person_custom = json.loads(json_string, object_hook=decode_person)
print(f"Name: {person_custom.name}, Age: {person_custom.age}")

Name: 太郎, Age: 30

この例では、object_hookパラメータを使用して、decode_person関数を指定しています。

この関数は、辞書がPersonクラスのデータであるかを確認し、該当する場合はPersonクラスのインスタンスを生成します。

これにより、json.loads()関数でカスタムデコーダーを指定して、JSONデータを直接クラスのインスタンスにデコードすることができます。

応用例

PythonでJSONとクラス間の変換を行う際の応用例をいくつか紹介します。

これらの例を通じて、より複雑なデータ構造や実用的なシナリオでの活用方法を学びましょう。

複雑なネスト構造の変換

複雑なネスト構造を持つJSONデータをクラスに変換する場合、各レベルのデータに対応するクラスを定義し、それらを組み合わせてインスタンスを生成します。

import json

class Address:
    def __init__(self, city, street):
        self.city = city
        self.street = street
    
    @classmethod
    def from_dict(cls, data):
        return cls(city=data['city'], street=data['street'])

class Person:
    def __init__(self, name, age, address):
        self.name = name
        self.age = age
        self.address = address
    
    @classmethod
    def from_dict(cls, data):
        # address のディクショナリを Address オブジェクトに変換
        address = Address.from_dict(data['address'])
        return cls(name=data['name'], age=data['age'], address=address)

# JSON文字列
json_string = '{"name": "太郎", "age": 30, "address": {"city": "東京", "street": "銀座"}}'

# JSON文字列を Python オブジェクトにデコード
person_dict = json.loads(json_string)

# person_dict を Person オブジェクトに変換
person = Person.from_dict(person_dict)

# Person オブジェクトの情報を出力
print(f"Name: {person.name}, Age: {person.age}, City: {person.address.city}, Street: {person.address.street}")

Name: 太郎, Age: 30, City: 東京, Street: 銀座

この例では、PersonクラスとAddressクラスを定義し、ネストされたJSONデータをそれぞれのクラスに変換しています。

データバリデーションの実装

データをクラスに変換する際に、バリデーションを実装することで、データの整合性を保つことができます。

class Person:
    def __init__(self, name, age):
        if not isinstance(name, str) or not isinstance(age, int):
            raise ValueError("Invalid data types for name or age")
        self.name = name
        self.age = age
    @classmethod
    def from_dict(cls, data):
        return cls(name=data['name'], age=data['age'])
try:
    person = Person.from_dict({"name": "太郎", "age": "三十"})
except ValueError as e:
    print(e)

Invalid data types for name or age

この例では、Personクラスのコンストラクタでデータ型のチェックを行い、無効なデータが渡された場合に例外を発生させています。

JSON Schemaを用いたクラス設計

JSON Schemaを使用することで、JSONデータの構造を定義し、それに基づいてクラスを設計することができます。

これにより、データの整合性を保証しやすくなります。

# JSON Schemaの例
json_schema = {
    "type": "object",
    "properties": {
        "name": {"type": "string"},
        "age": {"type": "integer"}
    },
    "required": ["name", "age"]
}
# JSON Schemaを用いたクラス設計の例
# 実際のバリデーションにはjsonschemaライブラリを使用することができます

JSON Schemaを用いることで、データのバリデーションやクラス設計がより明確になります。

外部APIとのデータ交換

外部APIとデータを交換する際に、JSON形式のデータをクラスに変換することで、データの操作が容易になります。

import requests
response = requests.get('https://api.example.com/person')
person_data = response.json()
person = Person.from_dict(person_data)
print(f"Name: {person.name}, Age: {person.age}")

この例では、外部APIから取得したJSONデータをPersonクラスのインスタンスに変換しています。

データベースとの連携

データベースから取得したデータをJSON形式に変換し、クラスのインスタンスとして扱うことで、データの操作が効率的になります。

import sqlite3
import json
# データベース接続とデータ取得
conn = sqlite3.connect('example.db')
cursor = conn.cursor()
cursor.execute("SELECT name, age FROM persons WHERE id = 1")
row = cursor.fetchone()
# データを辞書に変換
person_dict = {"name": row[0], "age": row[1]}
person_json = json.dumps(person_dict, ensure_ascii=False)
# JSONデータをクラスのインスタンスに変換
person = json.loads(person_json, object_hook=Person.from_dict)
print(f"Name: {person.name}, Age: {person.age}")

この例では、SQLiteデータベースから取得したデータをJSON形式に変換し、Personクラスのインスタンスとして扱っています。

これにより、データベースとの連携がスムーズになります。