Python attrs提高物件導向程式設計效率詳細

2021-09-27 13:03:13

Python是物件導向的語言，一般情況下使用物件導向程式設計會使得開發效率更高，軟體質量更好，並且程式碼更易於擴充套件，可讀性和可維護性也更高。但是如果在一個較大的專案中，如果實體類非常多並且有非常複雜的屬性，你就會逐漸覺得Python的類寫起來是真·「累」。為什麼這樣說，看下下面這個Box類，屬性有長（length）、寬（width）、高（hight）：

class Box:
     def __init__(self, length, width, hight):
         
         self.length = length
         self.width = width
         self.hight = hight

這樣倒沒有什麼問題，而且是符合Python規範的寫法，初始化函數內每一個引數都需要用self.xxx = xxx進行賦值，引數少了還好，但是如果引數過多了，只是引數賦值操作都夠寫一會的了，如果一個專案中類也有很多，那就真的要麻木了。

而且我們知道，在Python中，想要自定義物件本身的列印輸出結果的時候，需要在它的類中實現__repr__() 方法，例如：

    def __repr__(self):
        return '{}(length={}, width={}, hight={})'.format(
            self.__class__.__name__, self.length, self.width, self.hight)

實現了__repr__() 方法，當我們列印物件本身的時候，才會輸出我們自定義的字元。

box = Box(20, 15, 15)
print(box)
# 結果輸出為 Box(length=20, width=15, hight=15)

但是有時會因為麻煩，我們不願意去實現__repr__()方法，但是不實現列印結果又不友好，就陷入了糾結之中。

如果我麼想要實現物件比較，有時候需要判斷2個物件是否相等或者比較大小，就要實現__eq__() 、 __lt__() 、__gt__()等各種方法來實現物件之間的比較，例如：

def __eq__(self, other):
    if not isinstance(other, self.__class__):
        return NotImplemented
    return (self.length, self.width, self.hight) == (
        other.length, other.width, other.hight)

這樣我們又需要實現這幾個用於比較的方法。比如說我們已經實現了上面說過的所有方法，然後又突然新增一個屬性結實度hardness，那麼整個類的方法都需要修改，這是非常折磨人的。那麼有沒有一種方法，可以在建立類的時候自動新增上類似於上面提到的這些東西，答案是有的，那就是我們接下來要介紹的attrs模組，它可以幫助我們很方便的定義類。

1、attrs的使用

我們可以使用pip install attrs進行安裝。

然後將上面的程式碼改造一下：

from attr import attrs, attrib


@attrs
class Box:
    length = attrib(type=int, default=0)
    width = attrib(type=int, default=0)
    hight = attrib(type=int, default=0)


box1 = Box(20, 15, 15)
print(box1)
box2 = Box(30, 20, 20)
print(box2 == box1)
print(box2 > box1)

用模組內的attrs修飾了Box類，再使用attrib定義所有的屬性，同時指定了屬性的型別和預設值。而且我們沒有實現任何一個上面所提到的方法，但是確實實現了所有的功能。現在如果我們新增一個屬性顏色color，這個屬性不參與物件的比較，但是列印的時候要輸出，新增一個屬性結實度hardness，這個屬性參與物件的比較，但是列印物件的時候不輸出，就非常簡單了：

from attr import attrs, attrib


@attrs
class Box:
    length = attrib(type=int, default=0)
    width = attrib(type=int, default=0)
    hight = attrib(type=int, default=0)
    color = attrib(repr=True, cmp=False, default=(0, 0, 0))
    hardness = attrib(repr=False, cmp=True, default=0)


box1 = Box(20, 15, 15, (255, 255, 255), 80)
print("box1:", box1)
box2 = Box(20, 15, 15, (255, 255, 0), 100)
print("box2:", box2)
print(box2 == box1)
print(box2 > box1)

執行結果為：

也就是說，如果我們用了attrs庫的話，會讓類的定義變得高效簡潔，就不需要再寫哪些冗餘又複雜的程式碼了。關於attrib() ，接收以下引數：

default：屬性的預設值，如果沒有傳入初始化資料，那麼就會使用預設值
validator：驗證器，檢查傳入的引數是否合法
repr：是否參與物件列印時的輸出
cmp：是否參與物件比較
hash：是否進行去重
init：是否參與初始化，如果為False，那麼這個引數不能當做類的初始化引數，預設是True
metadata：後設資料，唯讀性的附加資料
type：型別，比如 int、str 等各種型別，預設為 None
converter：轉換器，進行一些值的處理和轉換器，增加容錯性
kw_only：是否為強制關鍵字引數，預設為 False

這裡我們只重點說一下驗證器和轉換器，其他的引數都很好理解。

2、驗證器

有時候在設定一個屬性的時候必須要滿足某個條件，比如上面的顏色color屬性，我們使用的是RGB三原色方式，例如黑色是（255，255，255），對於這種情況，我們就需要驗證屬性是否合法。

例如：

def color_is_valid(instance, attr, value):
    if not isinstance(value, set):
        raise ValueError(f"引數{attr.name}:{value}不合法！")
    for i in value:
        if not 0 <= i<= 255:
            raise ValueError(f"引數{attr.name}:{value}不合法！")




@attrs
class Box:
    length = attrib(type=int, default=0)
    width = attrib(type=int, default=0)
    hight = attrib(type=int, default=0)
    color = attrib(repr=True, cmp=False, validator=color_is_valid, default=(0, 0, 0))
    hardness = attrib(repr=False, cmp=True, default=0)


box1 = Box(20, 15, 15, (255, 255, 260), 80)

執行結果為：

上述程式碼中定義了一個驗證器color_is_valid()方法來驗證顏色color是否合法，不合法時就會拋異常。

驗證器方法接收三個引數：

instance：類物件
attr：屬性名
value：屬性值

而且attrs模組也提供了許多內建驗證器，這裡就不做贅述了。

3、轉換器

轉換器主要做一些值的處理和轉換，增加類的容錯性，比如一個屬性接收的是int型別，我們想要的是傳入了數位字串也不會報錯，那我們就可以增加轉換器，將字串自動轉為數位，例如：

def to_int(value):
    try:
        return int(value)
    except:
        return None


@attrs
class Box:
    length = attrib(type=int, default=0, converter=to_int)
    width = attrib(type=int, default=0, converter=to_int)
    hight = attrib(type=int, default=0)
    color = attrib(repr=True, cmp=False, default=(0, 0, 0))
    hardness = attrib(repr=False, cmp=True, default=0)


box1 = Box("20", "15", 15, (255, 255, 255), 80)
print("box1:", box1)
box2 = Box("2a", 15, 15, (255, 255, 0), 100)
print("box2:", box2)

上面定義了一個方法to_int() ，可以將值轉化為數位型別，轉換異常就返回None，這樣容錯性非常高了。

到此這篇關於Python attrs提高物件導向程式設計效率詳細的文章就介紹到這了,更多相關Python attrs提高物件導向程式設計效率內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

Python attrs提高物件導向程式設計效率詳細

目錄

1、attrs的使用

2、驗證器

3、轉換器

熱門文章