Python descriptor-描述符

最近看Flask源碼時(shí)發(fā)現(xiàn)很多不熟悉的語(yǔ)法舱权,其中一個(gè)就是描述符镐确,在config.py中出現(xiàn),描述符的用處很多譬圣,是Python中很多特性的底層機(jī)制,如properties, methods, static methods, class methodssuper()雄坪。

什么是描述符

描述符一般是一個(gè)有綁定動(dòng)作的屬性對(duì)象厘熟,這個(gè)屬性的獲取、賦值维哈、刪除操作和途徑被描述符協(xié)議重寫绳姨。對(duì)象屬性的正常獲取順序是這樣的,比如想要獲取a.x,那么首先查找a.__dict__['x'],如果找不到則查看type(a).__dict__['x'],如果還沒有則查看父類的__dict__阔挠。

Python中有很多協(xié)議飘庄,比如迭代對(duì)象的迭代器協(xié)議,上下文管理協(xié)議等购撼,都是靠重寫類中以__開頭和結(jié)尾的魔法方法來(lái)實(shí)現(xiàn)的跪削。描述符協(xié)議也不例外,只要實(shí)現(xiàn)了__get__(self, instance, owner)迂求、__set__(self, instance, value)碾盐、__delete__(self, instance)中任意一個(gè)或全部的方法,這個(gè)類就變成了一個(gè)描述符揩局。如果只定義了__get__,則這是一個(gè)non-data descriptor毫玖,定義了__get____set__兩個(gè)方法的是data descriptor,這里的區(qū)別,后面會(huì)提到付枫。實(shí)現(xiàn)這些方法后烹玉,對(duì)屬性進(jìn)行操作時(shí)就不走正常途徑,而是調(diào)用這幾個(gè)魔法方法励背。需要注意的是春霍,描述符必須是一個(gè)新式類。

為什么需要描述符

寫過(guò)的Java的應(yīng)該有一些印象叶眉,類里的屬性一般是private的,如果想要拿到這個(gè)屬性芹枷,一般是通過(guò)一個(gè)publicget_xxx方法來(lái)獲得屬性衅疙,重新賦值時(shí)也是一個(gè)道理。但是這樣雖然隱藏了屬性鸳慈,但是后續(xù)寫代碼時(shí)都得用object.get_xxx()來(lái)獲取值饱溢,而不是object.attr,顯然第二種方式更簡(jiǎn)單,更美觀走芋,所以Python這種簡(jiǎn)潔的語(yǔ)言就提供了這樣的更簡(jiǎn)潔的實(shí)現(xiàn)方式---描述符協(xié)議绩郎。

還有一種情況,假設(shè)有一個(gè)Person類翁逞,它有一個(gè)age屬性肋杖,那么在對(duì)年齡賦值時(shí)是有一些限制的,比如必須是整數(shù)挖函,必須大于0状植。所以應(yīng)該在賦值時(shí)進(jìn)行檢查,這么一看好像賦值時(shí)又需要通過(guò)方法xiaoming.age=cls.examine_age(1000),又不美觀了怨喘,而描述符協(xié)議可以在背地里幫我們做這種檢查津畸,而我們還是可以使用xiaoming.age=1000這個(gè)更簡(jiǎn)潔的語(yǔ)句。

這里有個(gè)我之前一直困惑的地方提一下必怜,可能你們覺得不難肉拓,但是確實(shí)干擾了我很久。那就是這三個(gè)魔法方法定義在什么地方梳庆,還是回到上面那個(gè)例子暖途,好像只有Person是一個(gè)類,所以我之前一直覺得應(yīng)該定義在Person類中靠益,但其實(shí)不是丧肴。魔法方法應(yīng)該定義在一個(gè)Age類中,然后age屬性是一個(gè)Age對(duì)象實(shí)例胧后。

class Age(object):
    def __init__(self, age):
        self.age = age

    def __get__(self, instance, owner):
        print('instance={}, owner={}'.format(instance, owner))
        return self.age

    def __set__(self, instance, value):
        print('instance={}, value={}'.format(instance, value))
        if value < 0:
            raise AttributeError('age should > 0')
        self.age = value


class Person(object):
    age = Age(100)


xiaoming = Person()
xiaoming.age = 10
print(xiaoming)
print(xiaoming.age)

# output::::::::
# >>> instance=<__main__.Person object at 0x107a24310>, value=10
# >>> <__main__.Person object at 0x107a24310>
# >>> instance=<__main__.Person object at 0x107a24310>, owner=<class '__main__.Person'>
# >>> 10

方法中的instance屬性返回的是獲取屬性的那個(gè)對(duì)象芋浮,在這里就是xiaomingowner是獲取屬性的對(duì)象的類,在這里就是Person纸巷。

描述符的調(diào)用機(jī)制

上面提到了非描述符屬性的獲取途徑镇草,定義了描述符協(xié)議后,obj.b的操作將調(diào)用b.__get__(obj)這個(gè)方法來(lái)獲取屬性瘤旨。描述符的調(diào)用機(jī)制根據(jù)調(diào)用對(duì)象是對(duì)象還是有一些區(qū)別梯啤。

描述符是通過(guò)type.__getattribute__()方法被調(diào)用,這也是為什么描述符必須是在新式類中的原因存哲,繼承自object的類被稱為新式類因宇,否則沒有這個(gè)方法,則無(wú)法調(diào)用描述符的方法祟偷。

對(duì)于對(duì)象來(lái)說(shuō)察滑,object.__getattribute__()會(huì)將b.x 轉(zhuǎn)換為 type(b).__dict__['x'].__get__(b, type(b))。這個(gè)轉(zhuǎn)換通過(guò)下面這樣的一個(gè)優(yōu)先鏈:data descriptors大于實(shí)例變量修肠,實(shí)例變量大于 non-data descriptors贺辰,如果存在__getattr__(),則__getattr__()優(yōu)先級(jí)最低嵌施。完整的C實(shí)現(xiàn)在PyObject_GenericGetAttr() in Objects/object.c.

對(duì)于類來(lái)說(shuō)饲化,object.__getattribute__()會(huì)將 B.x 轉(zhuǎn)換為B.__dict__['x'].__get__(None, B)。Python實(shí)現(xiàn)如下:

def __getattribute__(self, key):
    "Emulate type_getattro() in Objects/typeobject.c"
    v = object.__getattribute__(self, key)
    if hasattr(v, '__get__'):
        return v.__get__(None, self)
    return v

描述符實(shí)例

上面提到了一個(gè)最簡(jiǎn)單的描述符實(shí)例吗伤,就是對(duì)屬性進(jìn)行取值或者賦值時(shí)進(jìn)行額外的操作吃靠,同時(shí)保持代碼的簡(jiǎn)潔。描述符在Python語(yǔ)言中本來(lái)也有很多的應(yīng)用牲芋,但是能力不夠撩笆,不能很好的理解其中的奧妙,就不誤導(dǎo)大家了缸浦。主要是Property,Function and methodstatic method and class method這幾個(gè)方面夕冲,給出鏈接,有興趣的可以鉆研一下裂逐。

參考鏈接

Python Descriptors, Part 1 of 2

Descriptor HowTo Guide

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末歹鱼,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子卜高,更是在濱河造成了極大的恐慌弥姻,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,214評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件掺涛,死亡現(xiàn)場(chǎng)離奇詭異庭敦,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)薪缆,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,307評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門秧廉,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人,你說(shuō)我怎么就攤上這事疼电〗莱” “怎么了?”我有些...
    開封第一講書人閱讀 152,543評(píng)論 0 341
  • 文/不壞的土叔 我叫張陵蔽豺,是天一觀的道長(zhǎng)区丑。 經(jīng)常有香客問我,道長(zhǎng)修陡,這世上最難降的妖魔是什么沧侥? 我笑而不...
    開封第一講書人閱讀 55,221評(píng)論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮魄鸦,結(jié)果婚禮上正什,老公的妹妹穿的比我還像新娘。我一直安慰自己号杏,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,224評(píng)論 5 371
  • 文/花漫 我一把揭開白布斯棒。 她就那樣靜靜地躺著盾致,像睡著了一般。 火紅的嫁衣襯著肌膚如雪荣暮。 梳的紋絲不亂的頭發(fā)上庭惜,一...
    開封第一講書人閱讀 49,007評(píng)論 1 284
  • 那天,我揣著相機(jī)與錄音穗酥,去河邊找鬼护赊。 笑死,一個(gè)胖子當(dāng)著我的面吹牛砾跃,可吹牛的內(nèi)容都是我干的骏啰。 我是一名探鬼主播,決...
    沈念sama閱讀 38,313評(píng)論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼抽高,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼判耕!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起翘骂,我...
    開封第一講書人閱讀 36,956評(píng)論 0 259
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤壁熄,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后碳竟,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體草丧,經(jīng)...
    沈念sama閱讀 43,441評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,925評(píng)論 2 323
  • 正文 我和宋清朗相戀三年莹桅,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了昌执。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,018評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖仙蚜,靈堂內(nèi)的尸體忽然破棺而出此洲,到底是詐尸還是另有隱情,我是刑警寧澤委粉,帶...
    沈念sama閱讀 33,685評(píng)論 4 322
  • 正文 年R本政府宣布呜师,位于F島的核電站,受9級(jí)特大地震影響贾节,放射性物質(zhì)發(fā)生泄漏汁汗。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,234評(píng)論 3 307
  • 文/蒙蒙 一栗涂、第九天 我趴在偏房一處隱蔽的房頂上張望知牌。 院中可真熱鬧,春花似錦斤程、人聲如沸角寸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,240評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)扁藕。三九已至,卻和暖如春疚脐,著一層夾襖步出監(jiān)牢的瞬間亿柑,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,464評(píng)論 1 261
  • 我被黑心中介騙來(lái)泰國(guó)打工棍弄, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留望薄,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 45,467評(píng)論 2 352
  • 正文 我出身青樓呼畸,卻偏偏與公主長(zhǎng)得像痕支,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子役耕,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,762評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容