Python反射機制
轉載自：http://www.cnblogs.com/feixuelove1009/p/5576206.html
對程式語言比較熟悉的朋友，應該知道“反射”這個機制。Python作為一門動態語言，當然不會缺少這一重要功能。然而，在網路上卻很少見到有詳細或者深刻的剖析論文。下面結合一個web路由的例項來闡述python的反射機制的使用場景和核心本質。
一、前言
| 1 2 3 4 5 |
def
f1():
print
(
"f1是這個函式的名字！"
)
s
=
"f1"
print(
"%s是個字串"
%
s)
|
在上面的程式碼中，我們必須區分兩個概念，f1和“f1"。前者是函式f1的函式名，後者只是一個叫”f1“的字串，兩者是不同的事物。我們可以用f1()的方式呼叫函式f1，但我們不能用"f1"()的方式呼叫函式。說白了就是，不能通過字串來呼叫名字看起來相同的函式！
二、web例項
考慮有這麼一個場景，根據使用者輸入的url的不同，呼叫不同的函式，實現不同的操作，也就是一個url路由器的功能，這在web框架裡是核心部件之一。下面有一個精簡版的示例：
首先，有一個commons模組，它裡面有幾個函式，分別用於展示不同的頁面，程式碼如下：
| 1 2 3 4 5 6 7 8 9 10 |
def
login():
print
(
"這是一個登陸頁面！"
)
def
logout():
print
(
"這是一個退出頁面！"
)
def
home():
print
(
"這是網站主頁面！"
)
|
其次，有一個visit模組，作為程式入口，接受使用者輸入，展示相應的頁面，程式碼如下：（這段程式碼是比較初級的寫法）
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
import
commons
def
run():
inp
=
input
(
"請輸入您想訪問頁面的url： "
).strip()
if
inp
=
=
"login"
:
commons.login()
elif
inp
=
=
"logout"
:
commons.logout()
elif
inp
=
=
"home"
:
commons.home()
else
:
print
(
"404"
)
if
__name__
=
=
'__main__'
:
run()
|
我們執行visit.py，輸入：home，頁面結果如下：
| 1 2 |
請輸入您想訪問頁面的url： home
這是網站主頁面！
|
這就實現了一個簡單的WEB路由功能，根據不同的url，執行不同的函式，獲得不同的頁面。
然而，讓我們考慮一個問題，如果commons模組裡有成百上千個函式呢(這非常正常)?。難道你在visit模組裡寫上成百上千個elif?顯然這是不可能的！那麼怎麼破？
三、反射機制
仔細觀察visit中的程式碼，我們會發現使用者輸入的url字串和相應呼叫的函式名好像！如果能用這個字串直接呼叫函式就好了！但是，前面我們已經說了字串是不能用來呼叫函式的。為了解決這個問題，python為我們提供一個強大的內建函式：getattr!我們將前面的visit修改一下，程式碼如下：
| 1 2 3 4 5 6 7 8 9 10 11 |
import
commons
def
run():
inp
=
input
(
"請輸入您想訪問頁面的url： "
).strip()
func
=
getattr
(commons,inp)
func()
if
__name__
=
=
'__main__'
:
run()
|
首先說明一下getattr函式的使用方法：它接收2個引數，前面的是一個物件或者模組，後面的是一個字串，注意了！是個字串！
例子中，使用者輸入儲存在inp中，這個inp就是個字串，getattr函式讓程式去commons這個模組裡，尋找一個叫inp的成員（是叫，不是等於），這個過程就相當於我們把一個字串變成一個函式名的過程。然後，把獲得的結果賦值給func這個變數，實際上func就指向了commons裡的某個函式。最後通過呼叫func函式，實現對commons裡函式的呼叫。這完全就是一個動態訪問的過程，一切都不寫死，全部根據使用者輸入來變化。
執行上面的程式碼，結果和最開始的是一樣的。
這就是python的反射，它的核心本質其實就是利用字串的形式去物件（模組）中操作（查詢/獲取/刪除/新增）成員，一種基於字串的事件驅動！
這段話，不一定準確，但大概就是這麼個意思。
四、進一步完善
上面的程式碼還有個小瑕疵，那就是如果使用者輸入一個非法的url，比如jpg，由於在commons裡沒有同名的函式，肯定會產生執行錯誤，具體如下：
| 1 2 3 4 5 6 7 |
請輸入您想訪問頁面的url： jpg
Traceback (most recent call last):
File
"F:/Python/pycharm/s13/reflect/visit.py"
, line
16
,
in
<module>
run()
File
"F:/Python/pycharm/s13/reflect/visit.py"
, line
11
,
in
run
func
=
getattr
(commons,inp)
AttributeError: module
'commons'
has no attribute
'jpg'
|
那怎麼辦呢？其實，python考慮的很全面了，它同樣提供了一個叫hasattr的內建函式，用於判斷commons中是否具有某個成員。我們將程式碼修改一下：
| 1 2 3 4 5 6 7 8 9 10 11 12 |
import
commons
def
run():
inp
=
input
(
"請輸入您想訪問頁面的url： "
).strip()
if
hasattr
(commons,inp):
func
=
getattr
(commons,inp)
func()
else
:
print
(
"404"
)
if
__name__
=
=
'__main__'
:
run()
|
通過hasattr的判斷，可以防止非法輸入錯誤，並將其統一定位到錯誤頁面。
其實，研究過python內建函式的朋友，應該注意到還有delattr和setattr兩個內建函式。從字面上已經很好理解他們的作用了。
python的四個重要內建函式：getattr、hasattr、delattr和setattr較為全面的實現了基於字串的反射機制。他們都是對記憶體內的模組進行操作，並不會對原始檔進行修改。
五、動態匯入模組
上面的例子是在某個特定的目錄結構下才能正常實現的，也就是commons和visit模組在同一目錄下，並且所有的頁面處理函式都在commons模組內。如下圖：
但在現實使用環境中，頁面處理函式往往被分類放置在不同目錄的不同模組中，也就是如下圖：
難道我們要在visit模組裡寫上一大堆的import 語句逐個匯入account、manage、commons模組嗎？要是有1000個這種模組呢？
剛才我們分析完了基於字串的反射，實現了動態的函式呼叫功能，我們不禁會想那麼能不能動態匯入模組呢？這完全是可以的！
python提供了一個特殊的方法：__import__(字串引數)。通過它，我們就可以實現類似的反射功能。__import__()方法會根據引數，動態的匯入同名的模組。
我們再修改一下上面的visit模組的程式碼。
| 1 2 3 4 5 6 7 8 9 10 11 12 |
def
run():
inp
=
input
(
"請輸入您想訪問頁面的url： "
).strip()
modules, func
=
inp.split(
"/"
)
obj
=
__import__
(modules)
if
hasattr
(obj, func):
func
=
getattr
(obj, func)
func()
else
:
print
(
"404"
)
if
__name__
=
=
'__main__'
:
run()
|
執行一下：
| 1 2 3 4 5 |
請輸入您想訪問頁面的url： commons
/
home
這是網站主頁面！
請輸入您想訪問頁面的url： account
/
find
這是一個查詢功能頁面！
|
我們來分析一下上面的程式碼：
首先，我們並沒有定義任何一行import語句；
其次，使用者的輸入inp被要求為類似“commons/home”這種格式，其實也就是模擬web框架裡的url地址，斜槓左邊指向模組名，右邊指向模組中的成員名。
然後，modules,func = inp.split("/")處理了使用者輸入，使我們獲得的2個字串，並分別儲存在modules和func變數裡。
接下來，最關鍵的是obj = __import__(modules)這一行，它讓程式去匯入了modules這個變數儲存的字元串同名的模組，並將它賦值給obj變數。
最後的呼叫中，getattr去modules模組中呼叫func成員的含義和以前是一樣的。
總結：通過__import__函式，我們實現了基於字串的動態的模組匯入。
同樣的，這裡也有個小瑕疵！
如果我們的目錄結構是這樣的：
那麼在visit的模組呼叫語句中，必須進行修改，我們想當然地會這麼做：
| 1 2 3 4 5 6 7 8 9 10 11 12 |
def
run():
inp
=
input
(
"請輸入您想訪問頁面的url： "
).strip()
modules, func
=
inp.split(
"/"
)
obj
=
__import__
(
"lib."
+
modules)
#注意字串的拼接
if
hasattr
(obj, func):
func
=
getattr
(obj, func)
func()
else
:
print
(
"404"
)
if
__name__
=
=
'__main__'
:
run(
|
改了這麼一個地方:obj = __import__("lib." + modules)，看起來似乎沒什麼問題，和import lib.commons的傳統方法類似，但實際上執行的時候會有錯誤。
| 1 2 3 4 5 |
請輸入您想訪問頁面的url： commons
/
home
404
請輸入您想訪問頁面的url： account
/
find
404
|
為什麼呢？因為對於lib.xxx.xxx.xxx這一類的模組匯入路徑，__import__預設只會匯入最開頭的圓點左邊的目錄，也就是“lib”。我們可以做個測試，在visit同級目錄內新建一個檔案，程式碼如下：
| 1 2 |
obj
=
__import__
(
"lib.commons"
)
print
(obj)
|
執行結果：
| 1 |
<module
'lib'
(namespace)>
|
這個問題怎麼解決呢？加上fromlist = True引數即可！
| 1 2 3 4 5 6 7 8 9 10 11 12 |
def
run():
inp
=
input
(
"請輸入您想訪問頁面的url： "
).strip()
modules, func
=
inp.split(
"/"
)
obj
=
__import__
(
"lib."
+
modules, fromlist
=
True
)
# 注意fromlist引數
if
hasattr
(obj, func):
func
=
getattr
(obj, func)
func()
else
:
print
(
"404"
)
if
__name__
=
=
'__main__'
:
run()
|
至此，動態匯入模組的問題基本都解決了，只剩下最後一個，那就是萬一使用者輸入錯誤的模組名呢？比如使用者輸入了somemodules/find，由於實際上不存在somemodules這個模組，必然會報錯！那有沒有類似上面hasattr內建函式這麼個功能呢？答案是沒有！碰到這種，你只能通過異常處理來解決。
六、最後的思考
可能有人會問python不是有兩個內建函式exec和eval嗎？他們同樣能夠執行字串。比如：
| 1 2 3 4 5 |
exec
(
"print('haha')"
)
結果：
haha
|
那麼直接使用它們不行嗎？非要那麼費勁地使用getattr，__import__幹嘛？
其實，在上面的例子中，圍繞的核心主題是如何利用字串驅動不同的事件，比如匯入模組、呼叫函式等等，這些都是python的反射機制，是一種程式設計方法、設計模式的體現，凝聚了高內聚、鬆耦合的程式設計思想，不能簡單的用執行字串來代替。當然，exec和eval也有它的舞臺，在web框架裡也經常被使用。