データクラスとは何ですか?一般的なクラスとはどのように異なりますか?

170
kingJulian 2017-12-24 09:15.

PEP 557のデータクラスは、Pythonの標準ライブラリに導入されています。

それらは@dataclassデコレータを利用し、「デフォルトで可変の名前付きタプル」であるはずですが、これが実際に何を意味するのか、一般的なクラスとどのように異なるのか、よくわかりません。

Pythonデータクラスとは正確には何ですか?それらを使用するのに最適なのはいつですか?

4 answers

178
Martijn Pieters 2017-12-24 09:22.

データクラスは、状態の保存を目的とした通常のクラスであり、多くのロジックが含まれているだけではありません。ほとんどが属性で構成されるクラスを作成するたびに、データクラスを作成しました。

どのようなdataclassesモジュールが行うことは、それが作るで簡単にデータクラスを作成します。それはあなたのためにたくさんのボイラープレートの世話をします。

これは、データクラスがハッシュ可能でなければならない場合に特に重要です。これには、__hash__メソッドだけでなくメソッドも必要__eq__です。__repr__デバッグを容易にするためにカスタムメソッドを追加すると、非常に冗長になる可能性があります。

class InventoryItem:
    '''Class for keeping track of an item in inventory.'''
    name: str
    unit_price: float
    quantity_on_hand: int = 0

    def __init__(
            self, 
            name: str, 
            unit_price: float,
            quantity_on_hand: int = 0
        ) -> None:
        self.name = name
        self.unit_price = unit_price
        self.quantity_on_hand = quantity_on_hand

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

    def __repr__(self) -> str:
        return (
            'InventoryItem('
            f'name={self.name!r}, unit_price={self.unit_price!r}, '
            f'quantity_on_hand={self.quantity_on_hand!r})'

    def __hash__(self) -> int:
        return hash((self.name, self.unit_price, self.quantity_on_hand))

    def __eq__(self, other) -> bool:
        if not isinstance(other, InventoryItem):
            return NotImplemented
        return (
            (self.name, self.unit_price, self.quantity_on_hand) == 
            (other.name, other.unit_price, other.quantity_on_hand))

dataclassesあなたがそれを減らすことができます。

from dataclasses import dataclass

@dataclass(unsafe_hash=True)
class InventoryItem:
    '''Class for keeping track of an item in inventory.'''
    name: str
    unit_price: float
    quantity_on_hand: int = 0

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

同じクラスデコレータは__lt__、比較メソッド(__gt__、、など)を生成し、不変性を処理することもできます。

namedtupleクラスもデータクラスですが、デフォルトでは不変です(シーケンスでもあります)。dataclassesこの点ではるかに柔軟性がありタイプチェックの目的でNamedTupleをサブクラス化する方法ことができるように簡単に構造化できます。

PEPは、さらに多くのこと(スロット、バリデーター、コンバーター、メタデータなどを含む)を実行できるattrsプロジェクトに触発されました。

あなたはいくつかの例を見たい場合は、私が最近使用した、dataclasses私のいくつかのためのコードのアドベントソリューションのためのソリューションを参照してください7日目8日目11日目20日目

dataclassesPythonバージョン3.7未満でモジュールを使用する場合は、バックポートされたモジュールをインストールするか(3.6が必要)、attrs上記のプロジェクトを使用できます。

89
pylang 2018-09-12 09:38.

概要概要

質問は解決されました。ただし、この回答は、データクラスの基本的な理解に役立ついくつかの実用的な例を追加します。

Pythonデータクラスとは正確には何ですか?それらを使用するのに最適なのはいつですか?

  1. コードジェネレーター:ボイラープレートコードを生成します。通常のクラスに特別なメソッドを実装するか、データクラスにそれらを自動的に実装させるかを選択できます。
  2. データコンテナ:データ(タプルやディクテーションなど)を保持する構造。多くの場合、クラスをデータコンテナとして使用するなどの点線の属性アクセスがクラスをデータコンテナとして使用する

「デフォルトの可変名前付きタプル」

後者のフレーズの意味は次のとおりです。

  • 可変:デフォルトでは、データクラス属性を再割り当てできます。オプションで、それらを不変にすることができます(以下の例を参照)。
  • namedtuplenamedtupleまたは通常のクラスのような点線の属性アクセスがあります。
  • デフォルト:属性にデフォルト値を割り当てることができます。

一般的なクラスと比較して、主に定型コードの入力を節約できます。


特徴

これは、データクラス機能の概要です(TL; DR?次のセクションの要約表を参照)。

あなたが得るもの

データクラスからデフォルトで取得する機能は次のとおりです。

属性+表現+比較

import dataclasses


@dataclasses.dataclass
#@dataclasses.dataclass()                                       # alternative
class Color:
    r : int = 0
    g : int = 0
    b : int = 0

これらのデフォルトは、次のキーワードを自動的に設定することによって提供されますTrue

@dataclasses.dataclass(init=True, repr=True, eq=True)

あなたがオンにできるもの

適切なキーワードがに設定されている場合、追加機能を利用できますTrue

注文

@dataclasses.dataclass(order=True)
class Color:
    r : int = 0
    g : int = 0
    b : int = 0

より強力な等式テストと< > <= >=同様に、順序付けメソッドが実装されました(演算子のオーバーロードfunctools.total_ordering:)。

ハッシュ可能、可変

@dataclasses.dataclass(unsafe_hash=True)                        # override base `__hash__`
class Color:
    ...

オブジェクトは潜在的に変更可能ですが(おそらく望ましくない)、ハッシュが実装されています。

ハッシュ可能、不変

@dataclasses.dataclass(frozen=True)                             # `eq=True` (default) to be immutable 
class Color:
    ...

ハッシュが実装され、オブジェクトの変更や属性への割り当ては許可されなくなりました。

全体として、unsafe_hash=Trueまたはのいずれかである場合、オブジェクトはハッシュ可能frozen=Trueです。

詳細については、元のハッシュ論理表も参照してください。

あなたが得られないもの

次の機能を利用するには、特別なメソッドを手動で実装する必要があります。

開梱

@dataclasses.dataclass
class Color:
    r : int = 0
    g : int = 0
    b : int = 0

    def __iter__(self):
        yield from dataclasses.astuple(self)

最適化

@dataclasses.dataclass
class SlottedColor:
    __slots__ = ["r", "b", "g"]
    r : int
    g : int
    b : int

オブジェクトサイズが縮小されました:

>>> imp sys
>>> sys.getsizeof(Color)
1056
>>> sys.getsizeof(SlottedColor)
888

状況によっては、__slots__インスタンスの作成と属性へのアクセスの速度も向上します。また、スロットはデフォルトの割り当てを許可しません。それ以外の場合は、aValueErrorが発生します。

このブログ投稿のスロットの詳細を参照してください。


要約表

+----------------------+----------------------+----------------------------------------------------+-----------------------------------------+
|       Feature        |       Keyword        |                      Example                       |           Implement in a Class          |
+----------------------+----------------------+----------------------------------------------------+-----------------------------------------+
| Attributes           |  init                |  Color().r -> 0                                    |  __init__                               |
| Representation       |  repr                |  Color() -> Color(r=0, g=0, b=0)                   |  __repr__                               |
| Comparision*         |  eq                  |  Color() == Color(0, 0, 0) -> True                 |  __eq__                                 |
|                      |                      |                                                    |                                         |
| Order                |  order               |  sorted([Color(0, 50, 0), Color()]) -> ...         |  __lt__, __le__, __gt__, __ge__         |
| Hashable             |  unsafe_hash/frozen  |  {Color(), {Color()}} -> {Color(r=0, g=0, b=0)}    |  __hash__                               |
| Immutable            |  frozen + eq         |  Color().r = 10 -> TypeError                       |  __setattr__, __delattr__               |
|                      |                      |                                                    |                                         |
| Unpacking+           |  -                   |  r, g, b = Color()                                 |   __iter__                              |
| Optimization+        |  -                   |  sys.getsizeof(SlottedColor) -> 888                |  __slots__                              |
+----------------------+----------------------+----------------------------------------------------+-----------------------------------------+

+これらのメソッドは自動的に生成されず、データクラスに手動で実装する必要があります。

* __ne__は不要であるため、実装されていません


追加機能

初期化後

@dataclasses.dataclass
class RGBA:
    r : int = 0
    g : int = 0
    b : int = 0
    a : float = 1.0

    def __post_init__(self):
        self.a : int =  int(self.a * 255)


RGBA(127, 0, 255, 0.5)
# RGBA(r=127, g=0, b=255, a=127)

継承

@dataclasses.dataclass
class RGBA(Color):
    a : int = 0

変換

データクラスをタプルまたはディクテーションにPythonでネストされたデータクラスオブジェクトを作成する変換します。

>>> dataclasses.astuple(Color(128, 0, 255))
(128, 0, 255)
>>> dataclasses.asdict(Color(128, 0, 255))
{'r': 128, 'g': 0, 'b': 255}

制限事項


参考文献

  • データクラスに関するR.ヘッティンガーの講演:すべてのコードジェネレーターを終了するコードジェネレーター
  • T. Hunnerのより簡単なクラスに関する講演:すべての手がかりのないPythonクラス
  • ハッシュの詳細に関するPythonのドキュメント
  • Python3.7のデータクラスの究極ガイドに関するRealPythonのガイド
  • A. Python3.7データクラスの簡単なツアーに関するShawのブログ投稿
  • E.スミスのgithubのリポジトリ上のデータクラス
3
prosti 2019-05-24 09:12.

この単純なクラスを考えてみましょう Foo

from dataclasses import dataclass
@dataclass
class Foo:    
    def bar():
        pass  

これがdir()組み込みの比較です。左側Fooは@dataclassデコレータなし、右側は@dataclassデコレータありです。

inspect比較のためにモジュールを使用した後の別の差分を次に示します。

2
Mahmoud Hanafy 2017-12-24 09:21.

PEP仕様から:

PEP526「変数アノテーションの構文」で定義されているタイプアノテーションを持つ変数のクラス定義を検査するクラスデコレータが提供されています。このドキュメントでは、このような変数をフィールドと呼びます。これらのフィールドを使用して、デコレータは生成されたメソッド定義をクラスに追加して、インスタンスの初期化、repr、比較メソッド、およびオプションで「仕様」セクションで説明されている他のメソッドをサポートします。このようなクラスはデータクラスと呼ばれますが、クラスについて特別なことは何もありません。デコレータは生成されたメソッドをクラスに追加し、指定されたのと同じクラスを返します。

@dataclass発電機は、あなたがそれ以外のように自分自身を定義したいことをクラスにメソッドを追加して__repr____init____lt__、と__gt__

Related questions

MORE COOL STUFF

「水曜日」シーズン1の中心には大きなミステリーがあります

「水曜日」シーズン1の中心には大きなミステリーがあります

Netflixの「水曜日」は、典型的な10代のドラマ以上のものであり、実際、シーズン1にはその中心に大きなミステリーがあります.

ボディーランゲージの専門家は、州訪問中にカミラ・パーカー・ボウルズが輝くことを可能にした微妙なケイト・ミドルトンの動きを指摘しています

ボディーランゲージの専門家は、州訪問中にカミラ・パーカー・ボウルズが輝くことを可能にした微妙なケイト・ミドルトンの動きを指摘しています

ケイト・ミドルトンは、州の夕食会と州の訪問中にカミラ・パーカー・ボウルズからスポットライトを奪いたくなかった、と専門家は言う.

一部のファンがハリー・スタイルズとオリビア・ワイルドの「非常に友好的な」休憩が永続的であることを望んでいる理由

一部のファンがハリー・スタイルズとオリビア・ワイルドの「非常に友好的な」休憩が永続的であることを望んでいる理由

一部のファンが、オリビア・ワイルドが彼女とハリー・スタイルズとの間の「難しい」が「非常に友好的」な分割を恒久的にすることを望んでいる理由を見つけてください.

エリザベス女王の死後、ケイト・ミドルトンはまだ「非常に困難な時期」を過ごしている、と王室の専門家が明らかにする 

エリザベス女王の死後、ケイト・ミドルトンはまだ「非常に困難な時期」を過ごしている、と王室の専門家が明らかにする&nbsp;

エリザベス女王の死後、ケイト・ミドルトンが舞台裏で「非常に困難な時期」を過ごしていたと伝えられている理由を調べてください.

セントヘレナのジェイコブのはしごを登るのは、気弱な人向けではありません

セントヘレナのジェイコブのはしごを登るのは、気弱な人向けではありません

セント ヘレナ島のジェイコブズ ラダーは 699 段の真っ直ぐ上る階段で、頂上に到達すると証明書が発行されるほどの難易度です。

The Secrets of Airline Travel Quiz

The Secrets of Airline Travel Quiz

Air travel is far more than getting from point A to point B safely. How much do you know about the million little details that go into flying on airplanes?

Where in the World Are You? Take our GeoGuesser Quiz

Where in the World Are You? Take our GeoGuesser Quiz

The world is a huge place, yet some GeoGuessr players know locations in mere seconds. Are you one of GeoGuessr's gifted elite? Take our quiz to find out!

バイオニック読書はあなたをより速く読むことができますか?

バイオニック読書はあなたをより速く読むことができますか?

BionicReadingアプリの人気が爆発的に高まっています。しかし、それは本当にあなたを速読術にすることができますか?

パンデミックは終わったかもしれないが、Covid-19 は終わっていない

パンデミックは終わったかもしれないが、Covid-19 は終わっていない

2021 年 6 月 8 日にニューヨーク市で開催された covid-19 パンデミックで亡くなった人々の命を偲び、祝うために、ネーミング ザ ロスト メモリアルズが主催するイベントと行進の最中に、グリーンウッド墓地の正門から記念碑がぶら下がっています。週末、ジョー・バイデン大統領は、covid-19 パンデミックの終息を宣言しました。これは、過去 2 年以上にわたり、公の場でそうするための長い列の中で最新のものです。

デビル・イン・オハイオの予告編は、エミリー・デシャネルもオハイオにいることを明らかにしています

デビル・イン・オハイオの予告編は、エミリー・デシャネルもオハイオにいることを明らかにしています

オハイオ州のエミリー・デシャネル みんな早く来て、ボーンズが帰ってきた!まあ、ショーボーンズではなく、彼女を演じた俳優. エミリー・デシャネルに最後に会ってからしばらく経ちました.Emily Deschanel は、長期にわたるプロシージャルな Bones の Temperance “Bones” Brennan としてよく知られています。

ドナルド・トランプはFBIのマー・ア・ラーゴ襲撃映像をリリースする予定ですか?

ドナルド・トランプはFBIのマー・ア・ラーゴ襲撃映像をリリースする予定ですか?

どうやら、ドナルド・トランプに近い人々は、今月初めにFBIによって家宅捜索された彼のMar-a-Lago財産からの映像を公開するよう彼に勧めています. 前大統領はテープを公開するかどうかを確認していませんが、息子はフォックス・ニュースにそうなるだろうと語った.

Andor は、他の Star Wars ショーから大きな距離を置きます。

Andor は、他の Star Wars ショーから大きな距離を置きます。

アンドールの一場面。数十年前、ジョージ・ルーカスがスター・ウォーズのテレビ番組を制作するのを妨げた主な理由は、お金でした。

ケイト・ミドルトンとウィリアム王子は、彼らが子供たちと行っているスパイをテーマにした活動を共有しています

ケイト・ミドルトンとウィリアム王子は、彼らが子供たちと行っているスパイをテーマにした活動を共有しています

ケイト・ミドルトンとウィリアム王子は、子供向けのパズルの本の序文を書き、ジョージ王子、シャーロット王女、ルイ王子と一緒にテキストを読むと述べた.

事故で押しつぶされたスイカは、動物を喜ばせ水分補給するために野生生物保護団体に寄付されました

事故で押しつぶされたスイカは、動物を喜ばせ水分補給するために野生生物保護団体に寄付されました

Yak's Produce は、数十個のつぶれたメロンを野生動物のリハビリ専門家であるレスリー グリーンと彼女のルイジアナ州の救助施設で暮らす 42 匹の動物に寄付しました。

デミ・ロヴァートは、新しいミュージシャンのボーイフレンドと「幸せで健康的な関係」にあります: ソース

デミ・ロヴァートは、新しいミュージシャンのボーイフレンドと「幸せで健康的な関係」にあります: ソース

8 枚目のスタジオ アルバムのリリースに向けて準備を進めているデミ ロヴァートは、「スーパー グレート ガイ」と付き合っている、と情報筋は PEOPLE に確認しています。

Plathville の Kim と Olivia Plath が数年ぶりに言葉を交わすことへようこそ

Plathville の Kim と Olivia Plath が数年ぶりに言葉を交わすことへようこそ

イーサン プラスの誕生日のお祝いは、TLC のウェルカム トゥ プラスビルのシーズン 4 のフィナーレで、戦争中の母親のキム プラスと妻のオリビア プラスを結びつけました。

仕事の生産性を高める 8 つのシンプルなホーム オフィスのセットアップのアイデア

仕事の生産性を高める 8 つのシンプルなホーム オフィスのセットアップのアイデア

ホームオフィスのセットアップ術を極めよう!AppExert の開発者は、家族全員が一緒にいる場合でも、在宅勤務の技術を習得しています。祖父や曽祖父が共同家族で暮らしていた頃の記憶がよみがえりました。

2022 年、私たちのデジタル ライフはどこで終わり、「リアル ライフ」はどこから始まるのでしょうか?

20 年前のタイムトラベラーでさえ、日常生活におけるデジタルおよびインターネットベースのサービスの重要性に驚くことでしょう。MySpace、eBay、Napster などのプラットフォームは、高速化に焦点を合わせた世界がどのようなものになるかを示してくれました。

ニューロマーケティングの秘密科学

ニューロマーケティングの秘密科学

マーケティング担当者が人間の欲望を操作するために使用する、最先端の (気味が悪いと言う人もいます) メソッドを探ります。カートをいっぱいにして 3 桁の領収書を持って店を出る前に、ほんの数点の商品を買いに行ったことはありませんか? あなたは一人じゃない。

地理情報システムの日: GIS 開発者として学ぶべき最高の技術スタック

地理情報システムの日: GIS 開発者として学ぶべき最高の技術スタック

私たちが住んでいる世界を確実に理解するには、データが必要です。ただし、空間参照がない場合、このデータは地理的コンテキストがないと役に立たなくなる可能性があります。

Language