Descriptors(描述符)是Python語(yǔ)言中一個(gè)深?yuàn)W但很重要的一個(gè)黑魔法，它被廣泛應(yīng)用于Python語(yǔ)言的內(nèi)核，熟練掌握描述符將會(huì)為Python程序員的工具箱添加一個(gè)額外的技巧。本文我將講述描述符的定義以及一些常見的場(chǎng)景，并且在文末會(huì)補(bǔ)充一下__getattr，__getattribute__,__getitem__這三個(gè)同樣涉及到屬性訪問的魔術(shù)方法。
描述符的定義
descr__get__(self,obj,objtype=None)-->value
descr.__set__(self,obj,value)-->None
descr.__delete__(self,obj)-->None
只要一個(gè)objectattribute(對(duì)象屬性)定義了上面三個(gè)方法中的任意一個(gè)，那么這個(gè)類就可以被稱為描述符類。
描述符基礎(chǔ)
下面這個(gè)例子中我們創(chuàng)建了一個(gè)RevealAcess類，并且實(shí)現(xiàn)了__get__方法，現(xiàn)在這個(gè)類可以被稱為一個(gè)描述符類。
classRevealAccess(object):
def__get__(self,obj,objtype):
print('selfinRevealAccess:{}'.format(self))
print('self:{}\nobj:{}\nobjtype:{}'.format(self,obj,objtype))
classMyClass(object):
x=RevealAccess()
deftest(self):
print('selfinMyClass:{}'.format(self))
EX1實(shí)例屬性
接下來(lái)我們來(lái)看一下__get__方法的各個(gè)參數(shù)的含義，在下面這個(gè)例子中，self即RevealAccess類的實(shí)例x，obj即MyClass類的實(shí)例m，objtype顧名思義就是MyClass類自身。從輸出語(yǔ)句可以看出，m.x訪問描述符x會(huì)調(diào)用__get__方法。
>>>m=MyClass()
>>>m.test()
selfinMyClass:<__main__.MyClassobjectat0x7f19d4e42160>
>>>m.x
selfinRevealAccess:<__main__.RevealAccessobjectat0x7f19d4e420f0>
self:<__main__.RevealAccessobjectat0x7f19d4e420f0>
obj:<__main__.MyClassobjectat0x7f19d4e42160>
objtype:
EX2類屬性
如果通過(guò)類直接訪問屬性x，那么obj接直接為None，這還是比較好理解，因?yàn)椴淮嬖贛yClass的實(shí)例。
>>>MyClass.x
selfinRevealAccess:<__main__.RevealAccessobjectat0x7f53651070f0>
self:<__main__.RevealAccessobjectat0x7f53651070f0>
obj:None
objtype:
描述符的原理
描述符觸發(fā)
上面這個(gè)例子中，我們分別從實(shí)例屬性和類屬性的角度列舉了描述符的用法，下面我們來(lái)仔細(xì)分析一下內(nèi)部的原理：
如果是對(duì)實(shí)例屬性進(jìn)行訪問，實(shí)際上調(diào)用了基類object的__getattribute__方法，在這個(gè)方法中將obj.d轉(zhuǎn)譯成了type(obj).__dict__['d'].__get__(obj,type(obj))。
如果是對(duì)類屬性進(jìn)行訪問，相當(dāng)于調(diào)用了元類type的__getattribute__方法，它將cls.d轉(zhuǎn)譯成cls.__dict__['d'].__get__(None,cls)，這里__get__()的obj為的None，因?yàn)椴淮嬖趯?shí)例。
簡(jiǎn)單講一下__getattribute__魔術(shù)方法，這個(gè)方法在我們?cè)L問一個(gè)對(duì)象的屬性的時(shí)候會(huì)被無(wú)條件調(diào)用，詳細(xì)的細(xì)節(jié)比如和__getattr,__getitem__的區(qū)別我會(huì)在文章的末尾做一個(gè)額外的補(bǔ)充，我們暫時(shí)并不深究。
描述符優(yōu)先級(jí)
首先，描述符分為兩種:
如果一個(gè)對(duì)象同時(shí)定義了__get__()和__set__()方法，則這個(gè)描述符被稱為datadescriptor。
如果一個(gè)對(duì)象只定義了__get__()方法，則這個(gè)描述符被稱為non-datadescriptor。
我們對(duì)屬性進(jìn)行訪問的時(shí)候存在下面四種情況：
datadescriptor
instancedict
non-datadescriptor
__getattr__()
它們的優(yōu)先級(jí)大小是：
datadescriptor>instancedict>non-datadescriptor>__getattr__()
這是什么意思呢?就是說(shuō)如果實(shí)例對(duì)象obj中出現(xiàn)了同名的datadescriptor->d和instanceattribute->d，obj.d對(duì)屬性d進(jìn)行訪問的時(shí)候，由于datadescriptor具有更高的優(yōu)先級(jí)，Python便會(huì)調(diào)用type(obj).__dict__['d'].__get__(obj,type(obj))而不是調(diào)用obj.__dict__[‘d’]。但是如果描述符是個(gè)non-datadescriptor，Python則會(huì)調(diào)用obj.__dict__['d']。
Property
每次使用描述符的時(shí)候都定義一個(gè)描述符類，這樣看起來(lái)非常繁瑣。Python提供了一種簡(jiǎn)潔的方式用來(lái)向?qū)傩蕴砑訑?shù)據(jù)描述符。
property(fget=None,fset=None,fdel=None,doc=None)->propertyattribute
fget、fset和fdel分別是類的getter、setter和deleter方法。我們通過(guò)下面的一個(gè)示例來(lái)說(shuō)明如何使用Property：
classAccount(object):
def__init__(self):
self._acct_num=None
defget_acct_num(self):
returnself._acct_num
defset_acct_num(self,value):
self._acct_num=value
defdel_acct_num(self):
delself._acct_num
acct_num=property(get_acct_num,set_acct_num,del_acct_num,'_acct_numproperty.')
如果acct是Account的一個(gè)實(shí)例，acct.acct_num將會(huì)調(diào)用getter，acct.acct_num=value將調(diào)用setter，delacct_num.acct_num將調(diào)用deleter。
>>>acct=Account()
>>>acct.acct_num=1000
>>>acct.acct_num
1000
Python也提供了@property裝飾器，對(duì)于簡(jiǎn)單的應(yīng)用場(chǎng)景可以使用它來(lái)創(chuàng)建屬性。一個(gè)屬性對(duì)象擁有g(shù)etter,setter和deleter裝飾器方法，可以使用它們通過(guò)對(duì)應(yīng)的被裝飾函數(shù)的accessor函數(shù)創(chuàng)建屬性的拷貝。
classAccount(object):
def__init__(self):
self._acct_num=None
@property
#the_acct_numproperty.thedecoratorcreatesaread-onlyproperty
defacct_num(self):
returnself._acct_num
@acct_num.setter
#the_acct_numpropertysettermakesthepropertywriteable
defset_acct_num(self,value):
self._acct_num=value
@acct_num.deleter
defdel_acct_num(self):
delself._acct_num
如果想讓屬性只讀，只需要去掉setter方法。
在運(yùn)行時(shí)創(chuàng)建描述符
我們可以在運(yùn)行時(shí)添加property屬性：
classPerson(object):
defaddProperty(self,attribute):
#createlocalsetterandgetterwithaparticularattributename
getter=lambdaself:self._getProperty(attribute)
setter=lambdaself,value:self._setProperty(attribute,value)
#constructpropertyattributeandaddittotheclass
setattr(self.__class__,attribute,property(fget=getter,\
fset=setter,\
doc="Auto-generatedmethod"))
def_setProperty(self,attribute,value):
print("Setting:{}={}".format(attribute,value))
setattr(self,'_'+attribute,value.title())
def_getProperty(self,attribute):
print("Getting:{}".format(attribute))
returngetattr(self,'_'+attribute)
>>>user=Person()
>>>user.addProperty('name')
>>>user.addProperty('phone')
>>>user.name='johnsmith'
Setting:name=johnsmith
>>>user.phone='12345'
Setting:phone=12345
>>>user.name
Getting:name
'JohnSmith'
>>>user.__dict__
{'_phone':'12345','_name':'JohnSmith'}
靜態(tài)方法和類方法
我們可以使用描述符來(lái)模擬Python中的@staticmethod和@classmethod的實(shí)現(xiàn)。我們首先來(lái)瀏覽一下下面這張表：
靜態(tài)方法
對(duì)于靜態(tài)方法f。c.f和C.f是等價(jià)的，都是直接查詢object.__getattribute__(c,‘f’)或者object.__getattribute__(C,’f‘)。靜態(tài)方法一個(gè)明顯的特征就是沒有self變量。
靜態(tài)方法有什么用呢?假設(shè)有一個(gè)處理專門數(shù)據(jù)的容器類，它提供了一些方法來(lái)求平均數(shù)，中位數(shù)等統(tǒng)計(jì)數(shù)據(jù)方式，這些方法都是要依賴于相應(yīng)的數(shù)據(jù)的。但是類中可能還有一些方法，并不依賴這些數(shù)據(jù)，這個(gè)時(shí)候我們可以將這些方法聲明為靜態(tài)方法，同時(shí)這也可以提高代碼的可讀性。
使用非數(shù)據(jù)描述符來(lái)模擬一下靜態(tài)方法的實(shí)現(xiàn)：
classStaticMethod(object):
def__init__(self,f):
self.f=f
def__get__(self,obj,objtype=None):
returnself.f
我們來(lái)應(yīng)用一下：
classMyClass(object):
@StaticMethod
defget_x(x):
returnx
print(MyClass.get_x(100))#output:100
類方法
Python的@classmethod和@staticmethod的用法有些類似，但是還是有些不同，當(dāng)某些方法只需要得到類的引用而不關(guān)心類中的相應(yīng)的數(shù)據(jù)的時(shí)候就需要使用classmethod了。
使用非數(shù)據(jù)描述符來(lái)模擬一下類方法的實(shí)現(xiàn)：
classClassMethod(object):
def__init__(self,f):
self.f=f
def__get__(self,obj,klass=None):
ifklassisNone:
klass=type(obj)
defnewfunc(*args):
returnself.f(klass,*args)
returnnewfunc
其他的魔術(shù)方法
首次接觸Python魔術(shù)方法的時(shí)候，我也被__get__,__getattribute__,__getattr__,__getitem__之間的區(qū)別困擾到了，它們都是和屬性訪問相關(guān)的魔術(shù)方法，其中重寫__getattr__，__getitem__來(lái)構(gòu)造一個(gè)自己的集合類非常的常用，下面我們就通過(guò)一些例子來(lái)看一下它們的應(yīng)用。
__getattr__
Python默認(rèn)訪問類/實(shí)例的某個(gè)屬性都是通過(guò)__getattribute__來(lái)調(diào)用的，__getattribute__會(huì)被無(wú)條件調(diào)用，沒有找到的話就會(huì)調(diào)用__getattr__。如果我們要定制某個(gè)類，通常情況下我們不應(yīng)該重寫__getattribute__，而是應(yīng)該重寫__getattr__，很少看見重寫__getattribute__的情況。
從下面的輸出可以看出，當(dāng)一個(gè)屬性通過(guò)__getattribute__無(wú)法找到的時(shí)候會(huì)調(diào)用__getattr__。
In[1]:classTest(object):
...:def__getattribute__(self,item):
...:print('call__getattribute__')
...:returnsuper(Test,self).__getattribute__(item)
...:def__getattr__(self,item):
...:return'call__getattr__'
...:
In[2]:Test().a
call__getattribute__
Out[2]:'call__getattr__'
應(yīng)用
對(duì)于默認(rèn)的字典，Python只支持以obj['foo']形式來(lái)訪問，不支持obj.foo的形式，我們可以通過(guò)重寫__getattr__讓字典也支持obj['foo']的訪問形式，這是一個(gè)非常經(jīng)典常用的用法：
classStorage(dict):
"""AStorageobjectislikeadictionaryexceptobj.foocanbeusedinadditiontoobj['foo']."""
def__getattr__(self,key):
try:
returnself[key]
exceptKeyErrorask:
raiseAttributeError(k)
def__setattr__(self,key,value):
self[key]=value
def__delattr__(self,key):
try:
delself[key]
exceptKeyErrorask:
raiseAttributeError(k)
def__repr__(self):
return''!
我們來(lái)使用一下我們自定義的加強(qiáng)版字典：
>>>s=Storage(a=1)
>>>s['a']
1
>>>s.a
1
>>>s.a=2
>>>s['a']
2
>>>dels.a
>>>s.a
...
AttributeError:'a'
__getitem__
getitem用于通過(guò)下標(biāo)[]的形式來(lái)獲取對(duì)象中的元素，下面我們通過(guò)重寫__getitem__來(lái)實(shí)現(xiàn)一個(gè)自己的list。
classMyList(object):
def__init__(self,*args):
self.numbers=args
def__getitem__(self,item):
returnself.numbers[item]
my_list=MyList(1,2,3,4,6,5,3)
printmy_list[2]
這個(gè)實(shí)現(xiàn)非常的簡(jiǎn)陋，不支持slice和step等功能，請(qǐng)讀者自行改進(jìn)，這里我就不重復(fù)了。
應(yīng)用
下面是參考requests庫(kù)中對(duì)于__getitem__的一個(gè)使用，我們定制了一個(gè)忽略屬性大小寫的字典類。
程序有些復(fù)雜，我稍微解釋一下：由于這里比較簡(jiǎn)單，沒有使用描述符的需求，所以使用了@property裝飾器來(lái)代替，lower_keys的功能是將實(shí)例字典中的鍵全部轉(zhuǎn)換成小寫并且存儲(chǔ)在字典self._lower_keys中。重寫了__getitem__方法，以后我們?cè)L問某個(gè)屬性首先會(huì)將鍵轉(zhuǎn)換為小寫的方式，然后并不會(huì)直接訪問實(shí)例字典，而是會(huì)訪問字典self._lower_keys去查找。賦值/刪除操作的時(shí)候由于實(shí)例字典會(huì)進(jìn)行變更，為了保持self._lower_keys和實(shí)例字典同步，首先清除self._lower_keys的內(nèi)容，以后我們重新查找鍵的時(shí)候再調(diào)用__getitem__的時(shí)候會(huì)重新新建一個(gè)self._lower_keys。
classCaseInsensitiveDict(dict):
@property
deflower_keys(self):
ifnothasattr(self,'_lower_keys')ornotself._lower_keys:
self._lower_keys=dict((k.lower(),k)forkinself.keys())
returnself._lower_keys
def_clear_lower_keys(self):
ifhasattr(self,'_lower_keys'):
self._lower_keys.clear()
def__contains__(self,key):
returnkey.lower()inself.lower_keys
def__getitem__(self,key):
ifkeyinself:
returndict.__getitem__(self,self.lower_keys[key.lower()])
def__setitem__(self,key,value):
dict.__setitem__(self,key,value)
self._clear_lower_keys()
def__delitem__(self,key):
dict.__delitem__(self,key)
self._lower_keys.clear()
defget(self,key,default=None):
ifkeyinself:
returnself[key]
else:
returndefault
我們來(lái)調(diào)用一下這個(gè)類：
>>>d=CaseInsensitiveDict()
>>>d['ziwenxie']='ziwenxie'
>>>d['ZiWenXie']='ZiWenXie'
>>>print(d)
{'ZiWenXie':'ziwenxie','ziwenxie':'ziwenxie'}
>>>print(d['ziwenxie'])
ziwenxie
#d['ZiWenXie']=>d['ziwenxie']
>>>print(d['ZiWenXie'])
ziwenxie
以上內(nèi)容為大家介紹了Python之描述符，希望對(duì)大家有所幫助，如果想要了解更多Python相關(guān)知識(shí)，請(qǐng)關(guān)注多測(cè)師。http://www.e7g2kmi.cn/xwzx/
京公網(wǎng)安備 11010802030320號(hào)