python 元數據和inspect

引言

首先經過一個例子來看一下本文中可能用到的對象和相關概念。

#coding: UTF-8
import sys #  模塊，sys指向這個模塊對象
import inspect

def foo(): pass # 函數，foo指向這個函數對象



class Cat(object): # 類，Cat指向這個類對象

    def __init__(self, name='kitty'):
        self.name = name

    def sayHi(self): #  實例方法，sayHi指向這個方法對象，使用類或實例.sayHi訪問
        print self.name, 'says Hi!' # 訪問名爲name的字段，使用實例.name訪問


cat = Cat() # cat是Cat類的實例對象

print Cat.sayHi # 使用類名訪問實例方法時，方法是未綁定的(unbound)
print cat.sayHi # 使用實例訪問實例方法時，方法是綁定的(bound)

有時候咱們會碰到這樣的需求，須要執行對象的某個方法，或是須要對對象的某個字段賦值，而方法名或是字段名在編碼代碼時並不能肯定，須要經過參數傳遞字符串的形式輸入。

舉個具體的例子：當咱們須要實現一個通用的DBM框架時，可能須要對數據對象的字段賦值，但咱們沒法預知用到這個框架的數據對象都有些什麼字段，換言之，咱們在寫框架的時候須要經過某種機制訪問未知的屬性。

這個機制被稱爲反射（反過來讓對象告訴咱們他是什麼），用於實現在運行時獲取未知對象的信息。反射是個很嚇唬人的名詞，聽起來高深莫測，在通常的編程語言裏反射相對其餘概念來講稍顯複雜，通常來講都是做爲高級主題來說；但在Python中反射很是簡單，用起來幾乎感受不到與其餘的代碼有區別，使用反射獲取到的函數和方法能夠像日常同樣加上括號直接調用，獲取到類後能夠直接構造實例；不過獲取到的字段不能直接賦值，由於拿到的實際上是另外一個指向同一個地方的引用，賦值只能改變當前的這個引用而已。

訪問對象的屬性

如下列出了幾個內建方法，能夠用來檢查或是訪問對象的屬性。這些方法能夠用於任意對象而不只僅是例子中的Cat實例對象；Python中一切都是對象。

cat = Cat('kitty')

print cat.name # 訪問實例屬性

cat.sayHi() # 調用實例方法

print dir(cat) # 獲取實例的屬性名，以列表形式返回

if hasattr(cat, 'name'): # 檢查實例是否有這個屬性
    setattr(cat, 'name', 'tiger') # same as: a.name = 'tiger'

print getattr(cat, 'name') # same as: print a.name
getattr(cat, 'sayHi')() # same as: cat.sayHi()

• 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。

訪問對象的元數據

對一個對象使用dir()時，可能會發現列表中的不少屬性並非類中定義的。這些屬性通常保存了對象的元數據，好比類的__name__屬性保存了類名。大部分這些屬性均可以修改，不過改動它們意義並非很大；修改其中某些屬性如function.func_code還可能致使很難發現的問題，因此改改name什麼的就行了，其餘的屬性不要在不瞭解後果的狀況下修改。

接下來列出特定對象的一些特殊屬性。另外，Python的文檔中有提到部分屬性不必定會一直提供，下文中將以斜體標記，使用前你能夠先打開解釋器確認一下。

準備工做：肯定對象的類型

在types模塊中定義了所有的Python內置類型，結合內置方法isinstance()就能夠肯定對象的具體類型了。

• isinstance(object, classinfo): 檢查object是否是classinfo中列舉出的類型，返回布爾值。classinfo能夠是一個具體的類型，也能夠是多個類型的元組或列表。

types模塊中僅僅定義了類型，而inspect模塊中封裝了不少檢查類型的方法，比直接使用types模塊更爲輕鬆，因此這裏不給出關於types的更多介紹，若有須要能夠直接查看types模塊的文檔說明。

模塊(module)

• __doc__: 文檔字符串。若是模塊沒有文檔，這個值是None。
• __name__: 始終是定義時的模塊名；即便你使用import .. as 爲它取了別名，或是賦值給了另外一個變量名。
• __dict__: 包含了模塊裏可用的屬性名-屬性的字典；也就是可使用模塊名.屬性名訪問的對象。
• __file__: 包含了該模塊的文件路徑。須要注意的是內建的模塊沒有這個屬性，訪問它會拋出異常！

import sys as s

__author__ = 'hgfdo'

print s.__doc__.splitlines()[0]
print s.__name__
print s.__dict__
print s.__file__.items()[0] # 此處因爲sys爲內建模塊，沒有__file__屬性

類(class)

• __doc__: 文檔字符串。若是類沒有文檔，這個值是None。
• __name__: 始終是定義時的類名。
• __dict__: 包含了類裏可用的屬性名-屬性的字典；也就是可使用類名.屬性名訪問的對象。
• __module__: 包含該類的定義的模塊名；須要注意，是字符串形式的模塊名而不是模塊對象。
• __bases__: 直接父類對象的元組；但不包含繼承樹更上層的其餘類，好比父類的父類。

print Cat.__bases__ # (<type 'object'>,)
print Cat.__dict__
print Cat.__doc__
print Cat.__module__    # __main__

實例(instance)

實例是指類實例化之後的對象。

• __dict__: 包含了可用的屬性名-屬性字典。
• __class__: 該實例的類對象。對於類Cat，cat.class == Cat 爲 True。

cat = Cat()
print cat.__class__ # <class '__main__.Cat'>

print cat.__dict__  # {'name': 'kitty'}

內建函數和方法(built-in functions and methods)

根據定義，內建的(built-in)模塊是指使用C寫的模塊，能夠經過sys模塊的builtin_module_names字段查看都有哪些模塊是內建的。這些模塊中的函數和方法可使用的屬性比較少，不過通常也不須要在代碼中查看它們的信息。

• __doc__: 函數或方法的文檔。
• __name__: 函數或方法定義時的名字。
• __self__: 僅方法可用，若是是綁定的(bound)，則指向調用該方法的類（若是是類方法）或實例（若是是實例方法），不然爲None。
• __module__: 函數或方法所在的模塊名。

函數(function)

這裏特指非內建的函數。注意，在類中使用def定義的是方法，方法與函數雖然有類似的行爲，但它們是不一樣的概念。

• __doc__: 函數的文檔；另外也能夠用屬性名func_doc。
• __name__: 函數定義時的函數名；另外也能夠用屬性名func_name。
• __module__: 包含該函數定義的模塊名；一樣注意，是模塊名而不是模塊對象。
• __dict__: 函數的可用屬性；另外也能夠用屬性名func_dict。 不要忘了函數也是對象，可使用函數.屬性名訪問屬性（賦值時若是屬性不存在將新增一個），或使用內置函數has/get/setattr()訪問。不過，在函數中保存屬性的意義並不大。
• func_defaults/__defaults__: 這個屬性保存了函數的參數默認值元組；由於默認值老是靠後的參數纔有，因此不使用字典的形式也是能夠與參數對應上的。
• func_code/__code__: 這個屬性指向一個該函數對應的code對象，code對象中定義了其餘的一些特殊屬性，將在下文中另外介紹。
• func_globals/__globals__: 這個屬性指向定義函數時的全局命名空間。
• func_closure/__closure__: 這個屬性僅當函數是一個閉包時有效，指向一個保存了所引用到的外部函數的變量cell的元組，若是該函數不是一個內部函數，則始終爲None。這個屬性也是隻讀的。

==閉包==:是引用了自由變量的函數,根據自由變量不一樣的值獲得不一樣的結果。這個被引用的自由變量將和這個函數一同存在，即便已經離開了創造它的環境也不例外。因此，有另外一種說法認爲閉包是由函數和與其相關的引用環境組合而成的實體。裝飾器就是一種閉包行爲，裝飾器的概念:對函數(參數,返回值等)進行加工處理,生成一個功能加強版的一個函數。，例如：

def makebold(fn):
   def wrapped():
       return "<b>" + fn() + "</b>"
   return wrapped

@makebold
def hello():
   return "hello world"

print hello()

運行結果：<b>hello world</b>

下面的代碼演示了func_closure：

# 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

結果：

(<cell at 0x02456AF0: int object at 0x023C774C>,)
2

方法(method)

方法雖然不是函數，但能夠理解爲在函數外面加了一層外殼；拿到方法裏實際的函數之後，就可使用上面提到的函數的屬性了。

• __doc__: 與函數相同。
• __name__: 與函數相同。
• *__module__: 與函數相同。
• im_func: 使用這個屬性能夠拿到方法裏實際的函數對象的引用。另外若是是2.6以上的版本，還可使用屬性名__func__。
• im_self: 若是是綁定的(bound)，則指向調用該方法的類（若是是類方法）或實例（若是是實例方法），不然爲None。若是是2.6以上的版本，還可使用屬性名__self__。
• im_class: 實際調用該方法的類，或實際調用該方法的實例的類。注意不是方法的定義所在的類，若是有繼承關係的話。

im = cat.sayHi
print im.im_func
print im.im_self # cat
print im.im_class # Cat

==說明==：有兩種特殊的方法分別是類方法(classmethod)和靜態方法(staticmethod)。

• 類方法仍是方法，不過由於須要使用類名調用，因此他始終是綁定的
• 靜態方法能夠當作是在類的命名空間裏的函數（須要使用類名調用的函數），它只能使用函數的屬性，不能使用方法的屬性。

生成器(generator)

生成器是調用一個生成器函數(generator function)返回的對象，多用於集合對象的迭代。

• __iter__: 僅僅是一個可迭代的標記。
• gi_code: 生成器對應的code對象。
• gi_frame: 生成器對應的frame對象。
• gi_running: 生成器函數是否在執行。生成器函數在yield之後、執行yield的下一行代碼前處於frozen狀態，此時這個屬性的值爲0。
• next|close|send|throw: 這是幾個可調用的方法，並不包含元數據信息，如何使用能夠查看生成器的相關文檔。

def gen():
    for n in xrange(5):
        yield n

g = gen()
print g             # <generator object gen at 0x...>
print g.gi_code     # <code object gen at 0x...>
print g.gi_frame    # <frame object at 0x...>
print g.gi_running  # 0
print g.next()      # 0
print g.next()      # 1
for n in g:
    print n,        # 2 3 4

代碼塊(code)

代碼塊能夠由類源代碼、函數源代碼或是一個簡單的語句代碼編譯獲得。這裏咱們以一個函數爲例；可使用函數的func_code或__code__屬性獲取到它。code的屬性所有是隻讀的。

• co_argcount: 普通參數的總數，不包括*參數和**參數。
• co_names: 全部的參數名（包括*參數和**參數）和局部變量名的元組。
• co_varnames: 全部的局部變量名的元組。
• co_filename: 源代碼所在的文件名。
• co_flags: 這是一個數值，每個二進制位都包含了特定信息。較關注的是0b100(0x4)和0b1000(0x8)，若是co_flags & 0b100 != 0，說明使用了*args參數；若是co_flags & 0b1000 != 0，說明使用了**kwargs參數。另外，若是co_flags & 0b100000(0x20) != 0，則說明這是一個生成器函數(generator function)。

棧幀(frame)

棧幀表示程序運行時函數調用棧中的某一幀。函數沒有屬性能夠獲取它，由於它在函數調用時纔會產生，而生成器則是由函數調用返回的，因此有屬性指向棧幀。想要得到某個函數相關的棧幀，則必須在調用這個函數且這個函數還沒有返回時獲取。你可使用sys模塊的_getframe()函數、或inspect模塊的currentframe()函數獲取當前棧幀。這裏列出來的屬性++所有是隻讀++的。

• f_back: 調用棧的前一幀。
• f_code: 棧幀對應的code對象。
• f_locals: 用在當前棧幀時與內建函數locals()相同，但你能夠先獲取其餘幀而後使用這個屬性獲取那個幀的locals()。
• f_globals: 用在當前棧幀時與內建函數globals()相同。

追蹤(traceback)

追蹤是在出現異常時用於回溯的對象，與棧幀相反。因爲異常時纔會構建，而異常未捕獲時會一直向外層棧幀拋出，因此須要使用try才能見到這個對象。你可使用sys模塊的exc_info()函數得到它，這個函數返回一個元組，元素分別是異常類型、異常對象、追蹤。traceback的屬性所有是隻讀的。

• tb_next: 追蹤的下一個追蹤對象。
• tb_frame: 當前追蹤對應的棧幀。
• tb_lineno: 當前追蹤的行號。

inspect模塊

檢查對象類型

• is{module|class|function|method|builtin}(obj): 檢查對象是否爲模塊、類、函數、方法、內建函數或方法。
• isroutine(obj): 用於檢查對象是否爲函數、方法、內建函數或方法等等可調用類型。用這個方法會比多個is*()更方便，不過它的實現仍然是用了多個is*()。

i = cat.sayHi
if isroutine(i):
    i()     # 打印 kitty say Hi!

對於實現了__call__的類實例，這個方法會返回False。若是目的是隻要能夠直接調用就須要是True的話，不妨使用isinstance(obj, collections.Callable)這種形式。

獲取對象信息

• getmembers(object[, predicate]): 這個方法是dir()的擴展版，它會將dir()找到的名字對應的屬性一併返回，形如[(name, value), ...]。另外，predicate是一個方法的引用，若是指定，則應當接受value做爲參數並返回一個布爾值，若是爲False，相應的屬性將不會返回。使用is*做爲第二個參數能夠過濾出指定類型的屬性。
• getmodule(object): 它返回object的定義所在的模塊對象(__module__屬性只返回字符串)。
• get{file|sourcefile}(object): 獲取object的定義所在的模塊的文件名|源代碼文件名（若是沒有則返回None）。用於內建的對象（內建模塊、類、函數、方法）上時會拋出TypeError異常。
• get{source|sourcelines}(object): 獲取object的定義的源代碼，以字符串|字符串列表返回。代碼沒法訪問時會拋出IOError異常。只能用於module/class/function/method/code/frame/traceack對象。 其中getsource()返回的是人能識別的與編寫代碼一致的字符串；getsourcelines()返回的是帶縮進的字符串列表，列表的每一項是一個行。
• getargspec(func): 僅用於方法，獲取方法聲明的參數，返回元組，分別是(普通參數名的列表, *參數名, **參數名, 默認值元組)。若是沒有值，將是空列表和3個None。若是是2.6以上版本，將返回一個命名元組(Named Tuple)，即除了索引外還可使用屬性名訪問元組中的元素。

def add(x, y=1, *z):
    return x + y + sum(z)

print inspect.getargspec(add) # ArgSpec(args=['x', 'y'], varargs='z', keywords=None, defaults=(1,))

• getargvalues(frame): 僅用於棧幀，獲取棧幀中保存的該次函數調用的參數值，返回元組，分別是(普通參數名的列表, *參數名, **參數名, 幀的locals())。若是是2.6以上版本，將返回一個命名元組(Named Tuple)，即除了索引外還可使用屬性名訪問元組中的元素。

def add(x, y=1, *z):
    print inspect.getargvalues(inspect.currentframe())
    return x + y + sum(z)

add(2) # ArgSpec(args=['x', 'y'], varargs='z', keywords=None, defaults=(1,))

• getcallargs(func[, *args][, **kwds]): 返回使用args和kwds調用該方法時各參數對應的值的字典。這個方法僅在2.7版本中才有。

def add(x, y=1, *z):
    return x + y + sum(z)

print inspect.getcallargs(add,(2,)) # {'y': 1, 'x': (2,), 'z': ()}

• getmro(cls): 返回一個類型元組，查找類屬性時按照這個元組中的順序。若是是新式類，與cls.__mro__結果同樣。但舊式類沒有__mro__這個屬性，直接使用這個屬性會報異常，因此這個方法仍是有它的價值的。

print inspect.getmro(Cat) #(<class '__main__.Cat'>, <type 'object'>)

print Cat.__mro__
#(<class '__main__.Cat'>, <type 'object'>)


class Dog: pass

print inspect.getmro(Dog)
#(<class __main__.Dog at 0x...>,)

print Dog.__mro__ # AttributeError

• currentframe(): 返回當前的棧幀對象。