Python自省(反射)指南
http://www.cnblogs.com/huxi/archive/2011/01/02/1924317.html
有時候我們會碰到這樣的需求,需要執行對象的某個方法,或是需要對對象的某個字段賦值,而方法名或是字段名在編碼代碼時并不能確定,需要通過參數傳遞字符串的形式輸入。舉個具體的例子:當我們需要實現一個通用的DBM框架時,可能需要對數據對象的字段賦值,但我們無法預知用到這個框架的數據對象都有些什么字段,換言之,我們在寫框架的時候需要通過某種機制訪問未知的屬性。
這個機制被稱為反射(反過來讓對象告訴我們他是什么),或是自省(讓對象自己告訴我們他是什么,好吧我承認括號里是我瞎掰的- -#),用于實現在運行時獲取未知對象的信息。反射是個很嚇唬人的名詞,聽起來高深莫測,在一般的編程語言里反射相對其他概念來說稍顯復雜,一般來說都是作為高級主題來講;但在Python中反射非常簡單,用起來幾乎感覺不到與其他的代碼有區別,使用反射獲取到的函數和方法可以像平常一樣加上括號直接調用,獲取到類后可以直接構造實例;不過獲取到的字段不能直接賦值,因為拿到的其實是另一個指向同一個地方的引用,賦值只能改變當前的這個引用而已。
1. 訪問對象的屬性
以下列出了幾個內建方法,可以用來檢查或是訪問對象的屬性。這些方法可以用于任意對象而不僅僅是例子中的Cat實例對象;Python中一切都是對象。
- dir([obj]):?
調用這個方法將返回包含obj大多數屬性名的列表(會有一些特殊的屬性不包含在內)。obj的默認值是當前的模塊對象。 - hasattr(obj, attr):?
這個方法用于檢查obj是否有一個名為attr的值的屬性,返回一個布爾值。 - getattr(obj, attr):?
調用這個方法將返回obj中名為attr值的屬性的值,例如如果attr為'bar',則返回obj.bar。 - setattr(obj, attr, val):?
調用這個方法將給obj的名為attr的值的屬性賦值為val。例如如果attr為'bar',則相當于obj.bar = val。
2. 訪問對象的元數據
當你對一個你構造的對象使用dir()時,可能會發現列表中的很多屬性并不是你定義的。這些屬性一般保存了對象的元數據,比如類的__name__屬性保存了類名。大部分這些屬性都可以修改,不過改動它們意義并不是很大;修改其中某些屬性如function.func_code還可能導致很難發現的問題,所以改改name什么的就好了,其他的屬性不要在不了解后果的情況下修改。
接下來列出特定對象的一些特殊屬性。另外,Python的文檔中有提到部分屬性不一定會一直提供,下文中將以紅色的星號*標記,使用前你可以先打開解釋器確認一下。
2.0. 準備工作:確定對象的類型
在types模塊中定義了全部的Python內置類型,結合內置方法isinstance()就可以確定對象的具體類型了。
- isinstance(object, classinfo):?
檢查object是不是classinfo中列舉出的類型,返回布爾值。classinfo可以是一個具體的類型,也可以是多個類型的元組或列表。
types模塊中僅僅定義了類型,而inspect模塊中封裝了很多檢查類型的方法,比直接使用types模塊更為輕松,所以這里不給出關于types的更多介紹,如有需要可以直接查看types模塊的文檔說明。本文第3節中介紹了inspect模塊。
2.1. 模塊(module)
- __doc__: 文檔字符串。如果模塊沒有文檔,這個值是None。
- *__name__: 始終是定義時的模塊名;即使你使用import .. as 為它取了別名,或是賦值給了另一個變量名。
- *__dict__: 包含了模塊里可用的屬性名-屬性的字典;也就是可以使用模塊名.屬性名訪問的對象。
- __file__: 包含了該模塊的文件路徑。需要注意的是內建的模塊沒有這個屬性,訪問它會拋出異常!
| 1 2 3 4 5 | import?fnmatch as m print?m.__doc__.splitlines()[0] # Filename matching with shell patterns. print?m.__name__??????????????? # fnmatch print?m.__file__??????????????? # /usr/lib/python2.6/fnmatch.pyc print?m.__dict__.items()[0]???? # ('fnmatchcase', <function>)</function> |
2.2. 類(class)
- __doc__: 文檔字符串。如果類沒有文檔,這個值是None。
- *__name__: 始終是定義時的類名。
- *__dict__: 包含了類里可用的屬性名-屬性的字典;也就是可以使用類名.屬性名訪問的對象。
- __module__: 包含該類的定義的模塊名;需要注意,是字符串形式的模塊名而不是模塊對象。
- *__bases__: 直接父類對象的元組;但不包含繼承樹更上層的其他類,比如父類的父類。
| 1 2 3 4 5 | print?Cat.__doc__?????????? # None print?Cat.__name__????????? # Cat print?Cat.__module__??????? # __main__ print?Cat.__bases__???????? # (<type>,) print?Cat.__dict__????????? # {'__module__': '__main__', ...}</type> |
2.3. 實例(instance)
實例是指類實例化以后的對象。
- *__dict__: 包含了可用的屬性名-屬性字典。
- *__class__: 該實例的類對象。對于類Cat,cat.__class__ == Cat 為 True。
| 1 2 3 | print?cat.__dict__ print?cat.__class__ print?cat.__class__ ==?Cat # True |
2.4. 內建函數和方法(built-in functions and methods)
根據定義,內建的(built-in)模塊是指使用C寫的模塊,可以通過sys模塊的builtin_module_names字段查看都有哪些模塊是內建的。這些模塊中的函數和方法可以使用的屬性比較少,不過一般也不需要在代碼中查看它們的信息。
- __doc__: 函數或方法的文檔。
- __name__: 函數或方法定義時的名字。
- __self__: 僅方法可用,如果是綁定的(bound),則指向調用該方法的類(如果是類方法)或實例(如果是實例方法),否則為None。
- *__module__: 函數或方法所在的模塊名。
2.5. 函數(function)
這里特指非內建的函數。注意,在類中使用def定義的是方法,方法與函數雖然有相似的行為,但它們是不同的概念。
- __doc__: 函數的文檔;另外也可以用屬性名func_doc。
- __name__: 函數定義時的函數名;另外也可以用屬性名func_name。
- *__module__: 包含該函數定義的模塊名;同樣注意,是模塊名而不是模塊對象。
- *__dict__: 函數的可用屬性;另外也可以用屬性名func_dict。?
不要忘了函數也是對象,可以使用函數.屬性名訪問屬性(賦值時如果屬性不存在將新增一個),或使用內置函數has/get/setattr()訪問。不過,在函數中保存屬性的意義并不大。 - func_defaults: 這個屬性保存了函數的參數默認值元組;因為默認值總是靠后的參數才有,所以不使用字典的形式也是可以與參數對應上的。
- func_code: 這個屬性指向一個該函數對應的code對象,code對象中定義了其他的一些特殊屬性,將在下文中另外介紹。
- func_globals: 這個屬性指向定義函數時的全局命名空間。
- *func_closure: 這個屬性僅當函數是一個閉包時有效,指向一個保存了所引用到的外部函數的變量cell的元組,如果該函數不是一個內部函數,則始終為None。這個屬性也是只讀的。
下面的代碼演示了func_closure:
?| 1 2 3 4 5 6 7 8 9 10 11 12 | #coding: UTF-8 def?foo(): ????n =?1 ????def?bar(): ????????print?n # 引用非全局的外部變量n,構造一個閉包 ????n =?2 ????return?bar closure =?foo() print?closure.func_closure # 使用dir()得知cell對象有一個cell_contents屬性可以獲得值 print?closure.func_closure[0].cell_contents # 2 |
由這個例子可以看到,遇到未知的對象使用dir()是一個很好的主意 :)
2.6. 方法(method)
方法雖然不是函數,但可以理解為在函數外面加了一層外殼;拿到方法里實際的函數以后,就可以使用2.5節的屬性了。
- __doc__: 與函數相同。
- __name__: 與函數相同。
- *__module__: 與函數相同。
- im_func: 使用這個屬性可以拿到方法里實際的函數對象的引用。另外如果是2.6以上的版本,還可以使用屬性名__func__。
- im_self: 如果是綁定的(bound),則指向調用該方法的類(如果是類方法)或實例(如果是實例方法),否則為None。如果是2.6以上的版本,還可以使用屬性名__self__。
- im_class: 實際調用該方法的類,或實際調用該方法的實例的類。注意不是方法的定義所在的類,如果有繼承關系的話。
| 1 2 3 4 | im =?cat.sayHi print?im.im_func print?im.im_self # cat print?im.im_class # Cat |
這里討論的是一般的實例方法,另外還有兩種特殊的方法分別是類方法(classmethod)和靜態方法(staticmethod)。類方法還是方法,不過因為需要使用類名調用,所以他始終是綁定的;而靜態方法可以看成是在類的命名空間里的函數(需要使用類名調用的函數),它只能使用函數的屬性,不能使用方法的屬性。
總結
以上是生活随笔為你收集整理的Python自省(反射)指南的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: eclipse+pydev快捷键
- 下一篇: Python的global语句