python魔法方法-屬性訪問控制詳解

python魔法方法-屬性訪問控制詳解

屬性訪問控制

所謂的屬性訪問控制就是控制點號訪問屬性的行為,而且不僅是類的外部,連類的內部也受控制,程式碼見真章,邊看程式碼邊解釋:

•__getattr__(self, item)

定義當訪問不存在的屬性時的行為,注意是不存在的屬性。


class Foo(object):
def __init__(self, value):
self.value = value
def __getattr__(self, item):
print item # 檢視得到的引數是什麼
print type(item)  # 引數的型別是什麼
return 'attr:%s' % item # 最後返回一個東西看其行為如何
a = Foo('scolia')  # 建立一個例項

測試:


print a.value
print type(a.value)

其行為和沒定義前正常,下面看看訪問一個不存在的屬性時會發生什麼:


print a.abc

按照平常的情況,訪問不存在的屬性時肯定會丟擲異常,但是這裡輸出了三行,前兩個是方法輸出的,最後一行是外部的print語句輸出的,輸出的是方法的return值。方法得到的是我們訪問的屬性名,而且是以字串的形式。

知道了以上資訊後,我們就可以定製更多:


class Foo(object):
def __init__(self, value):
self.value = value
def __getattr__(self, item):
if item == 'scolia':
return 'can not set attr: %s' % item # 訪問不存在的scolia屬性時,列印一句話而不報錯
else:
raise AttributeError('not attr name: %s' % item)  # 訪問其他不存在的屬性時,觸發異常。

測試:


a = Foo(123)
print a.value # 訪問存在的屬性


print a.scolia # 訪問不存在的屬性,但我們做了特殊處理的

沒有觸發異常,和我們設想的一樣。


print a.good # 訪問不存在的屬性,但應該觸發異常的

觸發了我們想要的異常。

這裡要再強調一遍,必須是訪問不存在的屬性時,才會呼叫這個方法,例如:


a.scolia = 321
print a.scolia

因為這個屬性已經存在了(我們手動新增了),所以訪問它的時候並沒有呼叫這個方法,而在方法裡所做的任何處理,也不會有效。

更高階的技巧:


class Foo(object):
def __init__(self, value, defulat=None):
self.value = value
self.__defulat = defulat
def __getattr__(self, item):
item = item.lower() # 用字串的方法對其進行小寫
if item in self.__dict__:
return self.__dict__[item] # 返回相應的屬性
else:
self.__dict__[item] = self.__defulat  # 若屬性不存在則新增這個屬性並使用預設值
return self.__dict__[item]
a = Foo(123)
a.scolia = 321
print a.SCOlia
print a.good

我們實現了屬性的不區分大小寫訪問和自動新增不存在的屬性。

這裡的祕訣在於活用 __dict__ 這個屬性,我在類的屬性中已經討論過這個屬性。這個屬性由python自動建立,是一個字典,包含物件的所有屬性,字典裡的鍵就是屬性名,對應的值就是屬性值。所以這裡在這個字典中新增了鍵和值,就相當於為物件新增了屬性和屬性值。

•__setattr__(self, key, value)

定義了設定屬性時的行為,包括在 __init__ 初始化函式中的設定行為:


class Foo(object):
def __init__(self, value, defulat=None):
self.value = value
def __setattr__(self, key, value):
print key, type(key)
print value, type(value)
a = Foo('scolia')
b = Foo(123)

這裡可以看到初始化函式中的屬性新增的行為也受到了控制,其中 key 得到的是屬性名,以字串的形式;而 value 得到的是屬性值,屬性值根據輸入的不同而不同。

在這裡,我們僅僅只是列印了幾句話,而沒有進行屬性的新增,所以當我們試圖訪問相應的屬性時,會發現根本就沒有:


print a.value

觸發了異常,表示沒有相應的屬性。

知道了這些之後我們可以做很多事情,例如將所有的屬性名變成小寫或大寫,控制某些屬性名不能新增之類的,就不再舉例。不過,這裡你總不可能用 self.key = value 來新增屬性吧,因為 key 始終是一個字串。這個時候就要使用 __dict__ 屬性了,向這個字典中新增相應的鍵值對就可以了,具體就不再演示了。

•__delattr__(self, item)

定義了刪除一個屬性時的行為,item 得到的也是一個字串形式的屬性名,具體細節也無序多說,只要 del 掉 __dict__ 字典中對應是鍵和值就行了。另外,刪除不存在的屬性時呼叫的也是這個方法。

•__getattribute__(self, name)

這個方法定義了所有屬性訪問的行為,注意是所有,而不是 __getattr__ 中的不存在。當實現了這個方法之後,將會覆蓋 __getattr__ 方法,畢竟所有涵蓋了不存在。

這個方法只在新式類中有效。

但是,你也可以顯式的呼叫 __getattr__,例如 a.__getattr__ 來使用這個被掩蓋的方法,或者是觸發 AttributeError 異常時也會自動呼叫它。

然而,非常不建議使用這個方法,因為可能會很多不可預知的異常情況,最常見的就是無盡的遞迴呼叫,例如:


class Foo(object):
def __init__(self, value):
self.value = value
def __getattribute__(self, item):
return self.__dict__[item]
a = Foo('scolia')
print a.value

這段程式碼看起來很正常,但是這裡有一個陷阱,因為類中的所有的屬性訪問都是受這幾個魔法方法控制的,包括上面介紹的幾個魔法方法。它們似乎比普通的魔法方法擁有更高的許可權一般。

但這就導致了一個問題,例如這裡的 self.__dict__[item] ,這句話也受屬性訪問的控制,儘管這個屬性是 python 為我們建立的。

也就是說獲取 self.__dict__ 時,會再次呼叫 __getattribute__ 方法,然後方法內又呼叫了 self.__dict__ 。這樣無限迴圈下去,最終會丟擲一個異常。

異常資訊非常長,這裡我是拉到最後才截的圖。

其實不僅這個魔法方法會導致這樣異常,上面討論的幾種魔法方法可能都會出現這個問題,只不過這個魔法方法的許可權更大,所以異常出現的可能性更高一些。

這也就是不推薦這個魔法方法的原因,而使用其他的屬性控制方法的時候也要小心。

而到目前為止,我們所學到的屬性訪問的方法只有兩種,一是直接用點號訪問,還有就是先通過點號訪問__dict__ 屬性,然後在這個字典中獲取相應的鍵值對。而這兩種方法都受到了 __getattribute__ 的控制,呼叫它們就相當於沒有終點的自呼叫(有終點的自呼叫有時能提升效率),那麼這個方法到底要怎麼用呢?

技巧就是呼叫父類的這個方法:


class Foo(object):
def __init__(self, value):
self.value = value
def __getattribute__(self, item):
return object.__getattribute__(self, item) # 非繫結方法要顯式傳遞self
a = Foo('scolia')
print a.value

這裡呼叫的是object的這個方法,如果是涉及到繼承的話:


class Boo(Foo):
def __init__(self, value):
self.value = value
def __getattribute__(self, item):
return Foo.__getattribute__(self, item)
# return super(Boo, self).__getattribute__(item)  也可以使用super函式讓python自動在其父類們尋找這個方法。
a = Foo('scolia')
print a.value
b = Boo(123)
print b.value

訪問正常。

其實最後呼叫了還是 object 或其他內建型別的方法。

而我們姑且不起探究object到底是怎麼實現的,因為這可能是用 C 所寫的,只要會用就可以,雖然這個方法用的也不多。

最後附上一個完整的例子:


class Foo(object):
def __init__(self, value):
self.value = value
def __getattr__(self, item):
if item == 'scolia':
return 'no attr:%s' % item
elif item in self.__dict__:
return self.__dict__[item]
else:
raise AttributeError('no attr:%s' % item)
def __setattr__(self, key, value):
if key == 'good':
print 'can not set the attr: good'
else:
self.__dict__[key] = value
def __delattr__(self, item):
if item == 'a':
print 'no attr: good'
else:
del self.__dict__[item]
def __getattribute__(self, item):
if item == 'a':
raise AttributeError('not a')
return object.__getattribute__(self, item)
a = Foo('scolia')
print a.value  # 正常訪問
a.a = 123  # __getattribute__會觸發AttributeError異常,此時呼叫__getattr__
# 而__getattr__新增了這個屬性,所以最後異常沒有觸發,屬性也新增了
print a.a  # 結果能夠訪問
del a.a # 試圖刪除這個屬性
print a.a # 刪除行為被阻止了,所以該屬性還在
a.good = 'good' # 因為新增被阻止了
print a.good # 所以訪問失敗了

結果:

以上這篇python魔法方法-屬性訪問控制詳解就是小編分享給大家的全部內容了,希望能給大家一個參考,也希望大家多多支援指令碼之家。

您可能感興趣的文章:

python直接訪問私有屬性的簡單方法python類:class建立、資料方法屬性及訪問控制詳解python魔法方法-屬性轉換和類的表示詳解對比Python中__getattr__和 __getattribute__獲取屬性的用法python中string模組各屬性以及函式的用法介紹淺談python類屬性的訪問、設定和刪除方法