本文共 10570 字,大约阅读时间需要 35 分钟。
来源:
inspect模块主要提供了四种用处: (1) 对是否是模块,框架,函数等进行类型检查。 (2) 获取源码 (3) 获取类或函数的参数的信息 (4) 解析堆栈 使用inspect模块可以提供自省功能,下面是关于自省的一些介绍: 首先通过一个例子来看一下本文中可能用到的对象和相关概念。
#coding: UTF-8import sys # 模块,sys指向这个模块对象 import inspectdef foo(): pass # 函数,foo指向这个函数对象 class Cat(object): # 类,Cat指向这个类对象 def __init__ (self,name = ' kitty ' ): self.name = name def sayHi(self): # 实例方法,sayHi指向这个方法对象,使用类或实例.sayHi访问 print self.name,' says Hi! ' #访问名为name的字段,使用实例.name访问 cat = Cat() # cat是Cat类的实例对象 print Cat.sayHi # 使用类名访问实例方法时,方法是未绑定的(unbound) print cat.sayHi # 使用实例访问实例方法时,方法是绑定的(bound)有时候我们会碰到这样的需求,需要执行对象的某个方法,或是需要对对象的某个字段赋值,而方法名或是字段名在编码代码时并不能确定,需要通过参数传递字符串的形式输入。举个具体的例子:当我们需要实现一个通用的DBM框架时,可能需要对数据对象的字段赋值,但我们无法预知用到这个框架的数据对象都有些什么字段,换言之,我们在写框架的时候需要通过某种机制访问未知的属性。
这个机制被称为反射(反过来让对象告诉我们他是什么),或是自省(让对象自己告诉我们他是什么,好吧我承认括号里是我瞎掰的- -#),用于实现在运行时获取未知对象的信息。反射是个很吓唬人的名词,听起来高深莫测,在一般的编程语言里反射相对其他概念来说稍显复杂,一般来说都是作为高级主题来讲;但在Python中反射非常简单,用起来几乎感觉不到与其他的代码有区别,使用反射获取到的函数和方法可以像平常一样加上括号直接调用,获取到类后可以直接构造实例;不过获取到的字段不能直接赋值,因为拿到的其实是另一个指向同一个地方的引用,赋值只能改变当前的这个引用而已。
以下列出了几个内建方法,可以用来检查或是访问对象的属性。这些方法可以用于任意对象而不仅仅是例子中的Cat实例对象;Python中一切都是对象。
#coding: UTF-8import sys # 模块,sys指向这个模块对象 import inspectdef foo(): pass # 函数,foo指向这个函数对象 class Cat(object): # 类,Cat指向这个类对象 def __init__ (self,name = ' kitty ' ): self.name = name def sayHi(self): # 实例方法,sayHi指向这个方法对象,使用类或实例.sayHi访问 print self.name,' says Hi! ' #访问名为name的字段,使用实例.name访问 cat = Cat() # cat是Cat类的实例对象 print Cat.sayHi # 使用类名访问实例方法时,方法是未绑定的(unbound) print cat.sayHi # 使用实例访问实例方法时,方法是绑定的(bound)cat = Cat('kitty') print cat.name # 访问实例属性 cat.sayHi() #调用实例方法 print dir(cat) # 获取实例的属性名,以列表形式返回 if hasattr(cat, 'name' ): # 检查实例是否有这个属性 setattr(cat,'name' ,'tiger' ) # same as: a.name = 'tiger' print getattr(cat, 'name' ) # same as: print a.name getattr(cat,'sayHi')() # same as: cat.sayHi()
当你对一个你构造的对象使用dir()时,可能会发现列表中的很多属性并不是你定义的。这些属性一般保存了对象的元数据,比如类的__name__属性保存了类名。大部分这些属性都可以修改,不过改动它们意义并不是很大;修改其中某些属性如function.func_code还可能导致很难发现的问题,所以改改name什么的就好了,其他的属性不要在不了解后果的情况下修改。
接下来列出特定对象的一些特殊属性。另外,Python的文档中有提到部分属性不一定会一直提供,下文中将以红色的星号*标记,使用前你可以先打开解释器确认一下。
在types模块中定义了全部的Python内置类型,结合内置方法isinstance()就可以确定对象的具体类型了。
types模块中仅仅定义了类型,而inspect模块中封装了很多检查类型的方法,比直接使用types模块更为轻松,所以这里不给出关于types的更多介绍,如有需要可以直接查看types模块的文档说明。本文第3节中介绍了inspect模块。
import fnmatch as mprint m. __doc__ .splitlines()[0] # Filename matching with shell patterns. print m. __name__ # fnmatch print m. __file__ #/usr/lib/python2.6/fnmatch.pyc print m. __dict__ .items()[0] # ('fnmatchcase', )
#coding: UTF-8import sys # 模块,sys指向这个模块对象 import inspectdef foo(): pass # 函数,foo指向这个函数对象 class Cat(object): # 类,Cat指向这个类对象 def __init__ (self,name = ' kitty ' ): self.name = name def sayHi(self): # 实例方法,sayHi指向这个方法对象,使用类或实例.sayHi访问 print self.name,' says Hi! ' #访问名为name的字段,使用实例.name访问 print Cat.__doc__ # Noneprint Cat. __name__ #Cat print Cat. __module__ #__main__ print Cat. __bases__ #(,) print Cat. __dict__ #{'__module__': '__main__', ...}
实例是指类实例化以后的对象。
import sys # 模块,sys指向这个模块对象 import inspectdef foo(): pass # 函数,foo指向这个函数对象 class Cat(object): # 类,Cat指向这个类对象 def __init__ (self,name = ' kitty ' ): self.name = name def sayHi(self): # 实例方法,sayHi指向这个方法对象,使用类或实例.sayHi访问 print self.name,' says Hi! ' #访问名为name的字段,使用实例.name访问 print cat.__dict__ print cat. __class__ print cat. __class__ == Cat #True
根据定义,内建的(built-in)模块是指使用C写的模块,可以通过sys模块的builtin_module_names字段查看都有哪些模块是内建的。这些模块中的函数和方法可以使用的属性比较少,不过一般也不需要在代码中查看它们的信息。
这里特指非内建的函数。注意,在类中使用def定义的是方法,方法与函数虽然有相似的行为,但它们是不同的概念。
方法虽然不是函数,但可以理解为在函数外面加了一层外壳;拿到方法里实际的函数以后,就可以使用2.5节的属性了。
#coding: UTF-8import sys # 模块,sys指向这个模块对象 import inspectdef foo(): pass # 函数,foo指向这个函数对象 class Cat(object): # 类,Cat指向这个类对象 def __init__ (self,name = ' kitty ' ): self.name = name def sayHi(self): # 实例方法,sayHi指向这个方法对象,使用类或实例.sayHi访问 print self.name,' says Hi! ' #访问名为name的字段,使用实例.name访问 cat = Cat('kitty') im = cat.sayHiprint im.im_funcprint im.im_self #cat print im.im_class #Cat
这里讨论的是一般的实例方法,另外还有两种特殊的方法分别是类方法(classmethod)和静态方法(staticmethod)。类方法还是方法,不过因为需要使用类名调用,所以他始终是绑定的;而静态方法可以看成是在类的命名空间里的函数(需要使用类名调用的函数),它只能使用函数的属性,不能使用方法的属性。
生成器是调用一个生成器函数(generator function)返回的对象,多用于集合对象的迭代。
def gen(): for n in xrange(5): yield ng = gen()print g #print g.gi_code # print g.gi_frame # print g.gi_running #0 print g.next() #0 print g.next() #1 for n in g: print n, #2 3 4
接下来讨论的是几个不常用到的内置对象类型。这些类型在正常的编码过程中应该很少接触,除非你正在自己实现一个解释器或开发环境之类。所以这里只列出一部分属性,如果需要一份完整的属性表或想进一步了解,可以查看文末列出的参考文档。
代码块可以由类源代码、函数源代码或是一个简单的语句代码编译得到。这里我们只考虑它指代一个函数时的情况;2.5节中我们曾提到可以使用函数的func_code属性获取到它。code的属性全部是只读的。
class Cat(object): # 类,Cat指向这个类对象 def __init__ (self,name = ' kitty ' ): self.name = name def sayHi(self): # 实例方法,sayHi指向这个方法对象,使用类或实例.sayHi访问 print self.name,' says Hi! ' #访问名为name的字段,使用实例.name访问 cat = Cat('kitty') co = cat.sayHi.func_codeprint co.co_argcount #1 print co.co_names #('name',) print co.co_varnames #('self',) print co.co_flags &0b100 #0
2.9. 栈帧(frame)
栈帧表示程序运行时函数调用栈中的某一帧。函数没有属性可以获取它,因为它在函数调用时才会产生,而生成器则是由函数调用返回的,所以有属性指向栈帧。想要获得某个函数相关的栈帧,则必须在调用这个函数且这个函数尚未返回时获取。你可以使用sys模块的_getframe()函数、或inspect模块的currentframe()函数获取当前栈帧。这里列出来的属性全部是只读的。
import inspectdef add(x, y=1): f = inspect.currentframe() print f.f_locals #same as locals() print f.f_back # return x + yadd(2)
追踪是在出现异常时用于回溯的对象,与栈帧相反。由于异常时才会构建,而异常未捕获时会一直向外层栈帧抛出,所以需要使用try才能见到这个对象。你可以使用sys模块的exc_info()函数获得它,这个函数返回一个元组,元素分别是异常类型、异常对象、追踪。traceback的属性全部是只读的。
import sysdef div(x, y): try : return x/y except : tb = sys.exc_info()[2] #return (exc_type, exc_value, traceback) print tb print tb.tb_lineno # "return x/y"的行号 div(1, 0)
inspect模块提供一系列函数用于帮助使用自省。下面仅列出较常用的一些函数,想获得全部的函数资料可以查看inspect模块的文档。
import inspectclass Cat(object): # 类,Cat指向这个类对象 def __init__ (self,name = ' kitty ' ): self.name = name def sayHi(self): # 实例方法,sayHi指向这个方法对象,使用类或实例.sayHi访问 print self.name,' says Hi! ' #访问名为name的字段,使用实例.name访问 cat = Cat() # cat是Cat类的实例对象 print Cat.sayHi # 使用类名访问实例方法时,方法是未绑定的(unbound) print cat.sayHi # 使用实例访问实例方法时,方法是绑定的(bound)cat = Cat('kitty') im = cat.sayHiif inspect.isroutine(im): im()对于实现了__call__的类实例,这个方法会返回False。如果目的是只要可以直接调用就需要是True的话,不妨使用 isinstance(obj, collections.Callable)这种形式。我也不知道为什么Callable会在collections模块中,抱歉!我大概是因为collections模块中包含了很多其他的ABC(Abstract Base Class)的缘故吧:)
其他的操作frame和traceback的函数请查阅inspect模块的文档,用的比较少,这里就不多介绍了。
转载地址:http://qvpxx.baihongyu.com/