Python通過getattr獲取對象引用

getattr函數

（1）使用 getattr 函數,可以得到一個直到運行時才知道名稱的函數的引用。

>>> li = ["Larry", "Curly"]
>>> li.pop
<built-in method pop of list object at 0x7fb75c255518>
// 該語句獲取列表的 pop 方法的引用,注意該語句並不是調用 pop 方法,調用 pop 方法的應該是 li.pop(), 這裏指的是方法對象本身。

>>> getattr(li, "pop")
<built-in method pop of list object at 0x7fb75c2556c8>
// 該語句也是返回 pop 方法的引用,但是此時,方法名稱是作爲一個字符串參數傳遞給 getattr 函數的, getattr 是一個有用到令人無法致信的內置函數,可以返回任何對象的任何屬性。在這個例子中,對象是一個 list, 屬性是 pop 方法。

>>> getattr(li, "append")("Moe")
>>> li
['Larry', 'Curly', 'Moe']
// 如果不確信它是多麼的有用,試試這個: getattr 的返回值是 方法, 然後你就可以調用它,就像直接使用 li.append("Moe") 一樣, 但是實際上你沒有直接調用函數, 只是以字符串形式指定了函數名稱。

>>> getattr({}, "clear")
<built-in method clear of dict object at 0x7fb75c273b40>
// getattr 也可以作用於字典。

>>> getattr((), "pop")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: 'tuple' object has no attribute 'pop'
// 理論上, getattr 可以作用於元組,但是由於元組沒有方法,所以不管你指定什麼屬性名稱 getattr 都會引發一個異常。

（2）用於模塊的 getattr : getattr不僅僅適用於內置數據類型,也可作用於模塊。

// odbchelper.py
def buildConnectionString(params):
    """Build a connection string from a dictionary of parameters. 
    Returns string."""
    return ";".join(["%s=%s" % (k, v) for k, v in params.items()])

if __name__ == "__main__":
    myParams = {"server":"mpilgrim",\
                "database":"master",\
                "uid":"sa",\
                "pwd":"secret"
               }
    print buildConnectionString(myParams)
// end

>>> import odbchelper
>>> odbchelper.buildConnectionString
<function buildConnectionString at 0x7fb75c26e848>
// 該語句返回 odbchelper 模塊中 buildConnectionString 函數的引用

>>> getattr(odbchelper, "buildConnectionString")
<function buildConnectionString at 0x7fb75c26e848>
// 使用 getattr, 你能夠獲得同一函數的同一引用, 通常, getattr(object," attribute ")等價於 object.attribute, 如果 object 是一個模塊的話,那麼 attribute 可能是定義在模塊中的任何東西:函數、類或者全局變量。

>>> object = odbchelper
>>> method = "buildConnectionString"
>>> getattr(object, method)
<function buildConnectionString at 0x7fb75c26e848>
// object 作爲一個參數傳遞給函數, method 是方法或者函數的名稱字符串。

>>> type(getattr(object, method))
<type 'function'>
>>> import types
>>> type(getattr(object, method)) == types.FunctionType
True
// method 是函數的名稱,通過獲取 type 可以進行驗證。

>>> callable(getattr(object, method))
True
// 由於 method 是一個函數, 所以它是可調用的。

（3）getattr 作爲一 個分發者

getattr 常見的使用模式是作爲一個分發者。舉個例子, 如果你有一個程序可以以不同的格式輸出數據,你可以爲每種輸出格式定義各自的格式輸出函數, 然後使用唯一的分發函數調用所需的格式輸出函數。

例如, 我們假設有一個以 HTML、XML 和普通文本格式打印站點統計的程序。輸出格式在命令行中指定, 或者保存在配置文件中, statsout 模塊定義了三個函數: output_html 、 output_xml 和 output_text , 然後主程序定義了唯一的輸出函數, 如下:

import statsout

def output(data, format="text"):        (1)
    output_function = getattr(statsout, "output_%s" % \
                    format, statsout.output_text)     (2)
    return output_function(data)        (3)       

(1) output 函數接收一個必備參數 data, 和一個可選參數 format, 如果沒有指定 format 參數, 其缺省值是 text 並完成普通文本輸出函數的調用。

(2) 你可以連接 format 參數值和 “output_” 來創建一個函數名稱作爲參數值, 然後從 statsout 模塊中取得該函數, 第三個參數是一個缺省返回值, 如果第二個參數指定的屬性或者方法沒能找到, 則將返回這個缺省返回值。這種方式允許今後很容易地擴展程序以支持其它的輸出格式,而且無需修改分發函數。所要做的僅僅是向 statsout 中添加一個函數,比如 output_pdf, 之後只要將 “pdf” 作爲 format 的參數值傳遞給 output 函數即可。

(3) 現在你可以簡單地調用輸出函數,就像調用其它函數一樣, output_function 變量是指向 statsout 模塊中相應函數的引用。