最近在python的代码中,使用装饰器的功能以后,遇到了一个有意思的错误,记录下与大家分享一下,希望大家不会犯同样的错误。
大致代码如下:
- fn_list = {}
-
-
- def decrator(fn):
- fn_list[fn.__name__] = fn
-
-
- @decrator
- def print_test(index):
- print(index)
- return 'success'
-
-
- @decrator
- class TestClass(object):
-
- def __init__(self):
- super(TestClass, self).__init__()
- print("finish init func")
-
-
- ouput_result = fn_list['print_test']('1234')
- print(ouput_result)
- test_instance = fn_list['TestClass']()
运行的时候,在创建TestClass的对象的时候,报错如下:
in __init__
super() argument 1 must be type, not None
检查代码的时候,先查看了fn_list[‘TestClass’]确实指向了对应的类,不是None。
在__init__函数中,输出self,发现是对应类的对象,然后输出TestClass,发现是None。
但是调用同样用装饰器装饰的print_test没有发生问题。
其实问题就出在装饰器函数上,装饰器的作用其实就是在对象(例如函数,类)定义的时候 改变这个对象后续调用过程中的行为,又不改变这个对象内部代码。
以装饰某一个函数为例子,比如装饰器是decrator函数,装饰在print_test函数,那么在函数print_test定义的时候(此时函数print_test不被调用),首先调用了一次print_test = decorator(print_test),对于print_test的函数进行定义。那么,此时指向print_test对象的指针,已经被替换成了指向decorator(print_test)的指针。这里需要注意的是,此时print_test函数已经被覆盖成了新的函数decorator(print_test),即调用decorator函数,并将print_test作为参数传入,得到的返回值,即print_test = decorator(print_test)。
详细的了解了装饰器的工作机制,就不难理解上述问题的出现了。
首先,为什么调用print_test会有正确的结果,这个是因为在装饰器中,保存了print_test的调用入口,并且是通过这个入口调用的(ouput_result = fn_list['print_test']('1234')
)。但是,如果直接调用print_test('1234'),会出错。
其次,创建对象为什么会报错。这个是因为,创建对象调用,从保留的正确入口进行了调用(fn_list['TestClass']()),但是,在类初始化的__init__函数中,调用super的时候,是用的函数名称TestClass进行直接调用的,这个时候,其实TestClass已经在定义的时候,因为调用TestClass = decorator(TestClass) 而变成了None(decorator没有显式指定返回值,所以为默认返回值None),这样就产生了最终的这个错综离奇的报错。
太长不看系列:
装饰器原理,对于用装饰器修饰的函数定义:
@decorator
def func():
pass
在定义时,先调用了func = decorator(func),对于func进行了定义的修改。
由于decorator在我的代码中没有显式定义返回值,则使用的默认返回值None。
于是所有被装饰的函数和类,都被设置为None的变量。
修改办法
- def decrator(fn):
-
- fn_list[fn.__name__] = fn
-
- return fn