Python3.7 dataclass使用指南

本文將帶你走進python3.7的新特性dataclass，通過本文你將學會dataclass的使用並避免踏入某些陷阱。

• dataclass簡介
• dataclass的使用
  • 定義一個dataclass
  • 深入dataclass裝飾器
  • 數據類的基石——dataclasses.field
  • 一些常用函數
  • dataclass繼承
• 總結

dataclass簡介

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

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

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

基於上述原因，通常自己實現一個dataclass是繁瑣而無聊的，而dataclass單一固定的行為正適合程式為我們自動生成，於是dataclasses模塊誕生了。

配合類型註解語法，我們可以輕鬆生成一個實現了__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

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

dataclass的使用

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

定義一個dataclass

dataclasses模塊提供了一個裝飾器幫助我們定義自己的數據類：

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

我們定義了一個描述某種程式語言特性的數據類——Lang，在接下來的例子中我們都會用到這個類。

在數據類被定義後，會根據給出的類型註解生成一個如下的初始函數：

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

可以看到初始化操作都已經自動生成了，讓我們試用一下：

>>> 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__方法也已經為我們生成了，如果沒有其他特殊要求的話這個dataclass已經具備了投入生產環境的能力，是不是很神奇？

深入dataclass裝飾器

dataclass的魔力源泉都在dataclass這個裝飾器中，如果想要完全掌控dataclass的話那麼它是你必須瞭解的內容。

裝飾器的原型如下：

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

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

我們的關註點集中在它的kwargs上：

有預設值的屬性必須定義在沒有預設值的屬性之後，和對kw參數的要求一樣。

上面我們偶爾提到了field的概念，我們所說的數據類屬性，數據屬性實際上都是被field的對象，它代表著一個數據的實體和它的元信息，下麵我們瞭解一下dataclasses.field。

數據類的基石——dataclasses.field

先看下field的原型：

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

通常我們無需直接使用，裝飾器會根據我們給出的類型註解自動生成field，但有時候我們也需要定製這一過程，這時dataclasses.field就顯得格外有用了。

default和default_factory參數將會影響預設值的產生，它們的預設值都是None，意思是調用時如果為指定則產生一個為None的值。其中default是field的預設值，而default_factory控制如何產生值，它接收一個無參數或者全是預設參數的callable對象，然後用調用這個對象獲得field的初始值，之後再將default（如果值不是MISSING）複製給callable返回的這個對象。

舉個例子，對於list，當複製它時只是複製了一份引用，所以像dataclass里那樣直接複製給實例的做法的危險而錯誤的，為了保證使用list時的安全性，應該這樣做：

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

當初始化C的實例時就會調用list()而不是直接複製一份list的引用：

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

數據污染得到了避免。

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)

這個例子中會返回c.i和c.j的數據，但是不會返回c.database的。

一些常用函數

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

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

>>> 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可以判斷一個類或實例對象是否是數據類：

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

dataclass繼承

python3.7引入dataclass的一大原因就在於相比namedtuple，dataclass可以享受繼承帶來的便利。

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

看個例子：

@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中的定義。

沒錯，數據類的繼承就是這麼簡單。

總結

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

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

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

參考

https://docs.python.org/3.7/library/dataclasses.html

https://www.python.org/dev/peps/pep-0557