一、Python反射机制
Python反射，可以理解为利用字符串的形式去对象中操作成员属性和方法，常见操作就包括了查找、增加、删除、判断等，是一种基于字符串的事件驱动！
解释Python的反射，先提一个简单的需求。考虑有这么一个场景，根据用户输入的url的不同，调用不同的函数，实现不同的操作，也就是一个url路由器的功能，这在web框架里是核心部件之一。比如现在我有一个简易的网站，由两个文件组成，一个是具体执行操作的commons.py文件，一个是入口文件index.py，现在我需要在入口文件中设置，让用户输入url，根据用户输入的url去后端执行相应的操作，内容如下：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
# commons.py def login(): print('登录页面!') def logout(): print('退出页面!') def index(): print('主页面!') # index.py import commons def run(): inp = input("请输入您想访问页面的URL：").strip() if inp == "login": commons.login() elif inp == "logout": commons.logout() elif inp == "index": commons.index() else: print("404") if __name__ == '__main__': run() |
我们运行index.py，输入：index，页面结果如下：
|
1 2 3 |
$ python3 index.py 请输入您想访问页面的URL：index 主页面! |
上面我使用了if判断，根据每一个url请求去后端执行指定的函数。这就实现了一个简单的WEB路由功能，根据不同的url，执行不同的函数，获得不同的页面。那现在如果我的网站内容变多了，在commons.py中有100个页面操作，那么相对应的我在index.py中也要使用if else对这100个页面函数进行手动指定。显然这是不可能的！那么怎么破？这个时候Python反射特性就可以排上用场了。
仔细观察index.py中的代码，我们会发现用户输入的url字符串和相应调用的函数名好像！如果能用这个字符串直接调用函数就好了！但是，字符串是不能用来调用函数的。为了解决这个问题，Python为我们提供了反射的特性，这个需求就变得异常简单了，先不多解释，先看代码（commons.py保持文件不变，还是拿三个页面的操作举例）：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
# index.py import commons def run(): inp = input('请输入您想访问页面的URL：').strip() if hasattr(commons, inp): func = getattr(commons, inp) func() else: print('404') if __name__ == "__main__": run() |
可以看到Python的反射立了大功，使用这几行代码，可以应对commons.py文件中任意多个页面函数的调用！
|
1 2 3 |
$ python3 index.py 请输入您想访问页面的URL：index 主页面! |
接下来我们来详细介绍Python反射中用到的内建函数。
- getattr()
先看下源码中的解释：
|
1 2 3 4 5 6 7 8 9 |
def getattr(object, name, default=None): # known special case of getattr """ getattr(object, name[, default]) -> value Get a named attribute from an object; getattr(x, 'y') is equivalent to x.y. When a default argument is given, it is returned when the attribute doesn't exist; without it, an exception is raised in that case. """ pass |
getattr()函数执行成功后会将参数中对象中的方法赋值给新的变量（会返回参数中指定的对象中的方法）相当于参数中的方法又多了一个栈区的变量去引用
getattr()函数的第一个参数需要是个对象，上面的例子中，我导入了自定义的commons模块，commons就是个对象；第二个参数是指定前面对象中的一个方法名称。getattr(x, 'y') 等价于执行了 x.y。假如第二个参数输入了前面对象中不存在的方法，该函数会抛出异常并退出。所以这个时候，为了程序的健壮性，我们需要先判断一下该对象中有没有这个方法，于是hasattr()函数登场了~~
- hasattr()
还是先看下源码的解释：
|
1 2 3 4 5 6 7 |
def hasattr(*args, **kwargs): # real signature unknown """ Return whether the object has an attribute with the given name. This is done by calling getattr(obj, name) and catching AttributeError. """ pass |
hasattr()函数返回对象是否拥有指定名称的属性，简单的说就是检查在第一个参数的对象中，能否找到与第二参数名相同的方法。源码的解释还说，该函数的实现其实就是调用了getattr()函数，只不过它捕获了异常而已。所以通过这个函数，我们可以先去判断对象中有没有这个方法，有则使用getattr()来获取该方法。
- delattr()
删除指定对象中的指定方法，特别提示：只是在本次运行程序的内存中将该方法删除，并没有影响到文件的内容。
|
1 2 3 4 5 |
import commons print(dir(commons)) delattr(commons, 'index') print(dir(commons)) |
执行结果如下：
|
1 2 |
['__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__', 'index', 'login', 'logout'] ['__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__', 'login', 'logout'] |
- setattr()
|
1 2 3 4 5 6 7 |
def setattr(x, y, v): # real signature unknown; restored from __doc__ """ Sets the named attribute on the given object to the specified value. setattr(x, 'y', v) is equivalent to ``x.y = v'' """ pass |
setattr()函数用来给指定对象中的方法重新赋值（将新的函数体/方法体赋值给指定的对象名）仅在本次程序运行的内存中生效。setattr(x, 'y', v) 等价于 x.y = v
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
# index.py import commons def newindex(): print('new 主页面!') def run(): inp = input('请输入您想访问页面的URL：').strip() if hasattr(commons, inp): setattr(commons, inp, newindex) func = getattr(commons, inp, newindex) func() else: print('404') if __name__ == "__main__": run() |
我们运行以下，看一下结果：
|
1 2 3 |
$ python3 index.py 请输入您想访问页面的URL：index new 主页面! |
Python的四个重要内置函数：getattr、hasattr、delattr和setattr较为全面的实现了基于字符串的反射机制。他们都是对内存内的模块进行操作，并不会对源文件进行修改。
二、动态模块导入
上面的例子是在某个特定的目录结构下才能正常实现的，也就是commons和index模块在同一目录下，并且所有的页面处理函数都在commons模块内。但在现实使用环境中，页面处理函数往往被分类放置在不同目录的不同模块中。比如，现在我又新增了一个account.py这个用户管理类的文件，也需要导入到首页以备调用。
这个时候，我的首页通过反射，只能指定commons模块的方法任意调用，现在新增了account模块，是不是我又要导入account模块并加入if去判断呢？显然不用这么麻烦！Python已经帮我们想到这一点了！最后搬出__import__这个大救星。__import__方法会根据字符串参数，动态的导入同名的模块。
由于模块的导入也需要使用Python反射的特性，所以模块名也要加入到url中，所以现在url请求变成了类似于commons/index的形式。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
# account.py def add_user(): print('添加用户') def del_user(): print('删除用户') # commons.py def login(): print('登录页面!') def logout(): print('退出页面!') def index(): print('主页面') # index.py def run(): inp = input('请输入您想访问页面的URL：').strip() m, f = inp.split('/') obj = __import__(m) if hasattr(obj, f): func = getattr(obj, f) func() else: print('404') if __name__ == "__main__": run() |
运行一下：
|
1 2 3 |
$ python3 index.py 请输入您想访问页面的URL：commons/index 主页面! |
我们来分析一下上面的代码：
首先，我们并没有定义任何一行import语句。
其次，用户的输入inp被要求为类似“commons/index”这种格式，其实也就是模拟web框架里的url地址，斜杠左边指向模块名，右边指向模块中的成员名。
然后，m, f = inp.split(“/”)处理了用户输入，使我们获得的2个字符串，并分别保存在m和f变量里。
接下来，最关键的是obj = __import__(m)这一行，它让程序去导入了m这个变量保存的字符串同名的模块，并将它赋值给obj变量。
最后的调用中，getattr去m模块中调用func成员的含义和以前是一样的。
能体会到__import__的作用了吗，就是把字符串当做模块去导入。import 'sys' 和 import sys 是不一样的，不信你执行一下~~要想导入字符串'sys'只能通过__import__('sys')的方式导入。
同样的，这里也有个小瑕疵！如果我的项目进一步细化分工，现在又多了一层目录结构，如下所示：
|
1 2 3 4 5 6 |
|- index.py |- commons.py |- account.py |- lib |- __init__.py |- connectdb.py |
connectdb.py有如下方法：
|
1 2 |
def mysql(): print('连接成功!') |
现在我想在index页面中调用lib包下connectdb模块中的方法，还是用之前的方式调用可以吗？我们想当然地会这么做：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
# index.py def run(): inp = input('请输入您想访问页面的URL：').strip() m, f = inp.split('/') obj = __import__("lib." + m) if hasattr(obj, f): func = getattr(obj, f) func() else: print('404') if __name__ == "__main__": run() |
改了这么一个地方:obj = __import__(“lib.” + modules)，看起来似乎没什么问题，和import lib.commons的传统方法类似，但实际上运行的时候会有错误。
|
1 2 3 |
$ python3 index.py 请输入您想访问页面的URL：connectdb/mysql 主页面! |
为什么呢？因为对于lib.xxx.xxx.xxx这一类的模块导入路径，__import__默认只会导入最开头的圆点左边的目录，也就是“lib”。你可以通过添加一个print(obj)来验证。
这个问题怎么解决呢？__import__函数中有一个fromlist参数，源码解释说，如果在一个包中导入一个模块，这个参数如果为空，则return这个包对象，如果这个参数不为空，则返回包下面指定的模块对象，于是做出如下修改：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
# index.py def run(): inp = input('请输入您想访问页面的URL：').strip() m, f = inp.split('/') obj = __import__("lib." + m, fromlist=True) print(obj) if hasattr(obj, f): func = getattr(obj, f) func() else: print('404') if __name__ == "__main__": run() |
再次运行：
|
1 2 3 |
$ python3 index.py 请输入您想访问页面的URL：connectdb/mysql 连接成功! |
成功了~~ 但是为了这次成功，我写死了lib前缀，相当于抛弃了commons和account两个导入的功能，所以以上代码并不完善，需求复杂后，还是需要对请求的url做一下判断。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
def run(): inp = input('请输入您想访问页面的URL：').strip() if len(inp.split('/')) == 2: m, f = inp.split('/') obj = __import__(m) if hasattr(obj, f): func = getattr(obj, f) func() else: print('404') elif len(inp.split('/')) == 3: p, m, f = inp.split('/') obj = __import__(p + '.' + m, fromlist=True) if hasattr(obj, f): func = getattr(obj, f) func() else: print('404') else: print('404') if __name__ == "__main__": run() |
如下正确执行方法：
|
1 2 3 4 5 6 7 |
$ python3 index.py 请输入您想访问页面的URL：commons/index 主页面! $ python3 index.py 请输入您想访问页面的URL：lib/connectdb/mysql 连接成功! |
基本上已经接近完美了，虽然重复代码量不高，但我们仍要有一颗消除重复代码的心，最终代码如下：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
def getf(m, f): if hasattr(m, f): func = getattr(m, f) func() else: print('404') def run(): if len(inp.split('/')) == 2: m, f = inp.split('/') obj = __import__(m) getf(obj, f) elif len(inp.split('/')) == 3: p, m, f = inp.split('/') obj = __import__(p + '.' + m, fromlist=True) getf(obj, f) else: print('404') if __name__ == "__main__": inp = input('请输入您想访问页面的URL：') run() |
最后就是，如果万一用户输入错误的模块名呢？比如用户输入了common/index，由于实际上不存在common这个模块，必然会报错！那有没有类似上面hasattr内置函数这么个功能呢？答案是没有！碰到这种，你只能通过异常处理来解决。
三、思考
可能有人会问Python不是有两个内置函数exec和eval吗？他们同样能够执行字符串。比如：
|
1 2 3 4 |
>>> exec("print('haha')") haha >>> eval("print('haha')") haha |
那么直接使用它们不行吗？非要那么费劲地使用getattr，__import__干嘛？
其实，在上面的例子中，围绕的核心主题是如何利用字符串驱动不同的事件，比如导入模块、调用函数等等，这些都是python的反射机制，是一种编程方法、设计模式的体现，凝聚了高内聚、松耦合的编程思想，不能简单的用执行字符串来代替。当然，exec和eval也有它的舞台，在web框架里也经常被使用。
<参考>
http://www.cnblogs.com/Guido-admirers/p/6206212.html
https://docs.lvrui.io/2016/06/16/Python%E5%8F%8D%E5%B0%84%E8%AF%A6%E8%A7%A3/
