Python メモ – データクラス

単にデータを格納するだけのクラスを作成していて、毎回、__init__()を書くのを面倒に感じていたが、Python 3.7からは@dataclassを使うと簡単にできることがわかったのでメモ。

従来の方法

普通にクラスを作るとこんな感じになる。

# person.py
class Person:
    def __init__(self, first_name, last_name):
        self.first_name = first_name
        self.last_name = last_name

    def full_name(self):
        return self.first_name + ' ' + self.last_name

実行するとこうなる。

# person.py
>>> from person import Person
>>> p = Person('Taro', 'Yamada')
>>> p.last_name
'Yamada'
>>> p.full_name()
'Taro Yamada'

データクラスを使う方法

@dataclassを使うと、クラスの前にデコレータ@dataclassをつけて、型を指定して変数を列挙すると、__init__()に書いたのと同じになるので簡単。

from dataclasses import dataclass

@dataclass
class Person: 
    first_name: str
    last_name: str

    @property
    def full_name(self) -> str:
        return self.first_name + ' ' + self.last_name

各変数へのアクセス方法は同じ。また、full_nameにはデコレータ@propertyを使ってみた。@propertyをメソッドにつけると、他の変数と同じようにアクセスできる。ちなみに、@propertyはデータクラスの機能ではない。そのため、データクラスとは関係なく単独でも利用できるようだ。

>>> from person import Person
>>> p = Person('Taro', 'Yamada')
>>> p.last_name
'Yamada'
>>> p.full_name
'Taro Yamada'

参考情報

https://docs.python.org/3/library/dataclasses.html
https://docs.python.org/3/library/functions.html?highlight=property#property

2019-11-17

/2019/11/17/python-memo-dataclass/ にくたま雑記帳

#python