python的反射机制

Posted 2020-10-27 熊猫的黑白照

一、前言

1 def f1():
2     print("f1是这个函数的名字！")
3  
4 s = "f1"
5 print("%s是个字符串" % s)

在上面的代码中，我们必须区分两个概念，f1和“f1"。前者是函数f1的函数名，后者只是一个叫”f1“的字符串，两者是不同的事物。我们可以用f1()的方式调用函数f1，但我们不能用"f1"()的方式调用函数。说白了就是，不能通过字符串来调用名字看起来相同的函数！

二、web实例

　　考虑有这么一个场景，根据用户输入的url的不同，调用不同的函数，实现不同的操作，也就是一个url路由器的功能，这在web框架里是核心部件之一。下面有一个精简版的示例：

　　首先，有一个commons模块，它里面有几个函数，分别用于展示不同的页面，代码如下：

 1 def login():
 2     print("这是一个登陆页面！")
 3  
 4  
 5 def logout():
 6     print("这是一个退出页面！")
 7  
 8  
 9 def home():
10     print("这是网站主页面！")

其次，有一个visit模块，作为程序入口，接受用户输入，展示相应的页面，代码如下：（这段代码是比较初级的写法）

 1 import commons
 2  
 3  
 4 def run():
 5     inp = input("请输入您想访问页面的url：  ").strip()
 6     if inp == "login":
 7         commons.login()
 8     elif inp == "logout":
 9         commons.logout()
10     elif inp == "home":
11         commons.home()
12     else:
13         print("404")
14  
15  
16 if __name__ == ‘__main__‘:
17     run()

我们运行visit.py，输入：home，页面结果如下：

请输入您想访问页面的url：  home
这是网站主页面！

这就实现了一个简单的WEB路由功能，根据不同的url，执行不同的函数，获得不同的页面。

　　然而，让我们考虑一个问题，如果commons模块里有成百上千个函数呢(这非常正常)?。难道你在visit模块里写上成百上千个elif?显然这是不可能的！那么怎么破？

三、反射机制

　　仔细观察visit中的代码，我们会发现用户输入的url字符串和相应调用的函数名好像！如果能用这个字符串直接调用函数就好了！但是，前面我们已经说了字符串是不能用来调用函数的。为了解决这个问题，python为我们提供一个强大的内置函数：getattr!我们将前面的visit修改一下，代码如下：

import commons
 
 
def run():
    inp = input("请输入您想访问页面的url：  ").strip()
    func = getattr(commons,inp)
    func()
 
 
if __name__ == ‘__main__‘:
    run()

首先说明一下getattr函数的使用方法：它接收2个参数，前面的是一个对象或者模块，后面的是一个字符串，注意了！是个字符串！

　　例子中，用户输入储存在inp中，这个inp就是个字符串，getattr函数让程序去commons这个模块里，寻找一个叫inp的成员（是叫，不是等于），这个过程就相当于我们把一个字符串变成一个函数名的过程。然后，把获得的结果赋值给func这个变量，实际上func就指向了commons里的某个函数。最后通过调用func函数，实现对commons里函数的调用。这完全就是一个动态访问的过程，一切都不写死，全部根据用户输入来变化。

　　执行上面的代码，结果和最开始的是一样的。

　　这就是python的反射，它的核心本质其实就是利用字符串的形式去对象（模块）中操作（查找/获取/删除/添加）成员，一种基于字符串的事件驱动！

　　这段话，不一定准确，但大概就是这么个意思。

四、进一步完善

　　上面的代码还有个小瑕疵，那就是如果用户输入一个非法的url，比如jpg，由于在commons里没有同名的函数，肯定会产生运行错误，具体如下：

1 请输入您想访问页面的url：  jpg
2 Traceback (most recent call last):
3   File "F:/Python/pycharm/s13/reflect/visit.py", line 16, in <module>
4     run()
5   File "F:/Python/pycharm/s13/reflect/visit.py", line 11, in run
6     func = getattr(commons,inp)
7 AttributeError: module ‘commons‘ has no attribute ‘jpg‘

那怎么办呢？其实，python考虑的很全面了，它同样提供了一个叫hasattr的内置函数，用于判断commons中是否具有某个成员。我们将代码修改一下：

import commons
 
def run():
    inp = input("请输入您想访问页面的url：  ").strip()
    if hasattr(commons,inp):
        func = getattr(commons,inp)
        func()
    else:
        print("404")
 
if __name__ == ‘__main__‘:
    run()

通过hasattr的判断，可以防止非法输入错误，并将其统一定位到错误页面。

　　其实，研究过python内置函数的朋友，应该注意到还有delattr和setattr两个内置函数。从字面上已经很好理解他们的作用了。

　　python的四个重要内置函数：getattr、hasattr、delattr和setattr较为全面的实现了基于字符串的反射机制。他们都是对内存内的模块进行操作，并不会对源文件进行修改。

hasattr  判断某一个 变量 是否能够.调用一个名字,返回True或者False
getattr  直接获取一个变量中的名字的值
setattr  为一个变量增加或者修改一个属性
delattr  删除一个变量中的属性或者方法

反射类中的名字
getattr(类名,‘静态属性‘)
getattr(类名,‘类方法‘)()
getattr(类名,‘静态方法‘)()

反射对象中的名字
getattr(对象名,‘对象属性‘)
getattr(对象名,‘方法名‘)()

反射模块中的名字
import 模块名
getattr(模块名,‘模块中的变量‘)
getattr(模块名,‘模块中的函数‘)()
getattr(模块名,‘模块中的类名‘)

反射当前模块中的名字
import sys
getattr(sys.modules[__name__],‘变量‘)
getattr(sys.modules[__name__],‘函数‘)()
getattr(sys.modules[__name__],‘类名‘)

sys.modules[__name__]
import sys
print(sys.modules[__name__])  # 所有导入过的模块
{‘字符串数据类型的模块名‘:模块的内存地址}
{‘__main__‘:当前模块的内存地址}