通过 getattr 获取对象引用

怼烎@ 2022-08-24 11:46 161阅读 0赞

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

### 例 4.10. getattr 介绍 ###

>>> li = ["Larry", "Curly"] >>> li.pop   1 <built-in method pop of list object at 010DF884> 
    >>> getattr(li, "pop")           2 <built-in method pop of list object at 010DF884> 
    >>> getattr(li, "append")("Moe") 3 
    >>> li ["Larry", "Curly", "Moe"] 
    >>> getattr({}, "clear")         4 <built-in method clear of dictionary object at 00F113D4> 
    >>> getattr((), "pop")           5 Traceback (innermost last):   File "<interactive input>", line 1, in ? AttributeError: 'tuple' object has no attribute 'pop'

<table style="line-height:28px; margin:1em; padding:0px"> 
 <tbody> 
  <tr> 
   <td align="left"><a href="http://woodpecker.org.cn/diveintopython/power_of_introspection/getattr.html#apihelper.getattr.1.1" style="text-decoration:none; color:rgb(52,177,21)" rel="nofollow"><img src="http://woodpecker.org.cn/diveintopython/images/callouts/1.png" alt="1" width="12" height="12" style="border:0px; max-width:100%"></a></td> 
   <td align="left">该语句获取列表的&nbsp;pop&nbsp;方法的引用。注意该语句并不是调用&nbsp;pop&nbsp;方法；调用&nbsp;pop&nbsp;方法的应该是&nbsp;li.pop()。这里指的是方法对象本身。</td> 
  </tr> 
  <tr> 
   <td align="left"><a href="http://woodpecker.org.cn/diveintopython/power_of_introspection/getattr.html#apihelper.getattr.1.2" style="text-decoration:none; color:rgb(52,177,21)" rel="nofollow"><img src="http://woodpecker.org.cn/diveintopython/images/callouts/2.png" alt="2" width="12" height="12" style="border:0px; max-width:100%"></a></td> 
   <td align="left">该语句也是返回&nbsp;pop&nbsp;方法的引用，但是此时，方法名称是作为一个字符串参数传递给&nbsp;getattr&nbsp;函数的。getattr&nbsp;是一个有用到令人无法致信的内置函数，可以返回任何对象的任何属性。在这个例子中，对象是一个 list，属性是&nbsp;pop&nbsp;方法。</td> 
  </tr> 
  <tr> 
   <td align="left"><a href="http://woodpecker.org.cn/diveintopython/power_of_introspection/getattr.html#apihelper.getattr.1.3" style="text-decoration:none; color:rgb(52,177,21)" rel="nofollow"><img src="http://woodpecker.org.cn/diveintopython/images/callouts/3.png" alt="3" width="12" height="12" style="border:0px; max-width:100%"></a></td> 
   <td align="left">如果不深信它是多么的有用，试试这个：getattr&nbsp;的返回值&nbsp;<em>是</em>&nbsp;方法，然后你就可以调用它就像直接使用&nbsp;li.append("Moe")&nbsp;一样。但是实际上你没有直接调用函数；只是以字符串形式指定了函数名称。</td> 
  </tr> 
  <tr> 
   <td align="left"><a href="http://woodpecker.org.cn/diveintopython/power_of_introspection/getattr.html#apihelper.getattr.1.4" style="text-decoration:none; color:rgb(52,177,21)" rel="nofollow"><img src="http://woodpecker.org.cn/diveintopython/images/callouts/4.png" alt="4" width="12" height="12" style="border:0px; max-width:100%"></a></td> 
   <td align="left">getattr&nbsp;也可以作用于字典。</td> 
  </tr> 
  <tr> 
   <td align="left"><a href="http://woodpecker.org.cn/diveintopython/power_of_introspection/getattr.html#apihelper.getattr.1.5" style="text-decoration:none; color:rgb(52,177,21)" rel="nofollow"><img src="http://woodpecker.org.cn/diveintopython/images/callouts/5.png" alt="5" width="12" height="12" style="border:0px; max-width:100%"></a></td> 
   <td align="left">理论上，getattr&nbsp;可以作用于元组，但是由于&nbsp;<a title="例 3.16. Tuple 没有方法" href="http://woodpecker.org.cn/diveintopython/native_data_types/tuples.html#odbchelper.tuplemethods" style="text-decoration:none; color:rgb(52,177,21)" rel="nofollow">元组没有方法</a>，所以不管你指定什么属性名称&nbsp;getattr&nbsp;都会引发一个异常。</td> 
  </tr> 
 </tbody> 
</table>

### 4.4.1. 用于模块的 getattr ###

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

### 例 4.11. apihelper.py 中的 getattr 函数 ###

>>> import odbchelper 
    >>> odbchelper.buildConnectionString             1 <function buildConnectionString at 00D18DD4> 
    >>> getattr(odbchelper, "buildConnectionString") 2 <function buildConnectionString at 00D18DD4> 
    >>> object = odbchelper 
    >>> method = "buildConnectionString" 
    >>> getattr(object, method)                      3 <function buildConnectionString at 00D18DD4> 
    >>> type(getattr(object, method))                4 <type 'function'> 
    >>> import types 
    >>> type(getattr(object, method)) == types.FunctionType True 
    >>> callable(getattr(object, method))            5 True

<table style="line-height:28px; margin:1em; padding:0px"> 
 <tbody> 
  <tr> 
   <td align="left"><a href="http://woodpecker.org.cn/diveintopython/power_of_introspection/getattr.html#apihelper.getattr.2.1" style="text-decoration:none; color:rgb(52,177,21)" rel="nofollow"><img src="http://woodpecker.org.cn/diveintopython/images/callouts/1.png" alt="1" width="12" height="12" style="border:0px; max-width:100%"></a></td> 
   <td align="left">该语句返回&nbsp;odbchelper&nbsp;模块中&nbsp;buildConnectionString&nbsp;函数的引用，<a title="第 2 章 第一个 Python 程序" href="http://woodpecker.org.cn/diveintopython/getting_to_know_python/index.html" style="text-decoration:none; color:rgb(52,177,21)" rel="nofollow">第&nbsp;2&nbsp;章&nbsp;<em>第一个 Python 程序</em></a>&nbsp;你已经研习过这个方法了。（你看到的这个十六进制地址是我机器上的；你的输出结果会有所不同。）</td> 
  </tr> 
  <tr> 
   <td align="left"><a href="http://woodpecker.org.cn/diveintopython/power_of_introspection/getattr.html#apihelper.getattr.2.2" style="text-decoration:none; color:rgb(52,177,21)" rel="nofollow"><img src="http://woodpecker.org.cn/diveintopython/images/callouts/2.png" alt="2" width="12" height="12" style="border:0px; max-width:100%"></a></td> 
   <td align="left">使用&nbsp;getattr，你能够获得同一函数的同一引用。通常，getattr(<em>object</em>, "<em>attribute</em>")&nbsp;等价于&nbsp;<em>object</em>.<em>attribute</em>。如果&nbsp;<em>object</em>&nbsp;是一个模块的话，那么&nbsp;<em>attribute</em>&nbsp;可能是定义在模块中的任何东西：函数、类或者全局变量。</td> 
  </tr> 
  <tr> 
   <td align="left"><a href="http://woodpecker.org.cn/diveintopython/power_of_introspection/getattr.html#apihelper.getattr.2.3" style="text-decoration:none; color:rgb(52,177,21)" rel="nofollow"><img src="http://woodpecker.org.cn/diveintopython/images/callouts/3.png" alt="3" width="12" height="12" style="border:0px; max-width:100%"></a></td> 
   <td align="left">接下来的是你真正用在&nbsp;info&nbsp;函数中的东西。object&nbsp;作为一个参数传递给函数；&nbsp;method&nbsp;是方法或者函数的名称字符串。</td> 
  </tr> 
  <tr> 
   <td align="left"><a href="http://woodpecker.org.cn/diveintopython/power_of_introspection/getattr.html#apihelper.getattr.2.4" style="text-decoration:none; color:rgb(52,177,21)" rel="nofollow"><img src="http://woodpecker.org.cn/diveintopython/images/callouts/4.png" alt="4" width="12" height="12" style="border:0px; max-width:100%"></a></td> 
   <td align="left">在这个例子中，method&nbsp;是函数的名称，通过获取&nbsp;<a title="例 4.5. type 介绍" href="http://woodpecker.org.cn/diveintopython/power_of_introspection/built_in_functions.html#apihelper.type.intro" style="text-decoration:none; color:rgb(52,177,21)" rel="nofollow">type</a>&nbsp;可以进行验证。</td> 
  </tr> 
  <tr> 
   <td align="left"><a href="http://woodpecker.org.cn/diveintopython/power_of_introspection/getattr.html#apihelper.getattr.2.5" style="text-decoration:none; color:rgb(52,177,21)" rel="nofollow"><img src="http://woodpecker.org.cn/diveintopython/images/callouts/5.png" alt="5" width="12" height="12" style="border:0px; max-width:100%"></a></td> 
   <td align="left">由于&nbsp;method&nbsp;是一个函数，所以它是<a title="例 4.8. callable 介绍" href="http://woodpecker.org.cn/diveintopython/power_of_introspection/built_in_functions.html#apihelper.builtin.callable" style="text-decoration:none; color:rgb(52,177,21)" rel="nofollow">可调用的</a>。</td> 
  </tr> 
 </tbody> 
</table>

### 4.4.2. getattr 作为一个分发者 ###

getattr 常见的使用模式是作为一个分发者。举个例子，如果你有一个程序可以以不同的格式输出数据，你可以为每种输出格式定义各自的格式输出函数，然后使用唯一的分发函数调用所需的格式输出函数。

例如，让我们假设有一个以 HTML、XML 和普通文本格式打印站点统计的程序。输出格式在命令行中指定，或者保存在配置文件中。statsout 模块定义了三个函数：output\_html、output\_xml 和 output\_text。然后主程序定义了唯一的输出函数，如下：

### 例 4.12. 使用getattr 创建分发者 ###

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

<table style="line-height:28px"> 
 <tbody> 
  <tr> 
   <td align="left"><a href="http://woodpecker.org.cn/diveintopython/power_of_introspection/getattr.html#apihelper.getattr.3.1" style="text-decoration:none; color:rgb(52,177,21)" rel="nofollow"><img src="http://woodpecker.org.cn/diveintopython/images/callouts/1.png" alt="1" width="12" height="12" style="border:0px; max-width:100%"></a></td> 
   <td align="left">output&nbsp;函数接收一个必备参数&nbsp;data，和一个可选参数&nbsp;format。如果没有指定&nbsp;format&nbsp;参数，其缺省值是&nbsp;text&nbsp;并完成普通文本输出函数的调用。</td> 
  </tr> 
  <tr> 
   <td align="left"><a href="http://woodpecker.org.cn/diveintopython/power_of_introspection/getattr.html#apihelper.getattr.3.2" style="text-decoration:none; color:rgb(52,177,21)" rel="nofollow"><img src="http://woodpecker.org.cn/diveintopython/images/callouts/2.png" alt="2" width="12" height="12" style="border:0px; max-width:100%"></a></td> 
   <td align="left">你可以连接&nbsp;format&nbsp;参数值和 "output_" 来创建一个函数名称作为参数值，然后从&nbsp;statsout&nbsp;模块中取得该函数。这种方式允许今后很容易的扩展程序以支持其它的输出格式，而且无需修改分发函数。所要做的仅仅是向&nbsp;statsout&nbsp;中添加一个函数，比如&nbsp;output_pdf，之后只要将 “pdf” 作为&nbsp;format&nbsp;的参数值传递给&nbsp;output&nbsp;函数即可。</td> 
  </tr> 
  <tr> 
   <td align="left"><a href="http://woodpecker.org.cn/diveintopython/power_of_introspection/getattr.html#apihelper.getattr.3.3" style="text-decoration:none; color:rgb(52,177,21)" rel="nofollow"><img src="http://woodpecker.org.cn/diveintopython/images/callouts/3.png" alt="3" width="12" height="12" style="border:0px; max-width:100%"></a></td> 
   <td align="left">现在你可以简单的调用输出函数就像调用其它函数一样了。output_function&nbsp;变量是指向&nbsp;statsout&nbsp;模块中相应函数的引用。</td> 
  </tr> 
 </tbody> 
</table>

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

值得庆幸的是，getattr 能够使用可选的第三个参数，一个缺省返回值。

### 例 4.13. getattr 缺省值 ###

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

正如你所看到，getattr 是相当强大的。它是自省的核心，在后面的章节中你将看到它更强大的示例

转自：http://359611946.blog.163.com/blog/static/11619002011019102430143/

[Python]: http://woodpecker.org.cn/diveintopython/getting_to_know_python/everything_is_an_object.html