Python 3.7新功能之dataclass裝飾器詳解
前言
Python 3.7 將于今年夏天發(fā)布,Python 3.7 中將會有許多新東西:
- 各種字符集的改進(jìn)
- 對注釋的推遲評估
- 以及對dataclass的支持
最激動人心的新功能之一是 dataclass 裝飾器。
什么是 Data Class
大多數(shù) Python 開發(fā)人員編寫過很多像下面這樣的類:
class MyClass: def __init__(self, var_a, var_b): self.var_a = var_a self.var_b = var_b
dataclass 可以為簡單的情況自動生成方法,例如,一個(gè)__init__接受這些參數(shù)并將其分配給自己,之前的小例子可以重寫為:
@dataclass class MyClass: var_a: str var_b: str
那么通過一個(gè)例子來看看如何使用吧
星球大戰(zhàn) API
可以使用 requests 從星球大戰(zhàn) API 獲取資源:
response = requests.get('https://swapi.co/api/films/1/') dictionary = response.json()
讓我們來看看 dictionary (簡化過)的結(jié)果:
{ '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.\r\n … ', '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
為了正確地封裝一個(gè) API,我們應(yīng)該創(chuàng)建一個(gè)用戶可以在其應(yīng)用程序中使用的對象,因此,在Python 3.6 中定義一個(gè)對象來包含requests對 /films/endpoint的響應(yīng):
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)
仔細(xì)的讀者可能已經(jīng)注意到這里有一些重復(fù)的代碼。
這是使用 dataclass 裝飾器的經(jīng)典案例,我們需要?jiǎng)?chuàng)建一個(gè)主要用來保存數(shù)據(jù)的類,只需一點(diǎn)驗(yàn)證,所以讓我們來看看我們需要修改什么。
首先,data class 自動生成一些 dunder 方法,如果我們沒有為 data class 裝飾器指定任何選項(xiàng),則生成的方法有:__init__,__eq__和__repr__,如果你已經(jīng)定義了__repr__但沒定義__str__,默認(rèn)情況下 Python(不僅僅是 data class)將實(shí)現(xiàn)返回__repr__的輸出__str__方法。因此,只需將代碼更改為以下代碼即可實(shí)現(xiàn)四種 dunder 方法:
@dataclass class 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
我們?nèi)サ袅薩_init__方法,以確保 data class 裝飾器可以添加它生成的對應(yīng)方法。不過,我們在這個(gè)過程中失去了一些功能,我們的 Python 3.6 構(gòu)造函數(shù)不僅定義了所有的值,還試圖解析日期,我們怎樣才能用 data class 來做到這一點(diǎn)呢?
如果要覆蓋 __init__,我們將失去 data class 的優(yōu)勢,因此,如果要處理任何附加功能可以使用新的 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 裝飾器在用三分之二的代碼量實(shí)現(xiàn)我們的類。
更多好東西
通過使用裝飾器的選項(xiàng),可以為用例進(jìn)一步定制 data class,默認(rèn)選項(xiàng)是:
@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 實(shí)際上創(chuàng)建了四種 dunder 方法,它們確定所有檢查小于,and/or,大于的行為,如果將其設(shè)置為 true,則可以對對象列表進(jìn)行排序。
最后兩個(gè)選項(xiàng)確定對象是否可以被哈?;?,如果你想使用你的 class 的對象作為字典鍵的話,這是必要的。
更多信息請參考:PEP 557 -- Data Classes
總結(jié)
以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,如果有疑問大家可以留言交流,謝謝大家對腳本之家的支持。

Python利用PIL實(shí)現(xiàn)多張圖片合成gif動畫的案例詳解

python利用datetime模塊計(jì)算時(shí)間差

Python實(shí)現(xiàn)對圖像加噪(高斯噪聲 椒鹽噪聲)

Python中xml和dict格式轉(zhuǎn)換的示例代碼

Python中使用glob和rmtree刪除目錄子目錄及所有文件的例子