python反射機制深入分析

轉自:http://www.cnblogs.com/feixuelove1009/p/5576206.html,只做記錄


對編程語言比較熟悉的朋友,應該知道“反射”這個機制。Python作為一門動態語言,當然不會缺少這一重要功能。然而,在網絡上卻很少見到有詳細或者深刻的剖析論文。下面結合一個web路由的實例來闡述python的反射機制的使用場景和核心本質。

一、前言

def f1():

print("f1是這個函數的名字!")

s="f1"

print("%s是個字符串"%s)

在上面的代碼中,我們必須區分兩個概念,f1和“f1"。前者是函數f1的函數名,后者只是一個叫”f1“的字符串,兩者是不同的事物。我們可以用f1()的方式調用函數f1,但我們不能用"f1"()的方式調用函數。說白了就是,不能通過字符串來調用名字看起來相同的函數!

二、web實例

考慮有這么一個場景,根據用戶輸入的url的不同,調用不同的函數,實現不同的操作,也就是一個url路由器的功能,這在web框架里是核心部件之一。下面有一個精簡版的示例:

首先,有一個commons模塊,它里面有幾個函數,分別用于展示不同的頁面,代碼如下:

def login():

print("這是一個登陸頁面!")

deflogout():

print("這是一個退出頁面!")

def home():

print("這是網站主頁面!")

其次,有一個visit模塊,作為程序入口,接受用戶輸入,展示相應的頁面,代碼如下:(這段代碼是比較初級的寫法)

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,頁面結果如下:

請輸入您想訪問頁面的url:? home

這是網站主頁面!

這就實現了一個簡單的WEB路由功能,根據不同的url,執行不同的函數,獲得不同的頁面。

然而,讓我們考慮一個問題,如果commons模塊里有成百上千個函數呢(這非常正常)?。難道你在visit模塊里寫上成百上千個elif?顯然這是不可能的!那么怎么破?

三、反射機制

仔細觀察visit中的代碼,我們會發現用戶輸入的url字符串和相應調用的函數名好像!如果能用這個字符串直接調用函數就好了!但是,前面我們已經說了字符串是不能用來調用函數的。為了解決這個問題,python為我們提供一個強大的內置函數:getattr!我們將前面的visit修改一下,代碼如下:

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里沒有同名的函數,肯定會產生運行錯誤,具體如下:

請輸入您想訪問頁面的url:? jpg

Traceback (most recent call last):

File"F:/Python/pycharm/s13/reflect/visit.py", line16,in

run()

File"F:/Python/pycharm/s13/reflect/visit.py", line11,inrun

func=getattr(commons,inp)

AttributeError: module'commons'has no attribute'jpg'

那怎么辦呢?其實,python考慮的很全面了,它同樣提供了一個叫hasattr的內置函數,用于判斷commons中是否具有某個成員。我們將代碼修改一下:

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模塊的代碼。

def run():

inp=input("請輸入您想訪問頁面的url:? ").strip()

modules, func=inp.split("/")

obj=__import__(modules)

ifhasattr(obj, func):

func=getattr(obj, func)

func()

else:

print("404")

if__name__=='__main__':

run()

運行一下:

請輸入您想訪問頁面的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的模塊調用語句中,必須進行修改,我們想當然地會這么做:

def run():

inp=input("請輸入您想訪問頁面的url:? ").strip()

modules, func=inp.split("/")

obj=__import__("lib."+modules)#注意字符串的拼接

ifhasattr(obj, func):

func=getattr(obj, func)

func()

else:

print("404")

if__name__=='__main__':

run(

改了這么一個地方:obj = __import__("lib." + modules),看起來似乎沒什么問題,和import lib.commons的傳統方法類似,但實際上運行的時候會有錯誤。

請輸入您想訪問頁面的url:? commons/home

404

請輸入您想訪問頁面的url:? account/find

404

為什么呢?因為對于lib.xxx.xxx.xxx這一類的模塊導入路徑,__import__默認只會導入最開頭的圓點左邊的目錄,也就是“lib”。我們可以做個測試,在visit同級目錄內新建一個文件,代碼如下:

obj=__import__("lib.commons")

print(obj)

執行結果:

這個問題怎么解決呢?加上fromlist = True參數即可!

def run():

inp=input("請輸入您想訪問頁面的url:? ").strip()

modules, func=inp.split("/")

obj=__import__("lib."+modules, fromlist=True)# 注意fromlist參數

ifhasattr(obj, func):

func=getattr(obj, func)

func()

else:

print("404")

if__name__=='__main__':

run()

至此,動態導入模塊的問題基本都解決了,只剩下最后一個,那就是萬一用戶輸入錯誤的模塊名呢?比如用戶輸入了somemodules/find,由于實際上不存在somemodules這個模塊,必然會報錯!那有沒有類似上面hasattr內置函數這么個功能呢?答案是沒有!碰到這種,你只能通過異常處理來解決。

六、最后的思考

可能有人會問python不是有兩個內置函數exec和eval嗎?他們同樣能夠執行字符串。比如:

exec("print('haha')")

結果:

haha

那么直接使用它們不行嗎?非要那么費勁地使用getattr,__import__干嘛?

其實,在上面的例子中,圍繞的核心主題是如何利用字符串驅動不同的事件,比如導入模塊、調用函數等等,這些都是python的反射機制,是一種編程方法、設計模式的體現,凝聚了高內聚、松耦合的編程思想,不能簡單的用執行字符串來代替。當然,exec和eval也有它的舞臺,在web框架里也經常被使用。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,933評論 18 139
  • 1. Java基礎部分 基礎部分的順序:基本語法,類相關的語法,內部類的語法,繼承相關的語法,異常的語法,線程的語...
    子非魚_t_閱讀 31,765評論 18 399
  • 兩本不錯的書: 《Python參考手冊》:對Python各個標準模塊,特性介紹的比較詳細。 《Python核心編程...
    靜熙老師哈哈哈閱讀 3,386評論 0 80
  • 內置函數Python解釋器內置了許多功能和類型,總是可用的。他們是按字母順序列在這里。 abs(x)返回一個數的絕...
    uangianlap閱讀 1,267評論 0 0
  • 像是魔咒一樣,人生的某個或者某幾個階段總是會被一些事情所誘惑,然后幡然醒悟時有可能為時已晚。 小時候不喜歡讀書學習...
    一個景天閱讀 253評論 0 0