dataclass語(yǔ)法

一、 簡(jiǎn)介

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

dataclass的定義位于PEP-557，根據(jù)定義一個(gè)dataclass是指“一個(gè)帶有默認(rèn)值的可變的namedtuple”，廣義的定義就是有一個(gè)類(lèi)，它的屬性均可公開(kāi)訪問(wèn)，可以帶有默認(rèn)值并能被修改，而且類(lèi)中含有與這些屬性相關(guān)的類(lèi)方法，那么這個(gè)類(lèi)就可以稱(chēng)為dataclass，再通俗點(diǎn)講，dataclass就是一個(gè)含有數(shù)據(jù)及操作數(shù)據(jù)方法的容器。

乍一看可能會(huì)覺(jué)得這個(gè)概念不就是普通的class么，然而還是有幾處不同：

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

我們來(lái)創(chuàng)建一個(gè)實(shí)例：

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

同時(shí)，我們也可以添加__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

同時(shí)使用dataclass也有一些好處，它比namedtuple更靈活。同時(shí)因?yàn)樗且粋€(gè)常規(guī)的類(lèi)，所以你可以享受繼承帶來(lái)的便利。

二、 裝飾器參數(shù)

參數(shù)為dataclass()：

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

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

三、 數(shù)據(jù)屬性

1、 參數(shù)

參數(shù)為field()：

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

2、 使用示例

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

3、 注意事項(xiàng)

init參數(shù)如果設(shè)置為False，表示不為這個(gè)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__后被調(diào)用，我們可以在這里初始化那些需要前置條件的field。

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

如果指定一個(gè)field的類(lèi)型注解為dataclasses.InitVar，那么這個(gè)field將只會(huì)在初始化過(guò)程中（__init__和__post_init__）可以被使用，當(dāng)初始化完成后訪問(wèn)該field會(huì)返回一個(gè)dataclasses.Field對(duì)象而不是field原本的值，也就是該field不再是一個(gè)可訪問(wèn)的數(shù)據(jù)對(duì)象。舉個(gè)例子，比如一個(gè)由數(shù)據(jù)庫(kù)對(duì)象，它只需要在初始化的過(guò)程中被訪問(wèn)：

@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、 常用函數(shù)

dataclasses模塊中提供了一些常用函數(shù)供我們處理數(shù)據(jù)類(lèi)。

使用dataclasses.asdict和dataclasses.astuple我們可以把數(shù)據(jù)類(lèi)實(shí)例中的數(shù)據(jù)轉(zhuǎn)換成字典或者元組：

>>> 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可以判斷一個(gè)類(lèi)或?qū)嵗龑?duì)象是否是數(shù)據(jù)類(lèi)

2、 繼承

dataclass裝飾器會(huì)檢查當(dāng)前class的所有基類(lèi)，如果發(fā)現(xiàn)一個(gè)dataclass，就會(huì)把它的字段按順序添加進(jìn)當(dāng)前的class，隨后再處理當(dāng)前class的field。所有生成的方法也將按照這一過(guò)程處理，因此如果子類(lèi)中的field與基類(lèi)同名，那么子類(lèi)將會(huì)無(wú)條件覆蓋基類(lèi)。子類(lèi)將會(huì)根據(jù)所有的field重新生成一個(gè)構(gòu)造函數(shù)，并在其中初始化基類(lèi)。

看個(gè)例子：

@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、 總結(jié)

合理使用dataclass將會(huì)大大減輕開(kāi)發(fā)中的負(fù)擔(dān)，將我們從大量的重復(fù)勞動(dòng)中解放出來(lái)，這既是dataclass的魅力，不過(guò)魅力的背后也總是有陷阱相伴，最后我想提幾點(diǎn)注意事項(xiàng)：

• dataclass通常情況下是unhashable的，因?yàn)槟J(rèn)生成的__hash__是None，所以不能用來(lái)做字典的key，如果有這種需求，那么應(yīng)該指定你的數(shù)據(jù)類(lèi)為frozen dataclass
• 小心當(dāng)你定義了和dataclass生成的同名方法時(shí)會(huì)引發(fā)的問(wèn)題
• 當(dāng)使用可變類(lèi)型（如list）時(shí)，應(yīng)該考慮使用field的default_factory
• 數(shù)據(jù)類(lèi)的屬性都是公開(kāi)的，如果你有屬性只需要初始化時(shí)使用而不需要在其他時(shí)候被訪問(wèn)，請(qǐng)使用dataclasses.InitVar

只要避開(kāi)這些陷阱，dataclass一定能成為提高生產(chǎn)力的利器。