python的反射機制

轉載自：http://www.cnblogs.com/feixuelove1009/p/5576206.html　　

 

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

1、前言

1 2 3 4 5

def  f1():      print ( "f1是這個函數的名字！" )   s  =  "f1" print ( "%s是個字符串"  %  s)

　　在上面的代碼中，咱們必須區分兩個概念，f1和「f1"。前者是函數f1的函數名，後者只是一個叫」f1「的字符串，二者是不一樣的事物。咱們能夠用f1()的方式調用函數f1，但咱們不能用"f1"()的方式調用函數。說白了就是，不能經過字符串來調用名字看起來相同的函數！

2、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?顯然這是不可能的！那麼怎麼破？

3、反射機制

　　仔細觀察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的反射，它的核心本質其實就是利用字符串的形式去對象（模塊）中操做（查找/獲取/刪除/添加）成員，一種基於字符串的事件驅動！

　　這段話，不必定準確，但大概就是這麼個意思。

4、進一步完善

　　上面的代碼還有個小瑕疵，那就是若是用戶輸入一個非法的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較爲全面的實現了基於字符串的反射機制。他們都是對內存內的模塊進行操做，並不會對源文件進行修改。

5、動態導入模塊

　　上面的例子是在某個特定的目錄結構下才能正常實現的，也就是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內置函數這麼個功能呢？答案是沒有！碰到這種，你只能經過異常處理來解決。

6、最後的思考

　　可能有人會問python不是有兩個內置函數exec和eval嗎？他們一樣可以執行字符串。好比：

1 2 3 4 5

exec ( "print('haha')" )   結果：   haha

　　那麼直接使用它們不行嗎？非要那麼費勁地使用getattr，__import__幹嗎？

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