Python 高手编程系列十七：装饰器

Python 装饰器的作用是使函数包装与方法包装（一个函数，接受函数并返回其增强函
数）变得更容易阅读和理解。最初的使用场景是在方法定义的开头能够将其定义为类方法
或静态方法。如果不用装饰器语法的话，定义可能会非常稀疏，并且不断重复：
class WithoutDecorators:
def some_static_method():
print(“this is static method”)
some_static_method = staticmethod(some_static_method)
def some_class_method(cls):
print(“this is class method”)
some_class_method = classmethod(some_class_method)
如果用装饰器语法重写的话，代码会更简短，也更容易理解：
class WithDecorators:
@staticmethod
def some_static_method():
print(“this is static method”)
@classmethod
def some_class_method(cls):
print(“this is class method”)
一般语法和可能的实现
装饰器通常是一个命名的对象（不允许使用lambda 表达式），在被（装饰函数）调用时接
受单一参数，并返回另一个可调用对象。这里用的是“可调用（callable）”。而不是之前以为的
“函数”。装饰器通常在方法和函数的范围内进行讨论，但它的适用范围并不局限于此。事实上，
任何可调用对象（任何实现了__call__方法的对象都是可调用的）都可以用作装饰器，它们返
回的对象往往也不是简单的函数，而是实现了自己的__call__方法的更复杂的类的实例。
装饰器语法只是语法糖而已。看下面这种装饰器用法：
@some_decorator
def decorated_function():
pass
这种写法总是可以替换为显式的装饰器调用和函数的重新赋值：
def decorated_function():
pass
decorated_function = some_decorator(decorated_function)
但是，如果在一个函数上使用多个装饰器的话，后一种写法的可读性更差，也非常难以理解。
作为一个函数
编写自定义装饰器有许多方法，但最简单的方法就是编写一个函数，返回包装原始函
数调用的一个子函数。
通用模式如下：
def mydecorator(function):
def wrapped(*args, **kwargs):

在调用原始函数之前，做点什么

result = function(*args, **kwargs)

在函数调用之后，做点什么，

并返回结果

return result

返回 wrapper 作为装饰函数

return wrapped
作为一个类
虽然装饰器几乎总是可以用函数实现，但在某些情况下，使用用户自定义类可能更好。
如果装饰器需要复杂的参数化或者依赖于特定状态，那么这种说法往往是对的。
非参数化装饰器用作类的通用模式如下：
class DecoratorAsClass:
def init(self, function):
self.function = function
def call(self, *args, **kwargs):

在调用原始函数之前，做点什么

result = self.function(*args, **kwargs)

在调用函数之后，做点什么，

并返回结果

return result
参数化装饰器
在实际代码中通常需要使用参数化的装饰器。如果用函数作为装饰器的话，那么解决
方法很简单：需要用到第二层包装。下面一个简单的装饰器示例，给定重复次数，每次被
调用时都会重复执行一个装饰函数：
def repeat(number=3):
“”“多次重复执行装饰函数。
返回最后一次原始函数调用的值作为结果
:param number: 重复次数，默认值是 3
“””
def actual_decorator(function):
def wrapper(*args, **kwargs):
result = None
for _ in range(number):
result = function(*args, **kwargs)
return result
return wrapper
return actual_decorator
这样定义的装饰器可以接受参数：

@repeat(2)
… def foo():
… print(“foo”)
…
foo()
foo
foo
注意，即使参数化装饰器的参数有默认值，但名字后面也必须加括号。带默认参数的
装饰器的正确用法如下：
@repeat()
… def bar():
… print(“bar”)
…
bar()
bar
bar
bar
没加括号的话，在调用装饰函数时会出现以下错误：
@repeat
… def bar():
… pass
…
bar()
Traceback (most recent call last):
File “”, line 1, in
TypeError: actual_ decorator() missing 1 required positional
argument: ‘function’
保存内省的装饰器
使用装饰器的常见错误是在使用装饰器时不保存函数元数据（主要是文档字符串和原始函
数名）。前面所有示例都存在这个问题。装饰器组合创建了一个新函数，并返回一个新对象，
但却完全没有考虑原始函数的标识。这将会使得调试这样装饰过的函数更加困难，也会破坏可
能用到的大多数自动生成文档的工具，因为无法访问原始的文档字符串和函数签名。
但我们来看一下细节。假设我们有一个虚设的（dummy）装饰器，仅有装饰作用，还
有其他一些被装饰的函数：
def dummy_decorator(function):
def wrapped(*args, **kwargs):
“”“包装函数内部文档。”“”
return function(*args, **kwargs)
return wrapped
@dummy_decorator
def function_with_important_docstring():
“”“这是我们想要保存的重要文档字符串。”“”
如果我们在 Python 交互式会话中查看 function_with_important_docstring()，
会注意到它已经失去了原始名称和文档字符串：
function with important _docstring. _name __
‘wrapped’
function with important _docstring. _doc __
‘包装函数内部文档。’
解决这个问题的正确方法，就是使用 functools 模块内置的 wraps()装饰器：
from functools import wraps
def preserving_decorator(function):
@wraps(function)
def wrapped(*args, **kwargs):
“”“包装函数内部文档。”“”
return function(*args, **kwargs)
return wrapped
@preserving_decorator
def function_with_important_docstring():
“”“这是我们想要保存的重要文档字符串。”“”
这样定义的装饰器可以保存重要的函数元数据：
function with important _docstring. _name __
'function with important docstring.’
function with important _docstring. __doc __
‘这是我们想要保存的重要文档字符串。’