小谈Python的getattr函数

通过 getattr 获取对象引用

 

你已经知道 Python 函数是对象。 你不知道的是，使用 getattr 函数，可以得到一个直到运行时才知道名称的函数的引用。

 

>>>li = ["Larry", "Curly"]

>>>li.pop                      

<built-in method pop of list object at 010DF884>

>>>getattr(li, "pop")     

<built-in method pop of list object at 010DF884>

>>>getattr(li, "append")("Moe")

>>>li

["Larry", "Curly", "Moe"]

>>>getattr({}, "clear")        

<built-in method clear of dictionary object at 00F113D4>

>>>getattr((), "pop")

 

用于模块的 getattr

 

getattr 不仅仅适用于内置数据类型，也可作用于模块。

 

 

>>>import odbchelper

>>>odbchelper.buildConnectionString   
          
<function buildConnectionString at 00D18DD4>

>>>getattr(odbchelper, "buildConnectionString") 

<function buildConnectionString at 00D18DD4>

>>>object = odbchelper

>>>method = "buildConnectionString"

>>>getattr(object, method)     
                 
<function buildConnectionString at 00D18DD4>

>>>type(getattr(object, method))      
          
<type 'function'>

>>>import types

>>>type(getattr(object, method)) == types.FunctionType

True

>>>callable(getattr(object, method))     
       
True

 

 

getattr 作为一个分发者

 

getattr 常见的使用模式是作为一个分发者。举个例子，如果你有一个程序可以以不同的格式输出数据，你可以为每种输出格式定义各自的格式输出函数，然后使用唯一的分发函数调用所需的格式输出函数。
例如，让我们假设有一个以 HTML、XML 和普通文本格式打印站点统计的程序。输出格式在命令行中指定，或者保存在配置文件中。statsout 模块定义了三个函数：output_html、output_xml 和 output_text。然后主程序定义了唯一的输出函数，如下：

 

import statsout

def output(data, format="text"):    
                          
    output_function = getattr(statsout, "output_%s" % format) 

    return output_function(data)

 

你是否发现前面示例的一个 Bug？即字符串和函数之间的松耦合，而且没有错误检查。如果用户传入一个格式参数，但是在 statsout 中没有定义相应的格式输出函数，会发生什么呢？还好，getattr 会返回 None，它会取代一个有效函数并被赋值给 output_function，然后下一行调用函数的语句将会失败并抛出一个异常。这种方式不好。
值得庆幸的是，getattr 能够使用可选的第三个参数，一个缺省返回值。

 

import statsout

def output(data, format="text"):

    output_function = getattr(statsout, "output_%s" % format, statsout.output_text)

    return output_function(data) 

 

这个函数调用一定可以工作，因为你在调用 getattr 时添加了第三个参数。第三个参数是一个缺省返回值，如果第二个参数指定的属性或者方法没能找到，则将返回这个缺省返回值。