Python3.7 dataclass使用指南

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

dataclass簡介

dataclass的使用

定義一個dataclass

深入dataclass裝飾器

資料類的基石——dataclasses.field

一些常用函數

dataclass繼承

總結

dataclass的定義位于[PEP-557](https://www.python.org/dev/peps/pep-0557/)，根據定義一個dataclass是指“一個帶有預設值的可變的namedtuple”，廣義的定義就是有一個類，它的屬性均可公開通路，可以帶有預設值并能被修改，而且類中含有與這些屬性相關的類方法，那麼這個類就可以稱為dataclass，再通俗點講，dataclass就是一個含有資料及操作資料方法的容器。

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

相比普通class，dataclass通常不包含私有屬性，資料可以直接通路
dataclass的repr方法通常有固定格式，會列印出類型名以及屬性名和它的值
dataclass擁有 __eq__ 和 __hash__ 魔法方法
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更靈活。同時因為它是一個正常的類，是以你可以享受繼承帶來的便利。

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

`dataclasses`子產品提供了一個裝飾器幫助我們定義自己的資料類：

```python

@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的話那麼它是你必須了解的内容。

裝飾器的原型如下：

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

。

先看下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)

當初始化

的執行個體時就會調用

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

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

繼承了，而

中的

則覆寫了

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

Python3.7 dataclass使用指南

參考

繼續閱讀

來自python的【條件控制/語句循環/break/continue/else/pass】一、條件控制二、語句循環

無法解析的外部符号 wmain，該符号在函數 "void cdecl mainCRTStartupHelper(struct HINSTANCE *,unsigned short con......

TestLink導出用例轉換工具(XML2Excel)

YAML簡介和PyYAML安全操作YAML支援的類型YAML的優點：yaml的基本文法python操作

Small tricks

libsvm for python 安裝

學習軟體測試基礎測試第七天

Zeppelin 配置通路 REST APIApache Zeppelin Configuration REST API

【Torch】最簡潔logging使用指南

27. Remove Element(清單)題目代碼

Cloud Studio初體驗

使用 ctypes 進行 Python 和 C 的混合程式設計

【python】【資料處理】畫多元資料分布圖

【python】netconf協定對接管理裝置

「Python 網絡自動化」NETCONF —— Python 使用 NETCONF 管理配置 H3C 網絡裝置

在python中建立excel并寫入