1. 装饰器
    2. 阅读: 328556
    3. 由于函数也是一个对象,而且函数对象可以被赋值给变量,所以,通过变量也能调用该函数。
    4. >>> def now():
    5. ... print('2015-3-25')
    6. ...
    7. >>> f = now
    8. >>> f()
    9. 2015-3-25
    10. 函数对象有一个__name__属性,可以拿到函数的名字:
    11. >>> now.__name__
    12. 'now'
    13. >>> f.__name__
    14. 'now'
    15. 现在,假设我们要增强now()函数的功能,比如,在函数调用前后自动打印日志,但又不希望修改now()函数的定义,这种在代码运行期间动态增加功能的方式,称之为"装饰器"Decorator)。
    16. 本质上,decorator就是一个返回函数的高阶函数。所以,我们要定义一个能打印日志的decorator,可以定义如下:
    17. def log(func):
    18. def wrapper(*args, **kw):
    19. print('call %s():' % func.__name__)
    20. return func(*args, **kw)
    21. return wrapper
    22. 观察上面的log,因为它是一个decorator,所以接受一个函数作为参数,并返回一个函数。我们要借助Python的@语法,把decorator置于函数的定义处:
    23. @log
    24. def now():
    25. print('2015-3-25')
    26. 调用now()函数,不仅会运行now()函数本身,还会在运行now()函数前打印一行日志:
    27. >>> now()
    28. call now():
    29. 2015-3-25
    30. @log放到now()函数的定义处,相当于执行了语句:
    31. now = log(now)
    32. 由于log()是一个decorator,返回一个函数,所以,原来的now()函数仍然存在,只是现在同名的now变量指向了新的函数,于是调用now()将执行新函数,即在log()函数中返回的wrapper()函数。
    33. wrapper()函数的参数定义是(*args, **kw),因此,wrapper()函数可以接受任意参数的调用。在wrapper()函数内,首先打印日志,再紧接着调用原始函数。
    34. 如果decorator本身需要传入参数,那就需要编写一个返回decorator的高阶函数,写出来会更复杂。比如,要自定义log的文本:
    35. def log(text):
    36. def decorator(func):
    37. def wrapper(*args, **kw):
    38. print('%s %s():' % (text, func.__name__))
    39. return func(*args, **kw)
    40. return wrapper
    41. return decorator
    42. 这个3层嵌套的decorator用法如下:
    43. @log('execute')
    44. def now():
    45. print('2015-3-25')
    46. 执行结果如下:
    47. >>> now()
    48. execute now():
    49. 2015-3-25
    50. 和两层嵌套的decorator相比,3层嵌套的效果是这样的:
    51. >>> now = log('execute')(now)
    52. 我们来剖析上面的语句,首先执行log('execute'),返回的是decorator函数,再调用返回的函数,参数是now函数,返回值最终是wrapper函数。
    53. 以上两种decorator的定义都没有问题,但还差最后一步。因为我们讲了函数也是对象,它有__name__等属性,但你去看经过decorator装饰之后的函数,它们的__name__已经从原来的'now'变成了'wrapper'
    54. >>> now.__name__
    55. 'wrapper'
    56. 因为返回的那个wrapper()函数名字就是'wrapper',所以,需要把原始函数的__name__等属性复制到wrapper()函数中,否则,有些依赖函数签名的代码执行就会出错。
    57. 不需要编写wrapper.__name__ = func.__name__这样的代码,Python内置的functools.wraps就是干这个事的,所以,一个完整的decorator的写法如下:
    58. import functools
    59. def log(func):
    60. @functools.wraps(func)
    61. def wrapper(*args, **kw):
    62. print('call %s():' % func.__name__)
    63. return func(*args, **kw)
    64. return wrapper
    65. 或者针对带参数的decorator
    66. import functools
    67. def log(text):
    68. def decorator(func):
    69. @functools.wraps(func)
    70. def wrapper(*args, **kw):
    71. print('%s %s():' % (text, func.__name__))
    72. return func(*args, **kw)
    73. return wrapper
    74. return decorator
    75. import functools是导入functools模块。模块的概念稍候讲解。现在,只需记住在定义wrapper()的前面加上@functools.wraps(func)即可。
    76. 练习
    77. 请设计一个decorator,它可作用于任何函数上,并打印该函数的执行时间:
    78. # -*- coding: utf-8 -*-
    79. import time, functools
    80. def metric(fn):
    81. print('%s executed in %s ms' % (fn.__name__, 10.24))
    82. return fn
    83. # 测试
    84. @metric
    85. def fast(x, y):
    86. time.sleep(0.0012)
    87. return x + y;
    88. @metric
    89. def slow(x, y, z):
    90. time.sleep(0.1234)
    91. return x * y * z;
    92. f = fast(11, 22)
    93. s = slow(11, 22, 33)
    94. if f != 33:
    95. print('测试失败!')
    96. elif s != 7986:
    97. print('测试失败!')
    98. Run
    99. 小结
    100. 在面向对象(OOP)的设计模式中,decorator被称为装饰模式。OOP的装饰模式需要通过继承和组合来实现,而Python除了能支持OOPdecorator外,直接从语法层次支持decoratorPythondecorator可以用函数实现,也可以用类实现。
    101. decorator可以增强函数的功能,定义起来虽然有点复杂,但使用起来非常灵活和方便。
    102. 请编写一个decorator,能在函数调用的前后打印出'begin call''end call'的日志。
    103. 再思考一下能否写出一个@logdecorator,使它既支持:
    104. @log
    105. def f():
    106. pass
    107. 又支持:
    108. @log('execute')
    109. def f():
    110. pass
    111. 参考源码
    112. decorator.py