作者：@apocelipes

本文將帶你走進(jìn)python3.7的新特性dataclass，通過(guò)本文你將學(xué)會(huì)dataclass的使用并避免踏入某些陷阱,。

• dataclass簡(jiǎn)介

• dataclass的使用

• 定義一個(gè)dataclass

• 深入dataclass裝飾器

• 數(shù)據(jù)類的基石——dataclasses.field

• 一些常用函數(shù)

• dataclass繼承

• 總結(jié)

dataclass簡(jiǎn)介

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

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

1. 相比普通class,，dataclass通常不包含私有屬性，數(shù)據(jù)可以直接訪問(wèn)

2. dataclass的repr方法通常有固定格式,，會(huì)打印出類型名以及屬性名和它的值

3. dataclass擁有__eq__和__hash__魔法方法

4. dataclass有著模式單一固定的構(gòu)造方式,，或是需要重載運(yùn)算符，而普通class通常無(wú)需這些工作

基于上述原因,，通常自己實(shí)現(xiàn)一個(gè)dataclass是繁瑣而無(wú)聊的,，而dataclass單一固定的行為正適合程序?yàn)槲覀冏詣?dòng)生成，于是dataclasses模塊誕生了,。

配合類型注解語(yǔ)法,，我們可以輕松生成一個(gè)實(shí)現(xiàn)了__init__，__repr__,，__cmp__等方法的dataclass：

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

dataclass的使用

我們分x步介紹dataclass的使用，首先是如何定義一個(gè)dataclass,。

定義一個(gè)dataclass

dataclasses模塊提供了一個(gè)裝飾器幫助我們定義自己的數(shù)據(jù)類：

@dataclass
class Lang:
    """a dataclass that describes a programming language"""
    name: str = 'python'
    strong_type: bool = True
    static_type: bool = False
    age: int = 28

我們定義了一個(gè)描述某種程序語(yǔ)言特性的數(shù)據(jù)類——Lang,，在接下來(lái)的例子中我們都會(huì)用到這個(gè)類。

在數(shù)據(jù)類被定義后,，會(huì)根據(jù)給出的類型注解生成一個(gè)如下的初始函數(shù)：

def __init__(self, name: str='python',
            strong_type: bool=True,
            static_type: bool=False,
            age: int=28):
    self.name = name
    self.strong_type = strong_type
    self.static_type = static_type
    self.age = age

可以看到初始化操作都已經(jīng)自動(dòng)生成了，讓我們?cè)囉靡幌拢?/p>

>>> Lang()
Lang(name='python', strong_type=True, static_type=False, age=28)
>>> Lang('js', False, False, 23)
Lang(name='js', strong_type=False, static_type=False, age=23)
>>> Lang('js', False, False, 23) == Lang()
False
>>> Lang('python', True, False, 28) == Lang()
True

例子中可以看出__repr__和__eq__方法也已經(jīng)為我們生成了,，如果沒有其他特殊要求的話這個(gè)dataclass已經(jīng)具備了投入生產(chǎn)環(huán)境的能力,，是不是很神奇？

深入dataclass裝飾器

dataclass的魔力源泉都在dataclass這個(gè)裝飾器中,，如果想要完全掌控dataclass的話那么它是你必須了解的內(nèi)容,。

裝飾器的原型如下：

dataclasses.dataclass(*, init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False)

dataclass裝飾器將根據(jù)類屬性生成數(shù)據(jù)類和數(shù)據(jù)類需要的方法。

我們的關(guān)注點(diǎn)集中在它的kwargs上：

有默認(rèn)值的屬性必須定義在沒有默認(rèn)值的屬性之后，和對(duì)kw參數(shù)的要求一樣,。

上面我們偶爾提到了field的概念,，我們所說(shuō)的數(shù)據(jù)類屬性，數(shù)據(jù)屬性實(shí)際上都是被field的對(duì)象,，它代表著一個(gè)數(shù)據(jù)的實(shí)體和它的元信息,，下面我們了解一下dataclasses.field。

數(shù)據(jù)類的基石——dataclasses.field

先看下field的原型：

dataclasses.field(*, default=MISSING, default_factory=MISSING, repr=True, hash=None, init=True, compare=True, metadata=None)

通常我們無(wú)需直接使用,，裝飾器會(huì)根據(jù)我們給出的類型注解自動(dòng)生成field,，但有時(shí)候我們也需要定制這一過(guò)程，這時(shí)dataclasses.field就顯得格外有用了,。

default和default_factory參數(shù)將會(huì)影響默認(rèn)值的產(chǎn)生,，它們的默認(rèn)值都是None，意思是調(diào)用時(shí)如果為指定則產(chǎn)生一個(gè)為None的值。其中default是field的默認(rèn)值,，而default_factory控制如何產(chǎn)生值,，它接收一個(gè)無(wú)參數(shù)或者全是默認(rèn)參數(shù)的callable對(duì)象，然后用調(diào)用這個(gè)對(duì)象獲得field的初始值,，之后再將default（如果值不是MISSING）復(fù)制給callable返回的這個(gè)對(duì)象,。

舉個(gè)例子，對(duì)于list,，當(dāng)復(fù)制它時(shí)只是復(fù)制了一份引用,，所以像dataclass里那樣直接復(fù)制給實(shí)例的做法的危險(xiǎn)而錯(cuò)誤的，為了保證使用list時(shí)的安全性,，應(yīng)該這樣做：

@dataclass
class C:
    mylist: List[int] = field(default_factory=list)

當(dāng)初始化C的實(shí)例時(shí)就會(huì)調(diào)用list()而不是直接復(fù)制一份list的引用：

>>> c1 = C()
>>> c1.mylist += [1,2,3]
>>> c1.mylist
[1, 2, 3]
>>> c2 = C()
>>> c2.mylist
[]

數(shù)據(jù)污染得到了避免,。

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的類型注解為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)

這個(gè)例子中會(huì)返回c.i和c.j的數(shù)據(jù)，但是不會(huì)返回c.database的,。

一些常用函數(shù)

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

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

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

使用dataclasses.is_dataclass可以判斷一個(gè)類或?qū)嵗龑?duì)象是否是數(shù)據(jù)類：

>>> from dataclasses import is_dataclass
>>> is_dataclass(Lang)
True
>>> is_dataclass(Lang())
True

dataclass繼承

python3.7引入dataclass的一大原因就在于相比namedtuple，dataclass可以享受繼承帶來(lái)的便利,。

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

看個(gè)例子：

@dataclass
class Python(Lang):
    tab_size: int = 4
    is_script: bool = True

>>> Python()
Python(name='python', strong_type=True, static_type=False, age=28, tab_size=4, is_script=True)

@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)

Lang的field被Python繼承了,，而C中的x則覆蓋了Base中的定義。

沒錯(cuò),，數(shù)據(jù)類的繼承就是這么簡(jiǎn)單,。

總結(jié)

合理使用dataclass將會(huì)大大減輕開發(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ù)類為frozen dataclass

• 小心當(dāng)你定義了和dataclass生成的同名方法時(shí)會(huì)引發(fā)的問(wèn)題

• 當(dāng)使用可變類型（如list）時(shí),，應(yīng)該考慮使用field的default_factory

• 數(shù)據(jù)類的屬性都是公開的，如果你有屬性只需要初始化時(shí)使用而不需要在其他時(shí)候被訪問(wèn),，請(qǐng)使用dataclasses.InitVar

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