PythonでのDTOクラスとは？基本的な使い方や辞書形式やタプル形式に変換する方法を紹介します！

この記事でわかること

システム
エンジニア

Pythonのdataclassアノテーションは何ができるのですか。

プロジェクト
マネージャー

dataclassを使用することで、データを格納するためのDTOクラスであることを明確にできます。また、クラス定義をシンプルに書けます。

PythonでのDTOクラスの使い方とは？

今回は、Pythonでのdataclassアノテーションを使ったDTOクラスの使い方を説明します。

DTO（Data Transfer Object）とは、オブジェクト指向プログラミングのデザインパターンの1つで、データを1つにまとめたオブジェクトです。

Python3.7から、dataclassアノテーションが使えるようなり、DTOクラスを作成できるようになりました。

dataclassを使用することで、データを格納するためのクラスであることを明確にできます。また、クラス定義をシンプルに書けるようになりました。

Pythonでのdataclassアノテーションを使ったDTOクラスの使い方に興味のある方はぜひご覧ください。

基本的な使い方

dataclass登場する前は、データを格納するクラスを作成するには以下のように記述します。

# クラス定義 class Human: # コンストラクタ def __init__(self, name=““, age=0): self.name = name self.age = age # オブジェクト生成 human = Human('taro', 20) # オブジェクトを表示 print(human) # <__main__.Human object at 0x14d72b58cfd0> print(human.name) # taro print(human.age) # 20

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

# クラス定義 class Human:       # コンストラクタ     def __init__(self, name=““, age=0):         self.name = name         self.age = age   # オブジェクト生成 human = Human('taro', 20)   # オブジェクトを表示 print(human) # <__main__.Human object at 0x14d72b58cfd0> print(human.name) # taro print(human.age) # 20

実行結果は以下のようになります。

<__main__.Human object at 0x14d72b58cfd0> taro 20

1 2 3

<__main__.Human object at 0x14d72b58cfd0> taro 20

dataclassを使うと、以下のように簡単にDTOクラスを作成できます。実際のソースコードを見てみましょう。

import dataclasses # DTOクラス定義 @dataclasses.dataclass class Human: name: str age: int # オブジェクト生成 human = Human('taro', 20) # オブジェクトを表示 print(human) # Human(name='taro', age=20) print(human.name) # taro print(human.age) # 20

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

import dataclasses   # DTOクラス定義 @dataclasses.dataclass class Human:     name: str     age: int   # オブジェクト生成 human = Human('taro', 20)   # オブジェクトを表示 print(human) # Human(name='taro', age=20) print(human.name) # taro print(human.age) # 20

実行結果は以下のようになります。

Human(name='taro', age=20) taro 20

1 2 3

Human(name='taro', age=20) taro 20

dataclassのクラスオブジェクトをprintすると、オブジェクトの中身を表示できます。

関数

dataclassで関数を定義する方法を紹介します。実際のソースコードを見てみましょう。

import dataclasses # DTOクラス定義 @dataclasses.dataclass class Human: name: str age: int # 関数 def printinfo(self): return f'name:{self.name}, age:{self.age}' # オブジェクト生成 human = Human('taro', 20) print(human.name) print(human.age) print(human.printinfo())

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

import dataclasses   # DTOクラス定義 @dataclasses.dataclass class Human:     name: str     age: int       # 関数     def printinfo(self):         return f'name:{self.name}, age:{self.age}'   # オブジェクト生成 human = Human('taro', 20) print(human.name) print(human.age) print(human.printinfo())

実行結果は以下のようになります。通常のクラスと同じように、関数を定義できます。

taro 20 name:taro, age:20

1 2 3

taro 20 name:taro, age:20

比較対象から除外する

dataclassはオブジェクトの比較ができます。特定のフィールドを比較対象から除外する方法を紹介します。実際のソースコードを見てみましょう。

import dataclasses # DTOクラス定義 @dataclasses.dataclass class Human1: name: str age: int # DTOクラス定義 @dataclasses.dataclass class Human2: name: str age: int = dataclasses.field(compare=False) # 比較対象から除外 # オブジェクト生成 human1 = Human1('taro', 20) human2 = Human1('taro', 30) print(human1 == human2) # False # オブジェクト生成 human3 = Human2('taro', 20) human4 = Human2('taro', 30) print(human3 == human4) # True

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

import dataclasses   # DTOクラス定義 @dataclasses.dataclass class Human1:     name: str     age: int   # DTOクラス定義 @dataclasses.dataclass class Human2:     name: str     age: int = dataclasses.field(compare=False) # 比較対象から除外   # オブジェクト生成 human1 = Human1('taro', 20) human2 = Human1('taro', 30) print(human1 == human2) # False   # オブジェクト生成 human3 = Human2('taro', 20) human4 = Human2('taro', 30) print(human3 == human4) # True

実行結果は以下のようになります。「compare=False」を付与することで、特定のフィールドを比較対象から除外できます。

False True

1 2	False True

イミュータブル

オブジェクトをイミュータブル（変更不可）にする方法を紹介します。「frozen=True」を付与します。実際のソースコードを見てみましょう。

import dataclasses # DTOクラス定義（イミュータブル） @dataclasses.dataclass(frozen=True) class Human: name: str age: int human = Human('taro', 20) human.age = 30 # FrozenInstanceError print(human)

1 2 3 4 5 6 7 8 9 10 11

import dataclasses   # DTOクラス定義（イミュータブル） @dataclasses.dataclass(frozen=True) class Human:     name: str     age: int   human = Human('taro', 20) human.age = 30 # FrozenInstanceError print(human)

実行結果は以下のようになります。変更しようとすると、FrozenInstanceErrorが発生します。

Traceback (most recent call last): File “Main.py”, line 10, in <module> human.age = 30 # FrozenInstanceError File “<string>“, line 4, in __setattr__ dataclasses.FrozenInstanceError: cannot assign to field 'age'

1 2 3 4 5

Traceback (most recent call last):   File “Main.py”, line 10, in <module>     human.age = 30 # FrozenInstanceError   File “<string>“, line 4, in __setattr__ dataclasses.FrozenInstanceError: cannot assign to field 'age'

辞書形式やタプル形式に変換

オブジェクトを辞書形式やタプル形式に変換する方法を紹介します。実際のソースコードを見てみましょう。

import dataclasses import json # DTOクラス定義 @dataclasses.dataclass class Human: name: str age: int # オブジェクト生成 human = Human('taro', 20) # オブジェクト表示 print(human) # Human(name='taro', age=20) # 辞書形式に変換 print(dataclasses.asdict(human)) #{'name': 'taro', 'age': 20} # タプル形式に変換 print(dataclasses.astuple(human)) # ('taro', 20) # json形式に変換 print(json.dumps(dataclasses.asdict(human))) # {“name”: “taro”, “age”: 20}

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

import dataclasses import json   # DTOクラス定義 @dataclasses.dataclass class Human:     name: str     age: int   # オブジェクト生成 human = Human('taro', 20)   # オブジェクト表示 print(human) # Human(name='taro', age=20) # 辞書形式に変換 print(dataclasses.asdict(human)) #{'name': 'taro', 'age': 20} # タプル形式に変換 print(dataclasses.astuple(human)) # ('taro', 20) # json形式に変換 print(json.dumps(dataclasses.asdict(human))) # {“name”: “taro”, “age”: 20}

実行結果は以下のようになります。

Human(name='taro', age=20) {'name': 'taro', 'age': 20} ('taro', 20) {“name”: “taro”, “age”: 20}

1 2 3 4

Human(name='taro', age=20) {'name': 'taro', 'age': 20} ('taro', 20) {“name”: “taro”, “age”: 20}

辞書形式からオブジェクトを生成することもできます。実際のソースコードを見てみましょう。

import dataclasses # DTOクラス定義 @dataclasses.dataclass class Human: name: str age: int # 辞書定義 mydict = { “name”: “taro”, “age”: 20, } # 辞書からオブジェクト生成 human = Human(**mydict) print(human) # Human(name='taro', age=20)

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

import dataclasses   # DTOクラス定義 @dataclasses.dataclass class Human:     name: str     age: int   # 辞書定義 mydict = {     “name”: “taro”,     “age”: 20, }   # 辞書からオブジェクト生成 human = Human(**mydict) print(human) # Human(name='taro', age=20)

実行結果は以下のようになります。

Human(name='taro', age=20)

1	Human(name='taro', age=20)

システム
エンジニア

dataclassを使用するとデータを格納するためのDTOクラスであることを明確にできたり、クラス定義をシンプルに書けたりするのはいいですね。

プロジェクト
マネージャー

そうですね。ご紹介したソースコードを参考にご自身でもソースコードを書いてみてください。

まとめ

いかがでしたでしょうか。Python3.7から、dataclassアノテーションが使えるようになり、DTOクラスを作成できるようになりました。

dataclassを使用することで、データを格納するためのクラスであることを明確にできます。また、クラス定義をシンプルに書けるようになりました。

ぜひご自身でソースコードを書いて、理解を深めてください。

FEnet.NETナビ・.NETコラムは株式会社オープンアップシステムが運営しています。

株式会社オープンアップシステムはこんな会社です

秋葉原オフィスには株式会社オープンアップシステムをはじめグループのIT企業が集結！
数多くのエンジニアが集まります。

• スマホアプリから業務系システムまで

  

  スマホアプリから業務系システムまで開発案件多数。システムエンジニア・プログラマーとしての多彩なキャリアパスがあります。

• 充実した研修制度

  

  毎年、IT技術のトレンドや社員の要望に合わせて、カリキュラムを刷新し展開しています。社内講師の丁寧なサポートを受けながら、自分のペースで学ぶことができます。

• 資格取得を応援

  

  スキルアップしたい社員を応援するために資格取得一時金制度を設けています。受験料(実費)と合わせて資格レベルに合わせた最大10万円の一時金も支給しています。

• 東証プライム上場企業グループ

  

  オープンアップシステムは東証プライム上場「株式会社夢真ビーネックスグループ」のグループ企業です。

  安定した経営基盤とグループ間のスムーズな連携でコロナ禍でも安定した雇用を実現させています。

株式会社オープンアップシステムに興味を持った方へ

株式会社オープンアップシステムでは、開発系エンジニア・プログラマを募集しています。

年収をアップしたい！スキルアップしたい！大手の上流案件にチャレンジしたい！
まずは話だけでも聞いてみたい場合もOK。お気軽にご登録ください。

Python新着案件New Job

• マルチロガーソフト開発/東京都豊島区/【WEB面談可/C#経験者/20代後半～40代の方活躍中/経験年数不問】/在宅勤務

  月給41万～50万円
  東京都豊島区(池袋駅)
  • Python
  • C＃
  • C

• マルチロガーソフト開発/東京都豊島区/【WEB面談可/C#経験者/20代前半の方活躍中/経験1年以上の方活躍中】/在宅勤務

  月給29万～34万円
  東京都豊島区(池袋駅)
  • Python
  • C＃
  • C

• 商品化予定の振動センサーの運用保守/Python/東京都都内/【WEB面談可】

  月給50万～60万円
  東京都都内(-駅)
  • Python

• 商品化予定の振動センサーの可視化UI開発のテスター/Python/東京都都内/【WEB面談可】

  月給25万～35万円
  東京都都内(-駅)
  • Python

• 商品化予定の振動センサーの運用保守/Python/東京都都内/【WEB面談可】

  月給50万～60万円
  東京都都内(-駅)
  • Python

• 商品化予定の振動センサーの可視化UI開発のテスター/Python/東京都都内/【WEB面談可】

  月給25万～35万円
  東京都都内(-駅)
  • Python