Pythonデータクラス：モダンな構文でデータ管理を効率化

Pythonデータクラスとは、@dataclassデコレーターを持つ通常のPythonクラスです。データ保持専用に作られています。Python 3.7以降、dataclassという組み込みモジュールでデータクラスが提供されています。通常のPythonクラスに比べていくつかの利点があり、それらを本記事で探ります。サンプルコードと、データクラスでよく行う操作もいくつか紹介します。

データクラスを使う利点

なぜ通常のPythonクラスではなくデータクラスを使うべきか？ まず、Pythonデータクラスが提供するいくつかの利点を見てみましょう。

最小限のコードで済む

@dataclassデコレーターは、可視コードを一切追加せずにクラスに多くの機能を追加します。これにより、データクラスを非常にコンパクトに保ちながら、多くの便利機能を提供できます。することは、データを保持するフィールドを定義するだけ。関数を定義する必要はありません。

比較が可能

2つのPythonデータクラスは==で比較できます。いわゆるダンダーメソッド__eq__が自動実装されるためです。一般に、この特殊メソッドを実装するあらゆるPythonオブジェクトを、同タイプの他オブジェクトと比較できます。

データクラスの出力

同様に、__repr__が実装されているため、データクラスをprintすると整形された表現が得られます。これはデバッグ時に特に有用です。

データクラスには型ヒントが必要

データクラスはPythonが提供する（比較的新しい）型システムを基盤としています。型ヒントを使うことで、コードのバグと予期せぬ動作の可能性を減らせます。変数に格納すべきデータの型を本質的に宣言することになります。

データクラス例

データクラスの動作例：

from dataclasses import dataclass

@dataclass
class Card:
    rank: str
    suit: str

card1 = Card("Q", "hearts")
card2 = Card("Q", "hearts")
print(card1 == card2)  # True
print(card1.rank)      # 'Q'
print(card1)           # Card(rank='Q', suit='hearts')

デフォルト値

データクラスはデフォルト値を持てます。デフォルト値の割り当ては、変数に値を代入するのと同じくらい簡単です。例えば、CardクラスのデフォルトをハートのQにしたい場合：

from dataclasses import dataclass

@dataclass
class Card:
    rank: str = 'Q'
    suit: str = 'hearts'

データクラスをJSONに変換

よくあるユースケースは、きれいに構造化されたデータクラスをJSONに変換することです。例えば、データをデータベースにエクスポートしたり、ブラウザに送信したりする場合。悪いニュース：データクラスをJSONに変換する組み込み方法はありません。

良いニュース：dataclasses-jsonというPythonパッケージがこのタスクを簡素化します。ただし、追加のデコレーターが必要です。pip installコマンドやPipenv等でパッケージをインストールする必要があります。仮想環境内で行うのが望ましいです。例：

$ pip install dataclasses-json

使い方例：

from dataclasses import dataclass
from dataclasses_json import dataclass_json

@dataclass_json
@dataclass
class Card:
    rank: str = 'Q'
    suit: str = 'hearts'

card = Card()
print(card.to_json())

{"rank": "Q", "suit": "hearts"}

もう一つの方法は、Pythonの継承を使ってJSONEncoderクラスを継承し、独自のカスタムエンコーダーを作ることです。こちらの利点は外部パッケージが不要な点です。やり方はこのブログ記事で学べます。

学びを続ける

• Python attrsパッケージは、ネイティブPythonデータクラスの高機能版
• Python.org公式ドキュメント
• Pythonで複数値を返す方法