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上：

key	含義
init	指定是否自動生成__init__，若是已經有定義同名方法則忽略這個值，也就是指定爲True也不會自動生成
repr	同init，指定是否自動生成__repr__；自動生成的打印格式爲class_name(arrt1:value1, attr2:value2, ...)
eq	同init，指定是否生成__eq__；自動生成的方法將按屬性在類內定義時的順序逐個比較，所有的值相同纔會返回True
order	自動生成__lt__，__le__，__gt__，__ge__，比較方式與eq相同；若是order指定爲True而eq指定爲False，將引起ValueError；若是已經定義同名函數，將引起TypeError
unsafehash	若是是False，將根據eq和frozen參數來生成__hash__: 1. eq和frozen都爲True，__hash__將會生成 2. eq爲True而frozen爲False，__hash__被設爲None 3. eq爲False，frozen爲True，__hash__將使用超類（object）的同名屬性（一般就是基於對象id的hash） 當設置爲True時將會根據類屬性自動生成__hash__，然而這是不安全的，由於這些屬性是默承認變的，這會致使hash的不一致，因此除非能保證對象屬性不可隨意改變，不然應該謹慎地設置該參數爲True
frozen	設爲True時對field賦值將會引起錯誤，對象將是不可變的，若是已經定義了__setattr__和__delattr__將會引起TypeError

有默認值的屬性必須定義在沒有默認值的屬性以後，和對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