python dataclass

date: 2022-08-10 excerpt: python dataclassの使い方

tag: dataclass python

python dataclassの使い方

概要

scalaなどであるdataclassのpython版
namedtupleなどと異なり、mutableなデータを扱える
型情報を埋め込めるので、デバッグが容易にったり、コード品質に貢献できる
dataclassには関数を追加できる
asdictでdict型に情報を変換できる
fieldでmetadataにヘルプを記したり、デフォルト値を設定したりできる

具体例

関数を持ったデータクラス

from dataclasses import dataclass
from dataclasses import asdict

@dataclass
class Item:
    name: str
    price: float

    def total_cost(self) -> float:
        return self.unit_price * self.quantity_on_hand

item = Item(name="サラダ", price=194.2)
assert asdict(item) == {"name": "サラダ", "price": 194.2}

filedを使用する例

@dataclass
class ScriptArguments:
    model_name: Optional[str] = field(default="edbeeching/gpt-neo-125M-imdb", metadata={"help": "the model name"})
    learning_rate: Optional[float] = field(default=1.41e-5, metadata={"help": "the learning rate"})
    batch_size: Optional[int] = field(default=256, metadata={"help": "the batch size"})

参考

dataclasses/docs.python.org

dataclass python