使用singledispatch在Python中追溯地添加方法
在我們覆蓋 7 個(gè) PyPI 庫的系列文章中了解更多解決 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 庫。今天,我們將研究 singledispatch,這是一個(gè)能讓你追溯地向 Python 庫添加方法的庫。
singledispatch
想象一下,你有一個(gè)有 Circle、Square 等類的“形狀”庫。
Circle 類有半徑、Square 有邊、Rectangle 有高和寬。我們的庫已經(jīng)存在,我們不想改變它。
然而,我們想給庫添加一個(gè)面積計(jì)算。如果我們不會(huì)和其他人共享這個(gè)庫,我們只需添加 area
方法,這樣我們就能調(diào)用 shape.area()
而無需關(guān)心是什么形狀。
雖然可以進(jìn)入類并添加一個(gè)方法,但這是一個(gè)壞主意:沒有人希望他們的類會(huì)被添加新的方法,程序會(huì)因奇怪的方式出錯(cuò)。
相反,functools 中的 singledispatch
函數(shù)可以幫助我們。
@singledispatch
def get_area(shape):
raise NotImplementedError("cannot calculate area for unknown shape",
shape)
get_area
函數(shù)的“基類”實(shí)現(xiàn)會(huì)報(bào)錯(cuò)。這保證了如果我們出現(xiàn)一個(gè)新的形狀時(shí),我們會(huì)明確地報(bào)錯(cuò)而不是返回一個(gè)無意義的結(jié)果。
@get_area.register(Square)
def _get_area_square(shape):
return shape.side ** 2
@get_area.register(Circle)
def _get_area_circle(shape):
return math.pi * (shape.radius ** 2)
這種方式的好處是如果某人寫了一個(gè)匹配我們代碼的新形狀,它們可以自己實(shí)現(xiàn) get_area
。
from area_calculator import get_area
@attr.s(auto_attribs=True, frozen=True)
class Ellipse:
horizontal_axis: float
vertical_axis: float
@get_area.register(Ellipse)
def _get_area_ellipse(shape):
return math.pi * shape.horizontal_axis * shape.vertical_axis
調(diào)用 get_area
很直接。
print(get_area(shape))
這意味著我們可以將大量的 if isintance()
/elif isinstance()
的代碼以這種方式修改,而無需修改接口。下一次你要修改 if isinstance,你試試 `singledispatch!
在本系列的下一篇文章中,我們將介紹 tox,一個(gè)用于自動(dòng)化 Python 代碼測(cè)試的工具。