使用attrs來告別Python中的樣板
在我們覆蓋 7 個(gè) PyPI 庫(kù)的系列文章中了解更多解決 Python 問題的信息。
Python是當(dāng)今使用最多流行的編程語言之一,因?yàn)椋核情_源的,它具有廣泛的用途(例如 Web 編程、業(yè)務(wù)應(yīng)用、游戲、科學(xué)編程等等),它有一個(gè)充滿活力和專注的社區(qū)支持它。這個(gè)社區(qū)是我們?cè)?Python Package Index(PyPI)中提供如此龐大、多樣化的軟件包的原因,用以擴(kuò)展和改進(jìn) Python。并解決不可避免的問題。
在本系列中,我們將介紹七個(gè)可以幫助你解決常見 Python 問題的 PyPI 庫(kù)。今天,我們將研究 attrs,這是一個(gè)幫助你快速編寫簡(jiǎn)潔、正確的代碼的 Python 包。
attrs
如果你已經(jīng)寫過一段時(shí)間的 Python,那么你可能習(xí)慣這樣寫代碼:
class Book(object):
def __init__(self, isbn, name, author):
self.isbn = isbn
self.name = name
self.author = author
接著寫一個(gè) __repr__
函數(shù)。否則,很難記錄 Book
的實(shí)例:
def __repr__(self):
return f"Book({self.isbn}, {self.name}, {self.author})"
接下來你會(huì)寫一個(gè)好看的 docstring 來記錄期望的類型。但是你注意到你忘了添加 edition
和 published_year
屬性,所以你必須在五個(gè)地方修改它們。
如果你不必這么做如何?
@attr.s(auto_attribs=True)
class Book(object):
isbn: str
name: str
author: str
published_year: int
edition: int
使用新的類型注釋語法注釋類型屬性,attrs
會(huì)檢測(cè)注釋并創(chuàng)建一個(gè)類。
ISBN 有特定格式。如果我們想強(qiáng)行使用該格式怎么辦?
@attr.s(auto_attribs=True)
class Book(object):
isbn: str = attr.ib()
@isbn.validator
def pattern_match(self, attribute, value):
m = re.match(r"^(\d{3}-)\d{1,3}-\d{2,3}-\d{1,7}-\d$", value)
if not m:
raise ValueError("incorrect format for isbn", value)
name: str
author: str
published_year: int
edition: int
attrs
庫(kù)也對(duì)不可變式編程支持良好。將***行改成 @attr.s(auto_attribs=True, frozen=True)
意味著 Book
現(xiàn)在是不可變的:嘗試修改一個(gè)屬性將會(huì)引發(fā)一個(gè)異常。相反,比如,如果希望將發(fā)布日期向后一年,我們可以修改成 attr.evolve(old_book, published_year=old_book.published_year+1)
來得到一個(gè)新的實(shí)例。
本系列的下一篇文章我們將來看下 singledispatch
,一個(gè)能讓你向 Python 庫(kù)添加方法的庫(kù)。