Python 3.7 將引入 dataclass 裝飾器

簡評：Python 3.7 將於今年夏天發布，Python 3.7 中將會有許多新東西，最激動人心的新功能之一是 dataclass 裝飾器。

什麼是 Data Class

大多數 Python 開發人員編寫過很多像下面這樣的類：

class MyClass: def __init__(self, var_a, var_b): self.var_a = var_a self.var_b = var_b

dataclass 可以為簡單的情況自動生成方法，例如，一個__init__接受這些參數並將其分配給自己，之前的小例子可以重寫為：

@dataclassclass MyClass: var_a: str var_b: str

那麼通過一個例子來看看如何使用吧

星球大戰 API

可以使用 requests 從星球大戰 API 獲取資源：

response = requests.get(https://swapi.co/api/films/1/)dictionary = response.json()

讓我們來看看 dictionary （簡化過）的結果：

{ characters: [https://swapi.co/api/people/1/,… ], created: 2014-12-10T14:23:31.880000Z, director: George Lucas, edited: 2015-04-11T09:46:52.774897Z, episode_id: 4, opening_crawl: It is a period of civil war.
… , planets: [https://swapi.co/api/planets/2/, … ], producer: Gary Kurtz, Rick McCallum, release_date: 1977-05-25, species: [https://swapi.co/api/species/5/,…], starships: [https://swapi.co/api/starships/2/,…], title: A New Hope, url: https://swapi.co/api/films/1/, vehicles: [https://swapi.co/api/vehicles/4/,…]

封裝 API

為了正確地封裝一個 API，我們應該創建一個用戶可以在其應用程序中使用的對象，因此，在Python 3.6 中定義一個對象來包含requests對 /films/endpoint的響應：

class StarWarsMovie: def __init__(self, title: str, episode_id: int, opening_crawl: str, director: str, producer: str, release_date: datetime, characters: List[str], planets: List[str], starships: List[str], vehicles: List[str], species: List[str], created: datetime, edited: datetime, url: str ): self.title = title self.episode_id = episode_id self.opening_crawl= opening_crawl self.director = director self.producer = producer self.release_date = release_date self.characters = characters self.planets = planets self.starships = starships self.vehicles = vehicles self.species = species self.created = created self.edited = edited self.url = url if type(self.release_date) is str: self.release_date = dateutil.parser.parse(self.release_date) if type(self.created) is str: self.created = dateutil.parser.parse(self.created) if type(self.edited) is str: self.edited = dateutil.parser.parse(self.edited)

仔細的讀者可能已經注意到這裡有一些重複的代碼。

這是使用 dataclass 裝飾器的經典案例，我們需要創建一個主要用來保存數據的類，只需一點驗證，所以讓我們來看看我們需要修改什麼。

首先，data class 自動生成一些 dunder 方法，如果我們沒有為 data class 裝飾器指定任何選項，則生成的方法有：__init__，__eq__和__repr__，如果你已經定義了__repr__但沒定義__str__，默認情況下 Python（不僅僅是 data class）將實現返回__repr__的輸出__str__方法。因此，只需將代碼更改為以下代碼即可實現四種 dunder 方法：

@dataclassclass StarWarsMovie: title: str episode_id: int opening_crawl: str director: str producer: str release_date: datetime characters: List[str] planets: List[str] starships: List[str] vehicles: List[str] species: List[str] created: datetime edited: datetime url: str

我們去掉了__init__方法，以確保 data class 裝飾器可以添加它生成的對應方法。不過，我們在這個過程中失去了一些功能，我們的 Python 3.6 構造函數不僅定義了所有的值，還試圖解析日期，我們怎樣才能用 data class 來做到這一點呢？

如果要覆蓋 __init__，我們將失去 data class 的優勢，因此，如果要處理任何附加功能可以使用新的 dunder 方法：__post_init__，讓我們看看__post_init__方法對於我們的包裝類來說是什麼樣子的：

def __post_init__(self): if type(self.release_date) is str: self.release_date = dateutil.parser.parse(self.release_date) if type(self.created) is str: self.created = dateutil.parser.parse(self.created) if type(self.edited) is str: self.edited = dateutil.parser.parse(self.edited)

就是這樣！ 我們可以使用 data class 裝飾器在用三分之二的代碼量實現我們的類。

更多好東西

通過使用裝飾器的選項，可以為用例進一步定製 data class，默認選項是：

@dataclass(init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False)

• init決定是否生成__init__ dunder 方法
• repr決定是否生成__repr__ dunder方法
• eq對__eq__ dunder 方法也是如此，它決定相等性檢查的行為（your_class_instance == another_instance）
• order 實際上創建了四種 dunder 方法，它們確定所有檢查小於，and/or，大於的行為，如果將其設置為 true，則可以對對象列表進行排序。

最後兩個選項確定對象是否可以被哈希化，如果你想使用你的 class 的對象作為字典鍵的話，這是必要的。

更多信息請參考：PEP 557 -- Data Classes

原文：Python 3.7: Introducing Data Classes

擴展閱讀：

• Helperhaps：一個好的 README 的些許建議
• Python 家族有多龐大
• Python：range 對象並不是迭代器

極光日報，極光開發者旗下媒體。

每天導讀三篇英文技術文章。