dataclass語法

一、 簡介

官方文檔的地址為：https://docs.python.org/3.9/library/dataclasses.html

dataclass的定義位于PEP-557，根據定義一個dataclass是指“一個帶有默認值的可變的namedtuple”，廣義的定義就是有一個類，它的屬性均可公開訪問，可以帶有默認值并能被修改，而且類中含有與這些屬性相關的類方法，那么這個類就可以稱為dataclass，再通俗點講，dataclass就是一個含有數據及操作數據方法的容器。

乍一看可能會覺得這個概念不就是普通的class么，然而還是有幾處不同：

• 相比普通class，dataclass通常不包含私有屬性，數據可以直接訪問
• dataclass的repr方法通常有固定格式，會打印出類型名以及屬性名和它的值
• dataclass擁有__eq__和__hash__魔法方法
• dataclass有著模式單一固定的構造方式，或是需要重載運算符，而普通class通常無需這些工作

我們來創建一個實例：

from dataclasses import dataclass
@dataclass
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

同時，我們也可以添加__init__方法：

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

同時使用dataclass也有一些好處，它比namedtuple更靈活。同時因為它是一個常規的類，所以你可以享受繼承帶來的便利。

二、 裝飾器參數

參數為dataclass()：

• init：如果為true（默認），__init__()將生成一個方法。
• 如果類已經定義__init__()，則忽略此參數。
• repr：如果為true（默認），__repr__()將生成一個方法。生成的 repr 字符串將具有類名以及每個字段的名稱和 repr，按照它們在類中定義的順序。不包括標記為從 repr 中排除的字段。例如： 。InventoryItem(name='widget', unit_price=3.0, quantity_on_hand=10)
• 如果類已經定義__repr__()，則忽略此參數。
• eq：如果為true（默認），__eq__()將生成一個方法。此方法按順序比較類，就好像它是其字段的元組一樣。比較中的兩個實例必須是相同的類型。
• 如果類已經定義__eq__()，則忽略此參數。
• order: 如果為真（默認為False），將生成__lt__()、 __le__()、__gt__()和方法。__ge__()這些按順序比較類，就好像它是其字段的元組一樣。比較中的兩個實例必須是相同的類型。如果order為真且eq為假， ValueError則引發 a。
• 如果該類已經定義了__lt__()、 __le__()、__gt__()或中的任何一個，__ge__()則 TypeError引發。
• unsafe_hash：if False（默認），__hash__()根據how eqand frozenare set生成一個方法。
• __hash__()由 built-in 使用hash()，并且在將對象添加到散列集合（例如字典和集合）時使用。擁有 a __hash__()意味著類的實例是不可變的。可變性是一個復雜的屬性，它取決于程序員的意圖、 的存在和行為，以及裝飾器中的和標志__eq__()的值。eq``frozendataclass()
• 默認情況下， 除非這樣做是安全的，否則dataclass()不會隱式添加方法。__hash__()它也不會添加或更改現有的明確定義的__hash__()方法。如文檔中所述，設置類屬性對 Python 具有特定含義。__hash__ = None__hash__()
• 如果__hash__()沒有顯式定義，或者如果設置為None，則可以添加隱式方法。雖然不推薦，但您可以強制使用 . 如果您的類在邏輯上是不可變的，但仍然可以發生變異，則可能會出現這種情況。這是一個專門的用例，應該仔細考慮。dataclass() __hash__()dataclass()__hash__()unsafe_hash=True
• 以下是管理方法隱式創建的規則__hash__() 。請注意，您不能__hash__() 在數據類和 set 中都有顯式方法unsafe_hash=True；這將導致一個TypeError.
• 如果eq和frozen都為真，默認情況下dataclass()會為你生成一個__hash__()方法。如果eq為真且 frozen為假，__hash__()將設置為None，將其標記為不可散列（它是，因為它是可變的）。如果eq為假， __hash__()將保持不變，這意味著__hash__() 將使用超類的方法（如果超類是 object，這意味著它將回退到基于 id 的散列）。
• frozen：如果為真（默認為False），分配給字段將產生異常。這模擬只讀凍結實例。如果 __setattr__()或__delattr__()在類中定義，則 TypeError引發。

@dataclass
class C:
    ...
@dataclass()
class C:
    ...
@dataclass(init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False)
class C:
   ...

三、 數據屬性

1、 參數

參數為field()：

• default：如果提供，這將是該字段的默認值。這是必需的，因為field()調用本身會替換默認值的正常位置。
• default_factory：如果提供，它必須是一個零參數的可調用對象，當該字段需要默認值時將被調用。除其他目的外，這可用于指定具有可變默認值的字段，如下所述。default同時指定和是錯誤的default_factory。
• init：如果為 true（默認值），則此字段作為參數包含在生成的__init__()方法中。
• repr：如果為true（默認），則該字段包含在生成的__repr__()方法返回的字符串中。
• compare: 如果為 true（默認值），則該字段包含在生成的相等和比較方法中（__eq__()、、 __gt__()等）。
• hash: 這可以是 bool 或None. 如果為 true，則此字段包含在生成的__hash__()方法中。如果None（默認），使用compare: 這通常是預期的行為。如果某個字段用于比較，則應在哈希中考慮該字段。None不鼓勵將此值設置為除此之外的任何值。
• hash=False設置的一個可能原因compare=True 是，如果一個字段計算哈希值的成本很高，則需要該字段進行相等性測試，并且還有其他字段有助于該類型的哈希值。即使某個字段從哈希中排除，它仍將用于比較。
• metadata：這可以是映射或無。None 被視為空字典。這個值被包裝 MappingProxyType()成只讀的，并暴露在Field對象上。數據類根本不使用它，而是作為第三方擴展機制提供的。多個第三方可以各自擁有自己的密鑰，用作元數據中的命名空間。

2、 使用示例

@dataclass
class C:
    x: int
    y: int = field(repr=False)
    z: int = field(repr=False, default=10)
    t: int = 20

3、 注意事項

init參數如果設置為False，表示不為這個field生成初始化操作，dataclass提供了hook——__post_init__供我們利用這一特性：

@dataclass
class C:
    a: int
    b: int
    c: int = field(init=False)
 
    def __post_init__(self):
        self.c = self.a + self.b

__post_init__在__init__后被調用，我們可以在這里初始化那些需要前置條件的field。

repr參數表示該field是否被包含進repr的輸出，compare和hash參數表示field是否參與比較和計算hash值。metadata不被dataclass自身使用，通常讓第三方組件從中獲取某些元信息時才使用，所以我們不需要使用這一參數。

如果指定一個field的類型注解為dataclasses.InitVar，那么這個field將只會在初始化過程中（__init__和__post_init__）可以被使用，當初始化完成后訪問該field會返回一個dataclasses.Field對象而不是field原本的值，也就是該field不再是一個可訪問的數據對象。舉個例子，比如一個由數據庫對象，它只需要在初始化的過程中被訪問：

@dataclass
class C:
    i: int
    j: int = None
    database: InitVar[DatabaseType] = None
 
    def __post_init__(self, database):
        if self.j is None and database is not None:
            self.j = database.lookup('j')
c = C(10, database=my_database)

四、 其他

1、 常用函數

dataclasses模塊中提供了一些常用函數供我們處理數據類。

使用dataclasses.asdict和dataclasses.astuple我們可以把數據類實例中的數據轉換成字典或者元組：

>>> from dataclasses import asdict, astuple
>>> asdict(C())
{'name': 'python', 'strong_type': True, 'static_type': False, 'age': 28}
>>> astuple(C())
('python', True, False, 28)

使用dataclasses.is_dataclass可以判斷一個類或實例對象是否是數據類

2、 繼承

dataclass裝飾器會檢查當前class的所有基類，如果發現一個dataclass，就會把它的字段按順序添加進當前的class，隨后再處理當前class的field。所有生成的方法也將按照這一過程處理，因此如果子類中的field與基類同名，那么子類將會無條件覆蓋基類。子類將會根據所有的field重新生成一個構造函數，并在其中初始化基類。

看個例子：

@dataclass
class Base:
    x: float = 25.0
    y: int = 0
 
@dataclass
class C(Base):
    z: int = 10
    x: int = 15
 
>>> C()
C(x=15, y=0, z=10)

C中的x則覆蓋了Base中的定義

3、 總結

合理使用dataclass將會大大減輕開發中的負擔，將我們從大量的重復勞動中解放出來，這既是dataclass的魅力，不過魅力的背后也總是有陷阱相伴，最后我想提幾點注意事項：

• dataclass通常情況下是unhashable的，因為默認生成的__hash__是None，所以不能用來做字典的key，如果有這種需求，那么應該指定你的數據類為frozen dataclass
• 小心當你定義了和dataclass生成的同名方法時會引發的問題
• 當使用可變類型（如list）時，應該考慮使用field的default_factory
• 數據類的屬性都是公開的，如果你有屬性只需要初始化時使用而不需要在其他時候被訪問，請使用dataclasses.InitVar

只要避開這些陷阱，dataclass一定能成為提高生產力的利器。