今天介绍的是一个已经存在十年,但是依旧不红的库decorator,github地址 https://github.com/micheles/decorator。
这个库可以帮你做什么呢?可以帮你更方便地写python装饰器代码,不了解装饰器的可以先去阅读之前的文章,更重要的是,让python中被装饰器装饰后的方法长得更像装饰前的方法。这个需求,不得不说,确实很小众,但是需要的时候自己完全从头写出来就相当麻烦了。因此,来了解一下吧。本文主要内容都是参考官方文档,英文和中文一样流利的可以直接阅读官方文档
# 基础定义
在介绍定义前,先补充一个基础概念:signature
,直译过来是签名,python中每个方法都有自己的签名,根据PEP 362可以了解到,方法的签名包含方法的所有必要信息,以及相应的参数信息,在python3中,签名中还包含方法注释,用于标识参数的类型。了解到上面的定义之后,目前的装饰器可以分成两种:
-
签名不变的装饰器,此装饰器是一个可执行对象,输入和输出都是方法,而且输入和输出的方法签名相同。
-
签名改变的装饰器,此装饰器会改变输入方法的签名,或者输出的就不是可执行的方法。
签名改变的装饰器会有特定的用途,比如内置的staticmethod
和classmethod
装饰器,但是大部分场景下,我们需要的都是签名不变的装饰器,因为装饰器的一个很重要的便利之处在于:很方便地增强方法的功能。但是一般情况下,我们写出来的装饰器都会改变装饰器签名,下面会详细介绍。
# 原始装饰器
原始的装饰器一般简单写法是两层嵌套,一个简单的例子如下所示:
上面的装饰器实现一个简单功能,就是在被装饰的代码执行前多打印一行文字,对应于实际中方法执行前的预处理,后续我们使用此装饰器装饰我们的代码,装饰的代码如下所示:
我们此时运行now()
方法,看起来一切正常。但是执行下面的代码:
最终看到的效果是:
看到方法名改变了,now()
方法的方法名变成了wrapper
,而且参数表中参数支持也变成了args
和kw
,原因在于装饰器log装饰了now()
方法后,实际执行的是now = log(now)
,而log()
方法实际返回的就是wrapper()
方法,只是wrapper()
方法也执行了原始now()
方法的代码而已,因此装饰器实际上是通过创建一个新方法执行旧方法的代码而已。这种方法可以帮我们完成所需的功能。但是按照上面的定义,这是一个签名改变的装饰器。一般情况下,我们会使用functools.wraps()
装饰器帮我们解决上面__name__
的问题,但是参数表依旧改变了。
# decorator库
如果使用decorator库,上面的例子可以写成如下所示:
decorator库将原始嵌套的写法改造成单层的写法,因此两层的参数合并了,使用新的log装饰器装饰原来的now()
方法,执行上面代码,最终效果如下所示:
可以看到,被装饰的对象最终展示出来的是__name__
与参数与原始的now()
方法完全一致,使用decorator库实现的装饰器真正实现了签名不变。
同时decorator库还提供了contextmanager,与系统的contextmanager功能一致,不了解系统contextmanager的可以阅读我之前的文章],同时decorator库提供的contextmanager还提供__call__
方法的增强,可以将原始的上下文代码如下所示:
变成如下所示的代码:
即python3.2中实现的GeneratorContextManager
,直译是上下文管理生成器。而decorator提供的contextmanager支持python2,可以简化上下文管理的代码。
# 总结
decorator是一个小众需求,因为原始的装饰器虽然是会导致签名改变,但是大部分场景下我们使用都是Ok的,也可以完成我们的功能。但是如果有需要了解原始参数表的装饰器,比如多层装饰器,那么直接使用decorator库吧,省心省力。