在笔者,也就是我的概念里,自省和反射是一回事,当然其实我并不十分确定一定以及肯定,所以如果这确实是两个不同的概念的话,还请多多指教 :) 转载请注明作者、出处并附上原文链接,多谢!
update 2011-3-10: 更正函数的func_globals属性含义。
首先通过一个例子来看一下本文中可能用到的对象和相关概念。
02 |
import sys # 模块,sys指向这个模块对象
|
04 |
def foo(): pass # 函数,foo指向这个函数对象
|
06 |
class Cat(object): # 类,Cat指向这个类对象
|
07 |
def __init__(self, name='kitty'):
|
09 |
def sayHi(self): # 实例方法,sayHi指向这个方法对象,使用类或实例.sayHi访问
|
10 |
print self.name, 'says Hi!' # 访问名为name的字段,使用实例.name访问
|
12 |
cat = Cat() # cat是Cat类的实例对象
|
14 |
print Cat.sayHi # 使用类名访问实例方法时,方法是未绑定的(unbound)
|
15 |
print cat.sayHi # 使用实例访问实例方法时,方法是绑定的(bound)
|
有时候我们会碰到这样的需求,需要执行对象的某个方法,或是需要对对象的某个字段赋值,而方法名或是字段名在编码代码时并不能确定,需要通过参数传递字符串的形式输入。举个具体的例子:当我们需要实现一个通用的DBM框架时,可能需要对数据对象的字段赋值,但我们无法预知用到这个框架的数据对象都有些什么字段,换言之,我们在写框架的时候需要通过某种机制访问未知的属性。
这个机制被称为反射(反过来让对象告诉我们他是什么),或是自省(让对象自己告诉我们他是什么,好吧我承认括号里是我瞎掰的- -#),用于实现在运行时获取未知对象的信息。反射是个很吓唬人的名词,听起来高深莫测,在一般的编程语言里反射相对其他概念来说稍显复杂,一般来说都是作为高级主题来讲;但在Python中反射非常简单,用起来几乎感觉不到与其他的代码有区别,使用反射获取到的函数和方法可以像平常一样加上括号直接调用,获取到类后可以直接构造实例;不过获取到的字段不能直接赋值,因为拿到的其实是另一个指向同一个地方的引用,赋值只能改变当前的这个引用而已。
1. 访问对象的属性
以下列出了几个内建方法,可以用来检查或是访问对象的属性。这些方法可以用于任意对象而不仅仅是例子中的Cat实例对象;Python中一切都是对象。
03 |
print cat.name # 访问实例属性
|
06 |
print dir(cat) # 获取实例的属性名,以列表形式返回
|
07 |
if hasattr(cat, 'name'): # 检查实例是否有这个属性
|
08 |
setattr(cat, 'name', 'tiger') # same as: a.name = 'tiger'
|
09 |
print getattr(cat, 'name') # same as: print a.name
|
11 |
getattr(cat, 'sayHi')() # same as: cat.sayHi()
|
-
dir([obj]):
调用这个方法将返回包含obj大多数属性名的列表(会有一些特殊的属性不包含在内)。obj的默认值是当前的模块对象。
-
hasattr(obj, attr):
这个方法用于检查obj是否有一个名为attr的值的属性,返回一个布尔值。
-
getattr(obj, attr):
调用这个方法将返回obj中名为attr值的属性的值,例如如果attr为'bar',则返回obj.bar。
-
setattr(obj, attr, val):
调用这个方法将给obj的名为attr的值的属性赋值为val。例如如果attr为'bar',则相当于obj.bar = val。
2. 访问对象的元数据
当你对一个你构造的对象使用dir()时,可能会发现列表中的很多属性并不是你定义的。这些属性一般保存了对象的元数据,比如类的__name__属性保存了类名。大部分这些属性都可以修改,不过改动它们意义并不是很大;修改其中某些属性如function.func_code还可能导致很难发现的问题,所以改改name什么的就好了,其他的属性不要在不了解后果的情况下修改。
接下来列出特定对象的一些特殊属性。另外,Python的文档中有提到部分属性不一定会一直提供,下文中将以红色的星号*标记,使用前你可以先打开解释器确认一下。
2.0. 准备工作:确定对象的类型
在types模块中定义了全部的Python内置类型,结合内置方法isinstance()就可以确定对象的具体类型了。
-
isinstance(object, classinfo):
检查object是不是classinfo中列举出的类型,返回布尔值。classinfo可以是一个具体的类型,也可以是多个类型的元组或列表。
types模块中仅仅定义了类型,而inspect模块中封装了很多检查类型的方法,比直接使用types模块更为轻松,所以这里不给出关于types的更多介绍,如有需要可以直接查看types模块的文档说明。本文第3节中介绍了inspect模块。
2.1. 模块(module)
- __doc__: 文档字符串。如果模块没有文档,这个值是None。
-
*__name__: 始终是定义时的模块名;即使你使用import .. as 为它取了别名,或是赋值给了另一个变量名。
-
*__dict__: 包含了模块里可用的属性名-属性的字典;也就是可以使用模块名.属性名访问的对象。
- __file__: 包含了该模块的文件路径。需要注意的是内建的模块没有这个属性,访问它会抛出异常!
2 |
print m.__doc__.splitlines()[0] # Filename matching with shell patterns.
|
3 |
print m.__name__ # fnmatch
|
4 |
print m.__file__ # /usr/lib/python2.6/fnmatch.pyc
|
5 |
print m.__dict__.items()[0] # ('fnmatchcase', <function>)</function>
|