Python/反射

反射（reflection），或称“自省”（introspection）是指Python脚本可以得到一个对象的类型、class、属性、方法等信息。在某些时候，需要执行对象的某个方法，或是需要给对象的某个字段赋值，而方法名或是字段名在编写代码时并不能确定，需要通过字符串参数传递的形式输入。

下列函数实现了反射：type(), isinstance(), issubclass(), callable(), dir(), getattr()。

type()函数

type()函数用于找出一个对象的类型。如下例各语句的结果为True：

type(3) is int
type(3.0) is float
type(10**10) is int # Python 3
type(1 + 1j) is complex
type('Hello') is str
type([1, 2]) is list
type([1, [2, 'Hello']]) is list
type({'city': 'Paris'}) is dict
type((1,2)) is tuple
type(set()) is set
type(frozenset()) is frozenset
----
type(3).__name__ == "int"
type('Hello').__name__ == "str"
----
import types, re, Tkinter # For the following examples
type(re) is types.ModuleType
type(re.sub) is types.FunctionType
type(Tkinter.Frame) is types.ClassType
type(Tkinter.Frame).__name__ == "classobj"
type(Tkinter.Frame()).__name__ == "instance"
type(re.compile('myregex')).__name__ == "SRE_Pattern"
type(type(3)) is types.TypeType

type()漠视类的继承："type(3) is object"产生False，而"isinstance(3, object)"产生True.

isinstance()函数

确定一个对象是否为类的一个实例。

下述语句均产生True：

isinstance(3, int)
isinstance([1, 2], list)
isinstance(3, object)
isinstance([1, 2], object)
import Tkinter; isinstance(Tkinter.Frame(), Tkinter.Frame)
import Tkinter; Tkinter.Frame().__class__.__name__ == "Frame"

注意到isinstance提供了比#Type更弱的条件。

函数isinstance与用户定义的class：

class Plant: pass                        # Dummy class
class Tree(Plant): pass                  # Dummy class derived from Plant
tree = Tree()                            # A new instance of Tree class
print isinstance(tree, Tree)             # True
print isinstance(tree, Plant)            # True
print isinstance(tree, object)           # True
print type(tree) is Tree                 # False
print type(tree).__name__ == "instance"  # True
print tree.__class__.__name__ == "Tree"  # True

外部链接:

Built-in Functions # isinstance, python.org
isinstance() considered harmful, canonical.org

issubclass()函数

确定一个类是否为另一个类的子类。不考虑实例。

class Plant: pass                        # Dummy class
class Tree(Plant): pass                  # Dummy class derived from Plant
tree = Tree()                            # A new instance of Tree class
print issubclass(Tree, Plant)            # True
print issubclass(Tree, object)           # False in Python 2
print issubclass(int, object)            # True
print issubclass(tree, Plant)            # Error - tree is not a class

外部链接:

Built-in Functions # issubclass, python.org

鸭子类型

鸭子类型提供了反射的间接方式。即使用一个对象时认为它就像某个类型，同时捕捉对象抛出的异常，这些异常可表示对象不支持该类型的某些特性。

外部链接：

Glossary # duck-typing, python.org

Callable

判断一个对象是否可以被调用。一个类具有__call__()方法则是可调用的。

例子：

callable(2)
- Returns False. Ditto for callable("Hello") and callable([1, 2]).
callable([1,2].pop)
- Returns True, as pop without "()" returns a function object.
callable([1,2].pop())
- Returns False, as [1,2].pop() returns 2 rather than a function object.

外部链接：

Built-in Functions # callable, python.org

Dir()函数

返回对象属性的名字的列表。包括方法。

例如：

dir(3)
dir("Hello")
dir([1, 2])
import re; dir(re)
- Lists names of functions and other objects available in the re module for regular expressions.

外部链接：

Built-in Functions # dir, python.org

Getattr()函数

给定属性的名字（作为字符串），返回对象的属性的值。

例如：

getattr(3, "imag")

对象属性可以通过#Dir获得

外部链接：

Built-in Functions # getattr, python.org

关键字

Python的所有关键字：

import keyword
pykeywords = keyword.kwlist
print keyword.iskeyword("if")      # True
print keyword.iskeyword("True")    # False

外部链接：

32.6. keyword — Testing for Python keywords, python.org

内建

Python内建的对象与函数：

print dir(__builtins__)           # Output the list
print type(__builtins__.list)     # = <type 'type'>
print type(__builtins__.open)     # = <type 'builtin_function_or_method'>
print list is __builtins__.list   # True
print open is __builtins__.open   # True

Links:

28.3. __builtin__ — Built-in objects, python.org
Built-in Functions # dir, python.org

附录

内建方法：访问对象的属性
- 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。
- 　isinstance(object, classinfo):检查object是不是classinfo中列举出的类型，返回布尔值。classinfo可以是一个具体的类型，也可以是多个类型的元组或列表。
　元数据属性
- 模块(module)
  - __doc__: 文档字符串。如果模块没有文档，这个值是None。
  - __name__: 始终是定义时的模块名；即使你使用import .. as 为它取了别名，或是赋值给了另一个变量名。
  - __dict__: 包含了模块里可用的属性名-属性的字典；也就是可以使用模块名.属性名访问的对象。
  - __file__: 包含了该模块的文件路径。需要注意的是内建的模块没有这个属性，访问它会抛出异常
- 类(class)
  - __doc__: 文档字符串。如果类没有文档，这个值是None。
  - __name__: 始终是定义时的类名。
  - __dict__: 包含了类里可用的属性名-属性的字典；也就是可以使用类名.属性名访问的对象。
  - __module__: 包含该类的定义的模块名；需要注意，是字符串形式的模块名而不是模块对象。
  - __bases__: 直接父类对象的元组；但不包含继承树更上层的其他类，比如父类的父类。
- 实例(instance)　是指类实例化以后的对象。
  - __dict__: 包含了可用的属性名-属性字典。
  - __class__: 该实例的类对象。对于类Cat，cat.__class__ == Cat 为 True。
- 内建函数和方法(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: 这个属性保存了函数的参数默认值元组；因为默认值总是靠后的参数才有，所以不使用字典的形式也是可以与参数对应上的。
  - func_code: 这个属性指向一个该函数对应的code对象，code对象中定义了其他的一些特殊属性，将在下文中另外介绍。
  - func_globals: 这个属性指向定义函数时的全局命名空间。
  - func_closure: 这个属性仅当函数是一个闭包时有效，指向一个保存了所引用到的外部函数的变量cell的元组，如果该函数不是一个内部函数，则始终为None。这个属性也是只读的。
- 方法(method)：方法虽然不是函数，但可以理解为在函数外面加了一层外壳。另外还有两种特殊的方法分别是类方法(class　method)和静态方法(static　method)。类方法还是方法，不过因为需要使用类名调用，所以他始终是绑定的；而静态方法可以看成是在类的命名空间里的函数（需要使用类名调用的函数），它只能使用函数的属性，不能使用方法的属性。
  - __doc__: 与函数相同。
  - __name__: 与函数相同。
  - __module__: 与函数相同。
  - im_func: 使用这个属性可以拿到方法里实际的函数对象的引用。另外如果是2.6以上的版本，还可以使用属性名__func__。
  - im_self: 如果是绑定的(bound)，则指向调用该方法的类（如果是类方法）或实例（如果是实例方法），否则为None。如果是2.6以上的版本，还可以使用属性名__self__。
  - im_class: 实际调用该方法的类，或实际调用该方法的实例的类。注意不是方法的定义所在的类，如果有继承关系的话。
- 生成器(generator)：生成器是调用一个生成器函数(generator function)返回的对象，多用于集合对象的迭代。
  - __iter__: 仅仅是一个可迭代的标记。
  - gi_code: 生成器对应的code对象。
  - gi_frame: 生成器对应的frame对象。
  - gi_running: 生成器函数是否在执行。生成器函数在yield以后、执行yield的下一行代码前处于frozen状态，此时这个属性的值为0。
  - next|close|send|throw: 这是几个可调用的方法，并不包含元数据信息，如何使用可以查看生成器的相关文档。
- 代码块(code)：可以由类源代码、函数源代码或是一个简单的语句代码编译得到。这里我们只考虑它指代一个函数时的情况；可以使用函数的func_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模块提供了一系列函数用于帮助使用自省。列出较常用的一些函数：
- 检查对象类型
  - ismodule|isclass|isfunction|ismethod|isbuiltin 检查对象是否为模块、类、函数、方法、内建函数或方法。
  - isroutine(obj) 检查对象是否为函数、方法、内建函数或方法等等可调用类型。
  - isinstance(obj, collections.Callable):可以直接调用就需要是True
- 获取对象信息
  - getmembers(object[, predicate]):是dir()的扩展版，它会将dir()找到的名字对应的属性一并返回，形如[(name, value), ...]。参数predicate是一个方法的引用，如果指定，则应当接受value作为参数并返回一个布尔值，如果为False，相应的属性将不会返回。使用is*作为第二个参数可以过滤出指定类型的属性。
  - getmodule(object):返回object的定义所在的模块对象。
  - get{file|sourcefile}(object):获取object的定义所在的模块的文件名|源代码文件名（如果没有则返回None）。用于内建的对象（内建模块、类、函数、方法）上时会抛出TypeError异常。
  - get{source|sourcelines}(object): 获取object的定义的源代码，以字符串|字符串列表返回。代码无法访问时会抛出IOError异常。只能用于module/class/function/method/code/frame/traceack对象。
  - getargspec(func): 仅用于方法，获取方法声明的参数，返回元组，分别是(普通参数名的列表, *参数名, **参数名, 默认值元组)。如果没有值，将是空列表和3个None。如果是2.6以上版本，将返回一个命名元组(Named Tuple)，即除了索引外还可以使用属性名访问元组中的元素。
  - getargvalues(frame):仅用于栈帧，获取栈帧中保存的该次函数调用的参数值，返回元组，分别是(普通参数名的列表, *参数名, **参数名, 帧的locals())。如果是2.6以上版本，将返回一个命名元组(Named Tuple)，即除了索引外还可以使用属性名访问元组中的元素。
  - getcallargs(func[, *args][, **kwds]): 返回使用args和kwds调用该方法时各参数对应的值的字典。这个方法仅在2.7版本中才有。
  - getmro(cls): 返回一个类型元组，查找类属性时按照这个元组中的顺序。如果是新式类，与cls.__mro__结果一样。但旧式类没有__mro__这个属性，直接使用这个属性会报异常，所以这个方法还是有它的价值的。
  - currentframe(): 返回当前的栈帧对象。

外部链接

2. Built-in Functions, docs.python.org
How to determine the variable type in Python?, stackoverflow.com
Differences between isinstance() and type() in python, stackoverflow.com
W:Reflection (computer_programming)#Python, Wikipedia
W:Type introspection#Python, Wikipedia