本文和大家分享的主要是python反射機(jī)制相關(guān)內(nèi)容,一起來看看吧,希望對大家學(xué)習(xí)python有所幫助。
對編程語言比較熟悉的朋友,應(yīng)該知道“反射”這個機(jī)制。Python作為一門動態(tài)語言,當(dāng)然不會缺少這一重要功能。然而,在網(wǎng)絡(luò)上卻很少見到有詳細(xì)或者深刻的剖析論文。下面結(jié)合一個web路由的實例來闡述python的反射機(jī)制的使用場景和核心本質(zhì)。
一、前言
1 def f1():2 print("f1是這個函數(shù)的名字!")3 4 s = "f1"5 print("%s是個字符串" % s)
在上面的代碼中,我們必須區(qū)分兩個概念,f1和“f1"。前者是函數(shù)f1的函數(shù)名,后者只是一個叫”f1“的字符串,兩者是不同的事物。我們可以用f1()的方式調(diào)用函數(shù)f1,但我們不能用"f1"()的方式調(diào)用函數(shù)。說白了就是,不能通過字符串來調(diào)用名字看起來相同的函數(shù)!
二、web實例
考慮有這么一個場景,根據(jù)用戶輸入的url的不同,調(diào)用不同的函數(shù),實現(xiàn)不同的操作,也就是一個url路由器的功能,這在web框架里是核心部件之一。下面有一個精簡版的示例:
首先,有一個commons模塊,它里面有幾個函數(shù),分別用于展示不同的頁面,代碼如下:
#coding:utf8
def login():
print("這是一個登陸頁面!")
def logout():
print("這是一個退出頁面!")
def home():
print("這是網(wǎng)站主頁面!")
其次,有一個visit模塊,作為程序入口,接受用戶輸入,展示相應(yīng)的頁面,代碼如下:(這段代碼是比較初級的寫法)
1 #coding:utf8
2
3 import commons
4
5 def run():
6 inp = input("請輸入您想訪問頁面的url: ").strip()
7 if inp == "login":
8 commons.login()
9 elif inp == "logout":10 commons.logout()11 elif inp == "home":12 commons.home()13 else:14 print("404")15 16 if __name__ == '__main__':17 run()
我們運行visit.py,輸入:home,頁面結(jié)果如下:
請輸入您想訪問頁面的url: home
這是網(wǎng)站主頁面!
這就實現(xiàn)了一個簡單的WEB路由功能,根據(jù)不同的url,執(zhí)行不同的函數(shù),獲得不同的頁面。
然而,讓我們考慮一個問題,如果commons模塊里有成百上千個函數(shù)呢(這非常正常)?。難道你在visit模塊里寫上成百上千個elif?顯然這是不可能的!那么怎么破?
三、反射機(jī)制
仔細(xì)觀察visit中的代碼,我們會發(fā)現(xiàn)用戶輸入的url字符串和相應(yīng)調(diào)用的函數(shù)名好像!如果能用這個字符串直接調(diào)用函數(shù)就好了!但是,前面我們已經(jīng)說了字符串是不能用來調(diào)用函數(shù)的。為了解決這個問題,python為我們提供一個強(qiáng)大的內(nèi)置函數(shù): getattr !我們將前面的visit修改一下,代碼如下:
1 #coding:utf8
2
3 import commons
4
5 def run():
6 inp = input("請輸入您想訪問頁面的url: ").strip()
7 func = getattr(commons,inp)
8 func()
9 10 if __name__ == '__main__':11 run()
首先說明一下getattr函數(shù)的使用方法:它接收2個參數(shù),前面的是一個對象或者模塊,后面的是一個字符串,注意了!是個字符串!
例子中,用戶輸入儲存在inp中,這個inp就是個字符串, getattr 函數(shù)讓程序去commons這個模塊里,尋找一個叫inp的成員(是叫,不是等于),這個過程就相當(dāng)于我們把一個字符串變成一個函數(shù)名的過程。然后,把獲得的結(jié)果賦值給func這個變量,實際上func就指向了commons里的某個函數(shù)。最后通過調(diào)用func函數(shù),實現(xiàn)對commons里函數(shù)的調(diào)用。這完全就是一個動態(tài)訪問的過程,一切都不寫死,全部根據(jù)用戶輸入來變化。
執(zhí)行上面的代碼,結(jié)果和最開始的是一樣的。
這就是python的反射,它的核心本質(zhì)其實就是利用字符串的形式去對象(模塊)中操作(查找/獲取/刪除/添加)成員,一種基于字符串的事件驅(qū)動!
這段話,不一定準(zhǔn)確,但大概就是這么個意思。
四、進(jìn)一步完善
上面的代碼還有個小瑕疵,那就是如果用戶輸入一個非法的url,比如jpg,由于在commons里沒有同名的函數(shù),肯定會產(chǎn)生運行錯誤,具體如下:
請輸入您想訪問頁面的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 的內(nèi)置函數(shù),用于判斷commons中是否具有某個成員。我們將代碼修改一下:
1 #coding:utf8
2
3 import commons
4
5 def run():
6 inp = input("請輸入您想訪問頁面的url: ").strip()
7 if hasattr(commons,inp):
8 func = getattr(commons,inp)
9 func()10 else:11 print("404")12 13 if __name__ == '__main__':14 run()
通過 hasattr 的判斷,可以防止非法輸入錯誤,并將其統(tǒng)一定位到錯誤頁面。
其實,研究過python內(nèi)置函數(shù)的朋友,應(yīng)該注意到還有 delattr 和 setattr 兩個內(nèi)置函數(shù)。從字面上已經(jīng)很好理解他們的作用了。
python的四個重要內(nèi)置函數(shù): getattr 、 hasattr 、 delattr 和 setattr 較為全面的實現(xiàn)了基于字符串的反射機(jī)制。他們都是對內(nèi)存內(nèi)的模塊進(jìn)行操作,并不會對源文件進(jìn)行修改。
五、動態(tài)導(dǎo)入模塊
上面的例子是在某個特定的目錄結(jié)構(gòu)下才能正常實現(xiàn)的,也就是commons和visit模塊在同一目錄下,并且所有的頁面處理函數(shù)都在commons模塊內(nèi)。如下圖:
但在現(xiàn)實使用環(huán)境中,頁面處理函數(shù)往往被分類放置在不同目錄的不同模塊中,也就是如下圖:
難道我們要在visit模塊里寫上一大堆的import 語句逐個導(dǎo)入account、manage、commons模塊嗎?要是有1000個這種模塊呢?
剛才我們分析完了基于字符串的反射,實現(xiàn)了動態(tài)的函數(shù)調(diào)用功能,我們不禁會想那么能不能動態(tài)導(dǎo)入模塊呢?這完全是可以的!
python提供了一個特殊的方法 :__import__(字符串參數(shù))。 通過它,我們就可以實現(xiàn)類似的反射功能。__import__()方法會根據(jù)參數(shù),動態(tài)的導(dǎo)入同名的模塊。
我們再修改一下上面的visit模塊的代碼。
1 #coding:Utf8
2
3 def run():
4 inp = input("請輸入您想訪問頁面的url: ").strip()
5 modules, func = inp.split("/")
6 obj = __import__(modules)
7 if hasattr(obj, func):
8 func = getattr(obj, func)
9 func()10 else:11 print("404")12 13 if __name__ == '__main__':14 run()
運行一下:
請輸入您想訪問頁面的url: commons/home
這是網(wǎng)站主頁面!
請輸入您想訪問頁面的url: account/find
這是一個查找功能頁面!
我們來分析一下上面的代碼:
首先,我們并沒有定義任何一行import語句;
其次,用戶的輸入inp被要求為類似“commons/home”這種格式,其實也就是模擬web框架里的url地址,斜杠左邊指向模塊名,右邊指向模塊中的成員名。
然后, modules,func = inp.split("/") 處理了用戶輸入,使我們獲得的2個字符串,并分別保存在modules和func變量里。
接下來,最關(guān)鍵的是 obj = __import__(modules) 這一行,它讓程序去導(dǎo)入了modules這個變量保存的字符串同名的模塊,并將它賦值給obj變量。
最后的調(diào)用中,getattr去modules模塊中調(diào)用func成員的含義和以前是一樣的。
總結(jié):通過 __import__ 函數(shù),我們實現(xiàn)了基于字符串的動態(tài)的模塊導(dǎo)入。
同樣的,這里也有個小瑕疵!
如果我們的目錄結(jié)構(gòu)是這樣的:
那么在visit的模塊調(diào)用語句中,必須進(jìn)行修改,我們想當(dāng)然地會這么做:
1 #coding:Utf8
2
3 def run():
4 inp = input("請輸入您想訪問頁面的url: ").strip()
5 modules, func = inp.split("/")
6 obj = __import__("lib." + modules) #注意字符串的拼接
7 if hasattr(obj, func):
8 func = getattr(obj, func)
9 func()10 else:11 print("404")12 13 if __name__ == '__main__':14 run()
改了這么一個地方 :obj = __import__("lib." + modules), 看起來似乎沒什么問題,和 import lib.commons 的傳統(tǒng)方法類似,但實際上運行的時候會有錯誤。
請輸入您想訪問頁面的url: commons/home404
請輸入您想訪問頁面的url: account/find404
為什么呢?因為對于lib.xxx.xxx.xxx這一類的模塊導(dǎo)入路徑,__import__默認(rèn)只會導(dǎo)入最開頭的圓點左邊的目錄,也就是“l(fā)ib”。我們可以做個測試,在visit同級目錄內(nèi)新建一個文件,代碼如下:
1 obj = __import__("lib.commons")2 print(obj)
執(zhí)行結(jié)果:
這個問題怎么解決呢?加上fromlist = True參數(shù)即可!
1 #coding:utf8
2
3 def run():
4 inp = input("請輸入您想訪問頁面的url: ").strip()
5 modules, func = inp.split("/")
6 obj = __import__("lib." + modules, fromlist=True) # 注意fromlist參數(shù)
7 if hasattr(obj, func):
8 func = getattr(obj, func)
9 func()10 else:11 print("404")12 13 if __name__ == '__main__':14 run()
至此,動態(tài)導(dǎo)入模塊的問題基本都解決了,只剩下最后一個,那就是萬一用戶輸入錯誤的模塊名呢?比如用戶輸入了 somemodules/find ,由于實際上不存在 somemodules 這個模塊,必然會報錯!那有沒有類似上面hasattr內(nèi)置函數(shù)這么個功能呢?答案是沒有!碰到這種,你只能通過異常處理來解決。
六、最后的思考
可能有人會問python不是有兩個內(nèi)置函數(shù) exec 和 eval 嗎?他們同樣能夠執(zhí)行字符串。比如:
exec("print('haha')")
結(jié)果:
haha
那么直接使用它們不行嗎?非要那么費勁地使用 getattr , __import__ 干嘛?
其實,在上面的例子中,圍繞的核心主題是如何利用字符串驅(qū)動不同的事件,比如導(dǎo)入模塊、調(diào)用函數(shù)等等,這些都是python的反射機(jī)制,是一種編程方法、設(shè)計模式的體現(xiàn),凝聚了高內(nèi)聚、松耦合的編程思想,不能簡單的用執(zhí)行字符串來代替。當(dāng)然,exec和eval也有它的舞臺,在web框架里也經(jīng)常被使用。
來源:博客園