python 元数据和inspect

时间 2019-11-17

原文原文链接

引言

首先经过一个例子来看一下本文中可能用到的对象和相关概念。python

#coding: UTF-8
import sys #  模块，sys指向这个模块对象
import inspect

def 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中反射很是简单，用起来几乎感受不到与其余的代码有区别，使用反射获取到的函数和方法能够像日常同样加上括号直接调用，获取到类后能够直接构造实例；不过获取到的字段不能直接赋值，由于拿到的实际上是另外一个指向同一个地方的引用，赋值只能改变当前的这个引用而已。app

访问对象的属性

如下列出了几个内建方法，能够用来检查或是访问对象的属性。这些方法能够用于任意对象而不只仅是例子中的Cat实例对象；Python中一切都是对象。框架

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([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。

访问对象的元数据

对一个对象使用dir()时，可能会发现列表中的不少属性并非类中定义的。这些属性通常保存了对象的元数据，好比类的__name__属性保存了类名。大部分这些属性均可以修改，不过改动它们意义并非很大；修改其中某些属性如function.func_code还可能致使很难发现的问题，因此改改name什么的就行了，其余的属性不要在不了解后果的状况下修改。编程语言

接下来列出特定对象的一些特殊属性。另外，Python的文档中有提到部分属性不必定会一直提供，下文中将以斜体标记，使用前你能够先打开解释器确认一下。函数

准备工做：肯定对象的类型

在types模块中定义了所有的Python内置类型，结合内置方法isinstance()就能够肯定对象的具体类型了。ui

isinstance(object, classinfo): 检查object是否是classinfo中列举出的类型，返回布尔值。classinfo能够是一个具体的类型，也能够是多个类型的元组或列表。

types模块中仅仅定义了类型，而inspect模块中封装了不少检查类型的方法，比直接使用types模块更为轻松，因此这里不给出关于types的更多介绍，若有须要能够直接查看types模块的文档说明。编码

模块(module)

__doc__: 文档字符串。若是模块没有文档，这个值是None。
__name__: 始终是定义时的模块名；即便你使用import .. as 为它取了别名，或是赋值给了另外一个变量名。
__dict__: 包含了模块里可用的属性名-属性的字典；也就是可使用模块名.属性名访问的对象。
__file__: 包含了该模块的文件路径。须要注意的是内建的模块没有这个属性，访问它会抛出异常！

import sys as s

__author__ = 'hgfdo'

print s.__doc__.splitlines()[0]
print s.__name__
print s.__dict__
print s.__file__.items()[0] # 此处因为sys为内建模块，没有__file__属性

类(class)

__doc__: 文档字符串。若是类没有文档，这个值是None。
__name__: 始终是定义时的类名。
__dict__: 包含了类里可用的属性名-属性的字典；也就是可使用类名.属性名访问的对象。
__module__: 包含该类的定义的模块名；须要注意，是字符串形式的模块名而不是模块对象。
__bases__: 直接父类对象的元组；但不包含继承树更上层的其余类，好比父类的父类。

print Cat.__bases__ # (<type 'object'>,)
print Cat.__dict__
print Cat.__doc__
print Cat.__module__    # __main__

实例(instance)

实例是指类实例化之后的对象。code

__dict__: 包含了可用的属性名-属性字典。
__class__: 该实例的类对象。对于类Cat，cat.class == Cat 为 True。

cat = Cat()
print cat.__class__ # <class '__main__.Cat'>

print cat.__dict__  # {'name': 'kitty'}

内建函数和方法(built-in functions and methods)

根据定义，内建的(built-in)模块是指使用C写的模块，能够经过sys模块的builtin_module_names字段查看都有哪些模块是内建的。这些模块中的函数和方法可使用的属性比较少，不过通常也不须要在代码中查看它们的信息。

__doc__: 函数或方法的文档。
__name__: 函数或方法定义时的名字。
__self__: 仅方法可用，若是是绑定的(bound)，则指向调用该方法的类（若是是类方法）或实例（若是是实例方法），不然为None。
__module__: 函数或方法所在的模块名。

函数(function)

这里特指非内建的函数。注意，在类中使用def定义的是方法，方法与函数虽然有类似的行为，但它们是不一样的概念。

__doc__: 函数的文档；另外也能够用属性名func_doc。
__name__: 函数定义时的函数名；另外也能够用属性名func_name。
__module__: 包含该函数定义的模块名；一样注意，是模块名而不是模块对象。
__dict__: 函数的可用属性；另外也能够用属性名func_dict。不要忘了函数也是对象，可使用函数.属性名访问属性（赋值时若是属性不存在将新增一个），或使用内置函数has/get/setattr()访问。不过，在函数中保存属性的意义并不大。
func_defaults/__defaults__: 这个属性保存了函数的参数默认值元组；由于默认值老是靠后的参数才有，因此不使用字典的形式也是能够与参数对应上的。
func_code/__code__: 这个属性指向一个该函数对应的code对象，code对象中定义了其余的一些特殊属性，将在下文中另外介绍。
func_globals/__globals__: 这个属性指向定义函数时的全局命名空间。
func_closure/__closure__: 这个属性仅当函数是一个闭包时有效，指向一个保存了所引用到的外部函数的变量cell的元组，若是该函数不是一个内部函数，则始终为None。这个属性也是只读的。

==闭包==:是引用了自由变量的函数,根据自由变量不一样的值获得不一样的结果。这个被引用的自由变量将和这个函数一同存在，即便已经离开了创造它的环境也不例外。因此，有另外一种说法认为闭包是由函数和与其相关的引用环境组合而成的实体。装饰器就是一种闭包行为，装饰器的概念:对函数(参数,返回值等)进行加工处理,生成一个功能加强版的一个函数。，例如：
def makebold(fn):
   def wrapped():
       return "<b>" + fn() + "</b>"
   return wrapped

@makebold
def hello():
   return "hello world"

print hello()
运行结果：<b>hello world</b>

下面的代码演示了func_closure：

# coding: UTF-8

def foo():
    n = 1
    
    
    def bar():
        print n # 引用非全局的外部变量n，构造一个闭包
    n = 2
    return bar

closure = foo()
print closure.func_closure
# 使用dir()得知cell对象有一个cell_contents属性能够得到值
print closure.func_closure[0].cell_contents # 2

结果：

(<cell at 0x02456AF0: int object at 0x023C774C>,)
2

方法(method)

方法虽然不是函数，但能够理解为在函数外面加了一层外壳；拿到方法里实际的函数之后，就可使用上面提到的函数的属性了。

__doc__: 与函数相同。
__name__: 与函数相同。
*__module__: 与函数相同。
im_func: 使用这个属性能够拿到方法里实际的函数对象的引用。另外若是是2.6以上的版本，还可使用属性名__func__。
im_self: 若是是绑定的(bound)，则指向调用该方法的类（若是是类方法）或实例（若是是实例方法），不然为None。若是是2.6以上的版本，还可使用属性名__self__。
im_class: 实际调用该方法的类，或实际调用该方法的实例的类。注意不是方法的定义所在的类，若是有继承关系的话。

im = cat.sayHi
print im.im_func
print im.im_self # cat
print im.im_class # Cat

==说明==：有两种特殊的方法分别是类方法(classmethod)和静态方法(staticmethod)。

类方法仍是方法，不过由于须要使用类名调用，因此他始终是绑定的

静态方法能够当作是在类的命名空间里的函数（须要使用类名调用的函数），它只能使用函数的属性，不能使用方法的属性。

生成器(generator)

生成器是调用一个生成器函数(generator function)返回的对象，多用于集合对象的迭代。

__iter__: 仅仅是一个可迭代的标记。
gi_code: 生成器对应的code对象。
gi_frame: 生成器对应的frame对象。
gi_running: 生成器函数是否在执行。生成器函数在yield之后、执行yield的下一行代码前处于frozen状态，此时这个属性的值为0。
next|close|send|throw: 这是几个可调用的方法，并不包含元数据信息，如何使用能够查看生成器的相关文档。

def gen():
    for n in xrange(5):
        yield n

g = gen()
print g             # <generator object gen at 0x...>
print g.gi_code     # <code object gen at 0x...>
print g.gi_frame    # <frame object at 0x...>
print g.gi_running  # 0
print g.next()      # 0
print g.next()      # 1
for n in g:
    print n,        # 2 3 4

代码块(code)

代码块能够由类源代码、函数源代码或是一个简单的语句代码编译获得。这里咱们以一个函数为例；可使用函数的func_code或__code__属性获取到它。code的属性所有是只读的。

co_argcount: 普通参数的总数，不包括*参数和**参数。
co_names: 全部的参数名（包括*参数和**参数）和局部变量名的元组。
co_varnames: 全部的局部变量名的元组。
co_filename: 源代码所在的文件名。
co_flags: 这是一个数值，每个二进制位都包含了特定信息。较关注的是0b100(0x4)和0b1000(0x8)，若是co_flags & 0b100 != 0，说明使用了*args参数；若是co_flags & 0b1000 != 0，说明使用了**kwargs参数。另外，若是co_flags & 0b100000(0x20) != 0，则说明这是一个生成器函数(generator function)。

栈帧(frame)

栈帧表示程序运行时函数调用栈中的某一帧。函数没有属性能够获取它，由于它在函数调用时才会产生，而生成器则是由函数调用返回的，因此有属性指向栈帧。想要得到某个函数相关的栈帧，则必须在调用这个函数且这个函数还没有返回时获取。你可使用sys模块的_getframe()函数、或inspect模块的currentframe()函数获取当前栈帧。这里列出来的属性++所有是只读++的。

f_back: 调用栈的前一帧。
f_code: 栈帧对应的code对象。
f_locals: 用在当前栈帧时与内建函数locals()相同，但你能够先获取其余帧而后使用这个属性获取那个帧的locals()。
f_globals: 用在当前栈帧时与内建函数globals()相同。

追踪(traceback)

追踪是在出现异常时用于回溯的对象，与栈帧相反。因为异常时才会构建，而异常未捕获时会一直向外层栈帧抛出，因此须要使用try才能见到这个对象。你可使用sys模块的exc_info()函数得到它，这个函数返回一个元组，元素分别是异常类型、异常对象、追踪。traceback的属性所有是只读的。

tb_next: 追踪的下一个追踪对象。
tb_frame: 当前追踪对应的栈帧。
tb_lineno: 当前追踪的行号。

inspect模块

检查对象类型

is{module|class|function|method|builtin}(obj): 检查对象是否为模块、类、函数、方法、内建函数或方法。
isroutine(obj): 用于检查对象是否为函数、方法、内建函数或方法等等可调用类型。用这个方法会比多个is*()更方便，不过它的实现仍然是用了多个is*()。

i = cat.sayHi
if isroutine(i):
    i()     # 打印 kitty say Hi!

对于实现了__call__的类实例，这个方法会返回False。若是目的是只要能够直接调用就须要是True的话，不妨使用isinstance(obj, collections.Callable)这种形式。

获取对象信息

getmembers(object[, predicate]): 这个方法是dir()的扩展版，它会将dir()找到的名字对应的属性一并返回，形如[(name, value), ...]。另外，predicate是一个方法的引用，若是指定，则应当接受value做为参数并返回一个布尔值，若是为False，相应的属性将不会返回。使用is*做为第二个参数能够过滤出指定类型的属性。
getmodule(object): 它返回object的定义所在的模块对象(__module__属性只返回字符串)。
get{file|sourcefile}(object): 获取object的定义所在的模块的文件名|源代码文件名（若是没有则返回None）。用于内建的对象（内建模块、类、函数、方法）上时会抛出TypeError异常。
get{source|sourcelines}(object): 获取object的定义的源代码，以字符串|字符串列表返回。代码没法访问时会抛出IOError异常。只能用于module/class/function/method/code/frame/traceack对象。其中getsource()返回的是人能识别的与编写代码一致的字符串；getsourcelines()返回的是带缩进的字符串列表，列表的每一项是一个行。
getargspec(func): 仅用于方法，获取方法声明的参数，返回元组，分别是(普通参数名的列表, *参数名, **参数名, 默认值元组)。若是没有值，将是空列表和3个None。若是是2.6以上版本，将返回一个命名元组(Named Tuple)，即除了索引外还可使用属性名访问元组中的元素。

def add(x, y=1, *z):
    return x + y + sum(z)

print inspect.getargspec(add) # ArgSpec(args=['x', 'y'], varargs='z', keywords=None, defaults=(1,))

getargvalues(frame): 仅用于栈帧，获取栈帧中保存的该次函数调用的参数值，返回元组，分别是(普通参数名的列表, *参数名, **参数名, 帧的locals())。若是是2.6以上版本，将返回一个命名元组(Named Tuple)，即除了索引外还可使用属性名访问元组中的元素。

def add(x, y=1, *z):
    print inspect.getargvalues(inspect.currentframe())
    return x + y + sum(z)

add(2) # ArgSpec(args=['x', 'y'], varargs='z', keywords=None, defaults=(1,))

getcallargs(func[, *args][, **kwds]): 返回使用args和kwds调用该方法时各参数对应的值的字典。这个方法仅在2.7版本中才有。

def add(x, y=1, *z):
    return x + y + sum(z)

print inspect.getcallargs(add,(2,)) # {'y': 1, 'x': (2,), 'z': ()}

getmro(cls): 返回一个类型元组，查找类属性时按照这个元组中的顺序。若是是新式类，与cls.__mro__结果同样。但旧式类没有__mro__这个属性，直接使用这个属性会报异常，因此这个方法仍是有它的价值的。

print inspect.getmro(Cat) #(<class '__main__.Cat'>, <type 'object'>)

print Cat.__mro__
#(<class '__main__.Cat'>, <type 'object'>)


class Dog: pass

print inspect.getmro(Dog)
#(<class __main__.Dog at 0x...>,)

print Dog.__mro__ # AttributeError

currentframe(): 返回当前的栈帧对象。