.NET開発者のためのブログメディア

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

PM: 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

# クラス定義

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

<__main__.Human object at 0x14d72b58cfd0>

taro

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

import dataclasses

# DTOクラス定義

@dataclasses.dataclass

class Human:

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

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

taro

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())

import dataclasses

# DTOクラス定義

@dataclasses.dataclass

class Human:

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

taro

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

import dataclasses

# DTOクラス定義

@dataclasses.dataclass

class Human1:

age: int

# DTOクラス定義

@dataclasses.dataclass

class Human2:

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)

import dataclasses

# DTOクラス定義（イミュータブル）

@dataclasses.dataclass(frozen=True)

class Human:

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'

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}

import dataclasses

import json

# DTOクラス定義

@dataclasses.dataclass

class Human:

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}

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)

import dataclasses

# DTOクラス定義

@dataclasses.dataclass

class Human:

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)

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

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

まとめ

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

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

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

.NET分野でのキャリアアップをお考えの方は、現在募集中の求人情報をご覧ください。

また、直接のエントリーも受け付けております。

エントリー（応募フォーム）

Search キーワード検索

Popular 人気の記事

reccomended おすすめ記事

C#のusingステートメントでリソースの解放【Disposeとの違いとは】

2020年03月17日
【SQL Serverログの操作】トランザクションログの使用量を確認する方法

2020年03月16日
【.NETが統合】.NET 5の概要と今後のリリース予定

2020年03月05日

Categories 連載一覧

生活・便利

教育・学習

Windows

言語・環境

転職

エンジニア

働き方

プログラミング言語

開発環境

ツール

未分類

.NET開発者のためのブログメディア

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

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

基本的な使い方

関数

比較対象から除外する

イミュータブル

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

まとめ

Search キーワード検索

Popular 人気の記事

reccomended おすすめ記事

C#のusingステートメントでリソースの解放【Disposeとの違いとは】

【SQL Serverログの操作】トランザクションログの使用量を確認する方法

【.NETが統合】.NET 5の概要と今後のリリース予定

Categories 連載一覧

Tags タグ一覧

Jobs 新着案件

開発エンジニア/東京都品川区/【WEB面談可】/在宅ワーク

遠隔テストサービス機能改修/JavaScript/東京都港区/【WEB面談可】/テレワーク

病院内システムの不具合対応、保守/東京都豊島区/【WEB面談可】/テレワーク

ソフトを用いた3DCGアート/東京都千代田区/【WEB面談可】/テレワーク

開発/JavaScript/東京都豊島区/【WEB面談可】/テレワーク