python里的反射(自學習)

 

在做程序開發中，我們常常會遇到這樣的需求：需要執行對象里的某個方法，或需要調用對象中的某個變量，但是由於種種原因我們無法確定這個方法或變量是否存在，這是我們需要用一個特殊的方法或機制要訪問和操作這個未知的方法或變量，這中機制就稱之為反射。接下記錄下反射幾個重要方法：

hasattr

判斷對象中是否有這個方法或變量

class Person(object): def __init__(self,name): self.name = name def talk(self): print("%s正在交談"%self.name) p = Person("laowang") print(hasattr(p,"talk")) # True。因為存在talk方法 print(hasattr(p,"name")) # True。因為存在name變量 print(hasattr(p,"abc")) # False。因為不存在abc方法或變量

getattr

獲取對象中的方法或變量的內存地址

class Person(object): def __init__(self,name): self.name = name def talk(self): print("%s正在交談"%self.name) p = Person("laowang") n = getattr(p,"name") # 獲取name變量的內存地址 print(n) # 此時打印的是:laowang f = getattr(p,"talk") # 獲取talk方法的內存地址 f() # 調用talk方法 我們發現getattr有三個參數，那么第三個參數是做什么用的呢? s = getattr(p,"abc","not find") print(s) # 打印結果：not find。因為abc在對象p中找不到，本應該報錯，屬性找不到，但因為修改了找不到就輸出not find 

setattr

為對象添加變量或方法

def abc(self): print("%s正在交談"%self.name) class Person(object): def __init__(self,name): self.name = name p = Person("laowang") setattr(p,"talk",abc) # 將abc函數添加到對象中p中，並命名為talk p.talk(p) # 調用talk方法，因為這是額外添加的方法，需手動傳入對象 setattr(p,"age",30) # 添加一個變量age,復制為30 print(p.age) # 打印結果:30

delattr

刪除對象中的變量。注意：不能用於刪除方法

class Person(object): def __init__(self,name): self.name = name def talk(self): print("%s正在交談"%self.name) p = Person("laowang") delattr(p,"name") # 刪除name變量 print(p.name) # 此時將報錯
————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————

對編程語言比較熟悉的朋友，應該知道“反射”這個機制。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框架里也經常被使用。