Python自省（反射）指南

發表於2015-09-16

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

#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)

#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中反射非常簡單，用起來幾乎感覺不到與其他的程式碼有區別，使用反射獲取到的函式和方法可以像平常一樣加上括號直接呼叫，獲取到類後可以直接構造例項；不過獲取到的欄位不能直接賦值，因為拿到的其實是另一個指向同一個地方的引用，賦值只能改變當前的這個引用而已。

1. 訪問物件的屬性

以下列出了幾個內建方法，可以用來檢查或是訪問物件的屬性。這些方法可以用於任意物件而不僅僅是例子中的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()

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。

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__: 包含了該模組的檔案路徑。需要注意的是內建的模組沒有這個屬性，訪問它會丟擲異常！

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>

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__: 直接父類物件的元組；但不包含繼承樹更上層的其他類，比如父類的父類。

print Cat.__doc__           # None
print Cat.__name__          # Cat
print Cat.__module__        # __main__
print Cat.__bases__         # (<type>,)
print Cat.__dict__          # {'__module__': '__main__', ...}</type>

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。

print cat.__dict__
print cat.__class__
print cat.__class__ == Cat # True

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：

#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

#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: 實際呼叫該方法的類，或實際呼叫該方法的例項的類。注意不是方法的定義所在的類，如果有繼承關係的話。

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

im = cat.sayHi

print im.im_func

print im.im_self # cat

print im.im_class # Cat

這裡討論的是一般的例項方法，另外還有兩種特殊的方法分別是類方法(classmethod)和靜態方法(staticmethod)。類方法還是方法，不過因為需要使用類名呼叫，所以他始終是繫結的；而靜態方法可以看成是在類的名稱空間裡的函式（需要使用類名呼叫的函式），它只能使用函式的屬性，不能使用方法的屬性。

2.7. 生成器(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

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

接下來討論的是幾個不常用到的內建物件型別。這些型別在正常的編碼過程中應該很少接觸，除非你正在自己實現一個直譯器或開發環境之類。所以這裡只列出一部分屬性，如果需要一份完整的屬性表或想進一步瞭解，可以檢視文末列出的參考文件。

2.8. 程式碼塊(code)

程式碼塊可以由類原始碼、函式原始碼或是一個簡單的語句程式碼編譯得到。這裡我們只考慮它指代一個函式時的情況；2.5節中我們曾提到可以使用函式的func_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)。

co = cat.sayHi.func_code
print co.co_argcount        # 1
print co.co_names           # ('name',)
print co.co_varnames        # ('self',)
print co.co_flags & 0b100   # 0

co = cat.sayHi.func_code

print co.co_argcount # 1

print co.co_names # ('name',)

print co.co_varnames # ('self',)

print co.co_flags & 0b100 # 0

2.9. 棧幀(frame)

棧幀表示程式執行時函式呼叫棧中的某一幀。函式沒有屬性可以獲取它，因為它在函式呼叫時才會產生，而生成器則是由函式呼叫返回的，所以有屬性指向棧幀。想要獲得某個函式相關的棧幀，則必須在呼叫這個函式且這個函式尚未返回時獲取。你可以使用sys模組的_getframe()函式、或inspect模組的currentframe()函式獲取當前棧幀。這裡列出來的屬性全部是隻讀的。

f_back: 呼叫棧的前一幀。
f_code: 棧幀對應的code物件。
f_locals: 用在當前棧幀時與內建函式locals()相同，但你可以先獲取其他幀然後使用這個屬性獲取那個幀的locals()。
f_globals: 用在當前棧幀時與內建函式globals()相同，但你可以先獲取其他幀……。

def add(x, y=1):
    f = inspect.currentframe()
    print f.f_locals    # same as locals()
    print f.f_back      # <frame object at 0x...>
    return x+y
add(2)

def add(x, y=1):

f = inspect.currentframe()

print f.f_locals # same as locals()

print f.f_back # <frame object at 0x...>

return x+y

add(2)

2.10. 追蹤(traceback)

追蹤是在出現異常時用於回溯的物件，與棧幀相反。由於異常時才會構建，而異常未捕獲時會一直向外層棧幀丟擲，所以需要使用try才能見到這個物件。你可以使用sys模組的exc_info()函式獲得它，這個函式返回一個元組，元素分別是異常型別、異常物件、追蹤。traceback的屬性全部是隻讀的。

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

def div(x, y):
    try:
        return x/y
    except:
        tb = sys.exc_info()[2]  # return (exc_type, exc_value, traceback)
        print tb
        print tb.tb_lineno      # "return x/y" 的行號
div(1, 0)

def div(x, y):

try:

return x/y

except:

tb = sys.exc_info()[2] # return (exc_type, exc_value, traceback)

print tb

print tb.tb_lineno # "return x/y" 的行號

div(1, 0)

3. 使用inspect模組

inspect模組提供了一系列函式用於幫助使用自省。下面僅列出較常用的一些函式，想獲得全部的函式資料可以檢視inspect模組的文件。

3.1. 檢查物件型別

is{module|class|function|method|builtin}(obj):

檢查物件是否為模組、類、函式、方法、內建函式或方法。

isroutine(obj):

用於檢查物件是否為函式、方法、內建函式或方法等等可呼叫型別。用這個方法會比多個is*()更方便，不過它的實現仍然是用了多個is*()。

im = cat.sayHi
if inspect.isroutine(im):
    im()

im = cat.sayHi

if inspect.isroutine(im):

im()

對於實現了__call__的類例項，這個方法會返回False。如果目的是隻要可以直接呼叫就需要是True的話，不妨使用isinstance(obj, collections.Callable)這種形式。我也不知道為什麼Callable會在collections模組中，抱歉！我猜大概是因為collections模組中包含了很多其他的ABC(Abstract Base Class)的緣故吧：）

3.2. 獲取物件資訊

getmembers(object[, predicate]):

這個方法是dir()的擴充套件版，它會將dir()找到的名字對應的屬性一併返回，形如[(name, value), …]。另外，predicate是一個方法的引用，如果指定，則應當接受value作為引數並返回一個布林值，如果為False，相應的屬性將不會返回。使用is*作為第二個引數可以過濾出指定型別的屬性。

getmodule(object):

還在為第2節中的__module__屬性只返回字串而遺憾嗎？這個方法一定可以滿足你，它返回object的定義所在的模組物件。

get{file|sourcefile}(object):

獲取object的定義所在的模組的檔名|原始碼檔名（如果沒有則返回None）。用於內建的物件（內建模組、類、函式、方法）上時會丟擲TypeError異常。

get{source|sourcelines}(object):

獲取object的定義的原始碼，以字串|字串列表返回。程式碼無法訪問時會丟擲IOError異常。只能用於module/class/function/method/code/frame/traceack物件。

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,))

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)
#ArgInfo(args=['x', 'y'], varargs='z', keywords=None, locals={'y': 1, 'x': 2, 'z': ()})

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

print inspect.getargvalues(inspect.currentframe())

return x + y + sum(z)

add(2)

#ArgInfo(args=['x', 'y'], varargs='z', keywords=None, locals={'y': 1, 'x': 2, 'z': ()})

getcallargs(func[, *args][, **kwds]):

返回使用args和kwds呼叫該方法時各引數對應的值的字典。這個方法僅在2.7版本中才有。

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

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():

返回當前的棧幀物件。
其他的操作frame和traceback的函式請查閱inspect模組的文件，用的比較少，這裡就不多介紹了。

<全文完>

4.《python自省指南》學習
2018-11-10
Python
Python自省
2018-11-15
Python
Java 反射機制分析指南
2015-03-31
Java反射
Python的反射
2018-08-18
Python反射
Go中泛型和反射比較指南
2024-02-14
Go泛型反射
python 多型、組合、反射
2021-12-07
Python多型反射
一個欠缺太多的程式設計師自省
2013-03-04
程式設計師
【python學習筆記】Python反射機制
2017-09-20
Python筆記反射
剖析 Python 面試知識點（一）: 魔法方法、閉包/自省、裝飾器/生成器
2019-03-30
Python面試
Python物件導向之九：反射
2020-12-06
Python物件反射
python面試題~反射，元類，單例
2018-07-31
Python面試題反射單例
java反射——反射Annotation
2016-09-14
Java反射
Python教程：反射及常用的幾種方法
2024-05-21
Python反射
14 Python物件導向程式設計：反射
2024-09-06
Python物件程式設計反射
Go反射終極指南：從基礎到高階全方位解析
2023-10-18
Go反射
Python指南－－前言 (轉)
2007-08-17
Python
python學習 day018打卡反射
2018-11-09
Python反射
[轉載] python通過反射執行程式碼
2020-12-28
Python反射行程
Java反射—初探反射基礎
2019-01-24
Java反射
Java反射與反射優化
2017-12-13
Java反射優化
Python安全編碼指南
2020-08-19
Python
Python 列表操作指南1
2023-10-03
Python
Python 列表操作指南3
2023-10-04
Python
Python 的 Magic Methods 指南
2016-01-11
Python
Python 魔術方法指南
2016-05-05
Python
Python官方文件：Descriptor 指南
2015-12-10
Python
Python執行緒指南
2015-09-16
Python執行緒
Python 安全編碼指南
2015-11-14
Python
反射
2024-08-18
反射
2.1.2 Python物件導向之反射以及內建方法
2019-01-21
Python物件反射
一文了解Python反射機制（很詳細）
2024-10-12
Python反射
Python Logging 指南
2018-07-11
Python
[摘要]Python 最佳實踐指南
2015-12-08
Python
Python 效能分析入門指南
2014-07-25
Python
Python 編碼風格指南
2016-03-30
Python
Python指南－－開胃菜 (轉)
2007-08-16
Python
Python 字串格式化指南
2024-04-25
Python字串格式化
python--檔案操作指南
2024-04-15
Python

Python自省（反射）指南

相關文章