Python 中的屬性訪問與描述符

發表於2017-09-10

在Python中,對於一個物件的屬性訪問,我們一般採用的是點(.)屬性運算子進行操作。例如,有一個類例項物件foo,它有一個name屬性,那便可以使用foo.name對此屬性進行訪問。一般而言,點(.)屬性運算子比較直觀,也是我們經常碰到的一種屬性訪問方式。然而,在點(.)屬性運算子的背後卻是別有洞天,值得我們對物件的屬性訪問進行探討。

在進行物件屬性訪問的分析之前,我們需要先了解一下物件怎麼表示其屬性。為了便於說明,本文以新式類為例。有關新式類和舊式類的區別,大家可以檢視Python官方文件。

物件的屬性

Python中,“一切皆物件”。我們可以給物件設定各種屬性。先來看一個簡單的例子:

上面的例子中,我們定義了兩個類。類Animal定義了一個屬性run;類Dog繼承自Animal,定義了一個屬性fly和兩個函式。接下來,我們例項化一個物件。物件的屬性可以從特殊屬性__dict__中檢視。

由上面的例子可以看出:屬性在哪個物件上定義,便會出現在哪個物件的__dict__中。例如:

  • Animal定義了一個屬性run,那這個run屬性便只會出現在類Animal__dict__中,而不會出現在其子類中。
  • Dog定義了一個屬性fly和兩個函式,那這些屬性和方法便會出現在類Dog__dict__中,同時它們也不會出現在例項的__dict__中。
  • 例項物件dog__dict__中只出現了一個屬性age,這是在初始化例項物件的時候新增的,它沒有父類的屬性和方法。
  • 由此可知:Python中物件的屬性具有 “層次性”,屬性在哪個物件上定義,便會出現在哪個物件的__dict__中。

在這裡我們首先了解的是屬性值會儲存在物件的__dict__中,查詢也會在物件的__dict__中進行查詢的。至於Python物件進行屬性訪問時,會按照怎樣的規則來查詢屬性值呢?這個問題在後文中進行討論。

物件屬性訪問與特殊方法__getattribute__

正如前面所述,Python的屬性訪問方式很直觀,使用點屬性運算子。在新式類中,對物件屬性的訪問,都會呼叫特殊方法__getattribute____getattribute__允許我們在訪問物件屬性時自定義訪問行為,但是使用它特別要小心無限遞迴的問題。

還是以上面的情景為例:

上面的例子中我們重寫了__getattribute__方法。注意我們使用了super()方法來避免無限迴圈問題。下面我們例項化一個物件來說明訪問物件屬性時__getattribute__的特性。

由上面的驗證可知,__getattribute__是例項物件查詢屬性或方法的入口。例項物件訪問屬性或方法時都需要呼叫到__getattribute__,之後才會根據一定的規則在各個__dict__中查詢相應的屬性值或方法物件,若沒有找到則會呼叫__getattr__(後面會介紹到)。__getattribute__是Python中的一個內建方法,關於其底層實現可以檢視相關官方文件,後面將要介紹的屬性訪問規則就是依賴於__getattribute__的。

物件屬性控制

在繼續介紹後面相關內容之前,讓我們先來了解一下Python中和物件屬性控制相關的相關方法。

  • __getattr__(self, name)__getattr__可以用來在當使用者試圖訪問一個根本不存在(或者暫時不存在)的屬性時,來定義類的行為。前面講到過,當__getattribute__方法找不到屬性時,最終會呼叫__getattr__方法。它可以用於捕捉錯誤的以及靈活地處理AttributeError。只有當試圖訪問不存在的屬性時它才會被呼叫。
  • __setattr__(self, name, value)__setattr__方法允許你自定義某個屬性的賦值行為,不管這個屬性存在與否,都可以對任意屬性的任何變化都定義自己的規則。關於__setattr__有兩點需要說明:第一,使用它時必須小心,不能寫成類似self.name = “Tom”這樣的形式,因為這樣的賦值語句會呼叫__setattr__方法,這樣會讓其陷入無限遞迴;第二,你必須區分 物件屬性類屬性 這兩個概念。後面的例子中會對此進行解釋。
  • __delattr__(self, name)__delattr__用於處理刪除屬性時的行為。和__setattr__方法要注意無限遞迴的問題,重寫該方法時不要有類似del self.name的寫法。

還是以上面的例子進行說明,不過在這裡我們要重寫三個屬性控制方法。

以下進行驗證。首先是__getattr__:

可以看到,屬性訪問時,當訪問一個不存在的屬性時觸發__getattr__,它會對訪問行為進行控制。接下來是__setattr__

例項物件的__setattr__方法可以定義屬性的賦值行為,不管屬性是否存在。當屬性存在時,它會改變其值;當屬性不存在時,它會新增一個物件屬性資訊到物件的__dict__中,然而這並不改變類的屬性。從上面的例子可以看出來。

最後,看一下__delattr__

描述符

描述符是Python 2.2 版本中引進來的新概念。描述符一般用於實現物件系統的底層功能, 包括繫結和非繫結方法、類方法、靜態方法特特性等。關於描述符的概念,官方並沒有明確的定義,可以在網上查閱相關資料。這裡我從自己的認識談一些想法,如有不當之處還請包涵。

在前面我們瞭解了物件屬性訪問和行為控制的一些特殊方法,例如__getattribute____getattr____setattr____delattr__。以我的理解來看,這些方法應當具有屬性的”普適性”,可以用於屬性查詢、設定、刪除的一般方法,也就是說所有的屬性都可以使用這些方法實現屬性的查詢、設定、刪除等操作。但是,這並不能很好地實現對某個具體屬性的訪問控制行為。例如,上例中假如要實現dog.age屬性的型別設定(只能是整數),如果單單去修改__setattr__方法滿足它,那這個方法便有可能不能支援其他的屬性設定。

在類中設定屬性的控制行為不能很好地解決問題,Python給出的方案是:__getattribute____getattr____setattr____delattr__等方法用來實現屬性查詢、設定、刪除的一般邏輯,而對屬性的控制行為就由屬性物件來控制。這裡單獨抽離出來一個屬性物件,在屬性物件中定義這個屬性的查詢、設定、刪除行為。這個屬性物件就是描述符。

描述符物件一般是作為其他類物件的屬性而存在。在其內部定義了三個方法用來實現屬性物件的查詢、設定、刪除行為。這三個方法分別是:

  • get(self, instance, owner):定義當試圖取出描述符的值時的行為。
  • set(self, instance, value):定義當描述符的值改變時的行為。
  • delete(self, instance):定義當描述符的值被刪除時的行為。

其中:instance為把描述符物件作為屬性的物件例項;
owner為instance的類物件。

以下以官方的一個例子進行說明:

以上定義了兩個類。其中RevealAccess類的例項是作為MyClass類屬性x的值存在的。而且RevealAccess類定義了__get____set__方法,它是一個描述符物件。注意,描述符物件的__get____set__方法中使用了諸如self.valself.val = val等語句,這些語句會呼叫__getattribute____setattr__等方法,這也說明了__getattribute____setattr__等方法在控制訪問物件屬性上的一般性(一般性是指對於所有屬性它們的控制行為一致),以及__get____set__等方法在控制訪問物件屬性上的特殊性(特殊性是指它針對某個特定屬性可以定義不同的行為)。

以下進行驗證:

上面的例子對描述符進行了一定的解釋,不過對描述符還需要更進一步的探討和分析,這個工作先留待以後繼續進行。

最後,還需要注意一點:描述符有資料描述符和非資料描述符之分。

  • 只要至少實現__get____set____delete__方法中的一個就可以認為是描述符;
  • 只實現__get__方法的物件是非資料描述符,意味著在初始化之後它們只能被讀取;
  • 同時實現__get____set__的物件是資料描述符,意味著這種屬性是可讀寫的。

屬性訪問的優先規則

在以上的討論中,我們一直迴避著一個問題,那就是屬性訪問時的優先規則。我們瞭解到,屬性一般都在__dict__中儲存,但是在訪問屬性時,在物件屬性、類屬型、基類屬性中以怎樣的規則來查詢屬性呢?以下對Python中屬性訪問的規則進行分析。

由上述的分析可知,屬性訪問的入口點是__getattribute__方法。它的實現中定義了Python中屬性訪問的優先規則。Python官方文件中對__getattribute__的底層實現有相關的介紹,本文暫時只是討論屬性查詢的規則,相關規則可見下圖:

Python屬性查詢

上圖是查詢b.x這樣一個屬性的過程。在這裡要對此圖進行簡單的介紹:

  1. 查詢屬性的第一步是搜尋基類列表,即type(b).__mro__,直到找到該屬性的第一個定義,並將該屬性的值賦值給descr
  2. 判斷descr的型別。它的型別可分為資料描述符、非資料描述符、普通屬性、未找到等型別。若descr為資料描述符,則呼叫desc.__get__(b, type(b)),並將結果返回,結束執行。否則進行下一步;
  3. 如果descr為非資料描述符、普通屬性、未找到等型別,則查詢例項b的例項屬性,即b.__dict__。如果找到,則將結果返回,結束執行。否則進行下一步;
  4. 如果在b.__dict__未找到相關屬性,則重新回到descr值的判斷上。
    • descr為非資料描述符,則呼叫desc.__get__(b, type(b)),並將結果返回,結束執行;
    • descr為普通屬性,直接返回結果並結束執行;
    • descr為空(未找到),則最終丟擲 AttributeError 異常,結束查詢。

相關文章