使用functools.wraps消除Python装饰器的副作用

原创 tiangr  2016-12-04 18:26  阅读 223 次

Python装饰器(decorator)在实现的时候,有一些细节需要被注意。例如,被装饰后的函数其实已经是另外一个函数了(函数名等函数属性会发生改变)。这样有时候会对程序造成一些不便,例如笔者想对unittest框架中的一些函数添加自定义的decorator,添加后由于函数名和函数的doc发生了改变,对测试结果有一些影响。所以,Python的functools包中提供了一个叫wraps的decorator来消除这样的副作用。写一个decorator的时候,最好在实现之前加上functools的wrap,它能保留原有函数的名称和docstring。例如:

  1. # -*- coding: UTF-8 -*-
  2. from functools import wraps
  3. def old_decorator(func):
  4.     def wrapper(*args, **kwargs):
  5.         """
  6.         Old wrapper doc string here..
  7.         """
  8.         print("old wrapper.")
  9.         return func(*args, **kwargs)
  10.     return wrapper
  11. @old_decorator
  12. def test_old_decorator():
  13.     """
  14.     This is old decorator..
  15.     """
  16.     print('Call Old Decorator..')
  17.     print(test_old_decorator.__name__, test_old_decorator.__doc__)
  18. def new_decorator(func):
  19.     @wraps(func)
  20.     def wrapper(*args, **kwargs):
  21.         """
  22.         New wrapper doc string here..
  23.         """
  24.         print('new wrapper')
  25.         return func(*args, **kwargs)
  26.     return wrapper
  27. @new_decorator
  28. def test_new_decorator():
  29.     """
  30.     This is new decorator..
  31.     """
  32.     print('Call New Decorator..')
  33.     print(test_new_decorator.__name__, test_new_decorator.__doc__)
  34. def main():
  35.     test_old_decorator()
  36.     test_new_decorator()
  37. if __name__ == '__main__':
  38.     main()

输出结果:

  1. old wrapper.
  2. Call Old Decorator..
  3. wrapper
  4.         Old wrapper doc string here..
  5. new wrapper
  6. Call New Decorator..
  7. test_new_decorator
  8.     This is new decorator..
特别提示:本站资源全部免费下载,因服务器需经费维护,文中部分外链点击后会进入广告,请耐心等待5秒即可跳过广告进入目标页面。如遇页面外链打不开或下载地址失效,您可以在评论中指出错误,或扫描页面底部二维码。
本文地址:http://www.tiangr.com/python-functools-wraps-decorator-function.html
版权声明:本文为原创文章,版权归 tiangr 所有,欢迎分享本文,转载请保留出处!

发表评论


表情