python 装饰器学习与实践

装饰器学习

先假定一个场景
在之前的一篇文章中，分享了一个pyqt5将日志实时展示在gui界面上的功能python在pyqt5+logging+threading模块实时显示日志，现在我们需要当函数发生异常时能将异常信息也打印在界面上，以方便我们对程序进行优化，实现结果类似如下：

但我们程序已经写好，如果对每个函数内容都去做try-except处理无疑是很费时的，这里我们就可以用装饰器对函数进行包装

1、最基本装饰器

装饰器，对现有函数进行装饰，可以在函数执行前、后编写程序来增加功能，实际就是在函数外层嵌套一层函数

# 接收一个函数（不带参数），并在函数执行后，打印一句话
def outer(func):def inner():func()print('我是一个装饰器')return inner@outer
def a():print('我是一个普通函数')if __name__=='__main__':a()print(a.__name__)

执行结果如下：

从图中我们可以看到，第1 ，函数执行后，正常执行了装饰器的语句；第2，函数名变了，这是因为使用一般装饰器时，实际的执行过程是:outer(a)->inner()，inner才是他最终执行的函数，这里如果不想函数名称被装饰器影响，可以使用functools.wraps方法包装传入的函数名：

def outer(func):@functools.wraps(func)def inner():func()print('我是一个装饰器')return inner

包装后执行结果如下：

2、函数带参数的装饰器

在实际编程过程中，我们的函数实际上会带上各种参数的，要想装饰器能适用于各种参数的函数，我们需要在装饰器中接收函数传递进来的参数，如果被装饰的函数入参格式各不相同，我们可以使用如下写法：

# 函数带参数的装饰器
def outer1(func):@functools.wraps(func)def inner(*args, **kwargs):		# 在inner函数后加入参数，即可适用于装饰带参数的函数print('====我是装饰器，装饰函数%s===='%func.__name__)print('位置参数是：',args)print('关键字参数是：',kwargs)func(*args, **kwargs)return inner# 不带参数的函数
@outer1
def test1():print('我是一个普通函数')# 带位置参数的函数
@outer1
def test2(a):print('我带一个位置参数，值是：', a)# 带位置参数和关键字参数的函数
@outer1
def test3(a, b, c='关键1', d='关键2'):print('我带位置参数和关键字参数，他们的值是：', a, b, c, d)if __name__ == '__main__':test1()test2('测试')test3('测试1', '测试2', c='测试3')

执行结果如下：

3、装饰器带参数

假设一个场景，在对多个函数进行装饰的同时又希望加入额外的不同处理，比如对于上一小节的test1、test2、test3，假设他们都需要一个传入一个系数和一个名称才能进行后续计算。我们可以在现有装饰器基础上再往外嵌套一层，来实现自定义参数带入，如下：

# 装饰器带参数
def outerouter(k, name='test'):def outer1(func):@functools.wraps(func)def inner(*args, **kwargs):print('====我是装饰器，装饰函数%s====' % func.__name__)print('我的名称和系数分别是', name, k)print('位置参数是：', args)print('关键字参数是：', kwargs)func(*args, **kwargs)return innerreturn outer1@outerouter(1, '测试1')
def test1():print('我是一个普通函数')# 带位置参数的函数
@outerouter(2.22, '测试2')
def test2(a):print('我带一个位置参数，值是：', a)# 带位置参数和关键字参数的函数
@outerouter(3.3333, '测试3')
def test3(a, b, c='关键1', d='关键2'):print('我带位置参数和关键字参数，他们的值是：', a, b, c, d)if __name__ == '__main__':test1()test2('测试')test3('测试1', '测试2', c='测试3')

执行结果如下：

4、类中函数的装饰器

写一个类，我们把之前章节的test3函数放到类中，如下：

class A:@outer_class(1.234, '类')def test(self, a, b, c='关键1', d='关键2'):print('我带位置参数和关键字参数，他们的值是：', a, b, c, d)if __name__ == '__main__':a = A()a.test3('测试1', '测试2', c='测试3')

由于类中函数实际执行时，第一个位置参数始终都是实例本身，如上，我们在调用实例方法a.test3(‘测试1’, ‘测试2’, c=‘测试3’)时，实际上是执行的test3(a,‘测试1’, ‘测试2’, c=‘测试3’)，因此对类中的实例方法，他的第一个参数始终是实例本身，我们将第3节的装饰器做如下修改后，即可对其进行装饰：

# 类中函数的装饰器
def outer_class(k, name='test'):def outer1(func):@functools.wraps(func)def inner(self, *args, **kwargs):   # 第一个位置参数是固定，代指实例print('====我是装饰器，装饰函数%s====' % func.__name__)print('我的名称和系数分别是', name, k)print('位置参数是：', args)print('关键字参数是：', kwargs)func(self, *args, **kwargs)     # 第一个位置参数是固定，代指实例return innerreturn outer1class A:@outer_class(1.234, '类')def test3(self, a, b, c='关键1', d='关键2'):print('我带位置参数和关键字参数，他们的值是：', a, b, c, d)if __name__ == '__main__':a = A()a.test3('测试1', '测试2', c='测试3')

执行结果如下：

5、装饰器实践

了解装饰器后，我们对之前的日志显示工具做优化: python在pyqt5+logging+threading模块实时显示日志

1. 优化之前的点击按钮后函数，移除方法中的线程创建代码，让方法只专注于解决专一问题，并给一个假的异常抛出用以试验日志装饰器：

    def log_print(self):"""按钮触发的函数"""for i in range(3):logger.info('我正在打印日志%s' % i)logger.info('我等待一秒')time.sleep(1)raise Exception('执行结束了，抛出异常！')

2. 写一个日志装饰器，用于将异常打印到gui界面

def log_info(func):@functools.wraps(func)def inner(self):try:func(self)except:logger.info(traceback.format_exc())return inner

3. 写一个创建线程的装饰器，用以给指定方法创建线程，合方法打印能实时显示在gui界面上

def thread_func(func):@functools.wraps(func)def inner(self):t = threading.Thread(target=func,args=(self,))t.start()return inner

4. 先装饰日志，再装饰多线程（注意一定要先装饰日志函数，否则日志不会打印到界面上，因为线程中的异常不会返回到主线程中，所以这里直接把日志装饰在线程函数中实现），执行结果如下：
   
   两个装饰器分边实现日志打印到界面与多线程实现日志实时打印

6、pyqt5类中方法的装饰器实现时遇到的问题

在pyqt5中的信号触发方法进行装饰器的时候，例如日志装饰器，如果想适用于所有带各种参数的函数，则需要在装饰器中使用*args和**kwargs，就如我们在第4节中所讲：

def log_info(func):@functools.wraps(func)def inner(self, *args, **kwargs):try:func(self, *args, **kwargs)except:logger.info(traceback.format_exc())return innerdef thread_func(func):@functools.wraps(func)def inner(self, *args, **kwargs):t = threading.Thread(target=func, args=(self, *args,), kwargs=kwargs)t.start()return inner

但实际在pyqt5的类中执行时发生异常

打断点调试后发现，入参时args多传了一个False

目前无法确定是哪一步传的这个False，有可能是pyqt5的信号触发的这个，log_bt.clicked.connect(self.log_print)，如果有老师知道的话感谢评论解答一下，感谢！

目前的暂时的处理办法是取args时取后面切片[1:]