因為函數或類別都是對象，它們也能被四處傳遞。它們又是可變對象，可以被更改。在函數或類別物件建立後但綁定到名字前更改之的行為為裝飾(decorator)。
「裝飾器」後面隱藏了兩種意思－一是函數起了裝飾作用，例如，執行真正的工作，另一個是依附於裝飾器語法的表達式，例如， at符號和裝飾函數的名稱。
函數可以透過函數裝飾器語法裝飾：
@decorator # ②
def function(): # ①
pass
登入後複製
#函數以標準方式定義。 ①
以@做為定義為裝飾器函數前綴的表達式②。在 @ 後面的部分必須是簡單的表達式，通常只是函數或類別的名稱。這一部分先求值，在下面的定義的函數準備好後，裝飾器被新定義的函數物件作為單一參數呼叫。裝飾器傳回的值附著到被裝飾的函數名稱。
裝飾器可以應用到函數和類別上。對類別語意很明晰——類別定義被當作參數來呼叫裝飾器，無論傳回什麼都賦給被裝飾的名字。
在裝飾器語法實作前(PEP 318)，透過將函數和類別物件賦給暫存變數然後明確呼叫裝飾器然後將回傳值賦給函數名，可以完成相同的事。這似乎要打更多的字，也確實裝飾器函數名用了兩次同時臨時變數要用至少三次，很容易出錯。以上實例相當於：
def function(): # ①
pass
function = decorator(function) # ②
登入後複製
裝飾器可以堆疊(stacked)－應用的順序是從底到上或從裡到外。就是說最初的函數被當作第一次參數器的參數，無論傳回什麼都被當作第二個裝飾器的參數…無論最後一個裝飾器回傳什麼都被依附到最初函數的名下。
裝飾器語法因其可讀性而被選擇。因為裝飾器在函數頭部前被指定，顯然不是函數體的一部分，它只能對整個函數起作用。以@為前綴的表達式又讓它明顯到不容忽視(根據PEP叫在您臉上…：）)。當多個裝飾器被應用時，每個放在不同的行非常易於閱讀。
取代和調整原始物件
裝飾器可以或傳回相同的函數或類別物件或傳回完全不同的物件。在第一種情況中，裝飾器利用函數或類別物件是可變的添加屬性，例如向類別添加文檔字串(docstring).裝飾器甚至可以在不改變物件的情況下做有用的事，例如在全局註冊表中註冊裝飾的類別。在第二種情況中，簡直無所不能：當什麼不同的東西取代了被裝飾的類別或函數，新物件可以完全不同。然而這不是裝飾器的目的：它們意在改變裝飾物而非做不可預料的事。因此當一個函數在裝飾時被完全取代成不同的函數時，新函數通常在一些準備工作後呼叫原始函數。同樣，當一個類別被裝飾成一個新類別時，新類別通常源自於被裝飾類別。當裝飾器的目的是「每次都」做什麼，像記錄每次對被裝飾函數的調用，只有第二類裝飾器可用。另一方面，如果第一類足夠了，最好使用它因為更簡單。
實作類別和函數裝飾器
對裝飾器惟一的要求是它能夠單一參數呼叫。這意味著裝飾器可以作為常規函數或帶有__call__方法的類別的實現，理論上，甚至lambda函數也行。
讓我們比較函數和類別方法。裝飾器表達式(@後部分)可以只是名字。只有名字的方法很好(打字少，看起來整潔等)，但是只有當無需用參數定制裝飾器時才可能。被寫作函數的裝飾器可以用以下兩種方式：
>>> def simple_decorator(function):
... print "doing decoration"
... return function
>>> @simple_decorator
... def function():
... print "inside function"
doing decoration
>>> function()
inside function
>>> def decorator_with_arguments(arg):
... print "defining the decorator"
... def _decorator(function):
... # in this inner function, arg is available too
... print "doing decoration,", arg
... return function
... return _decorator
>>> @decorator_with_arguments("abc")
... def function():
... print "inside function"
defining the decorator
doing decoration, abc
>>> function()
inside function登入後複製
這兩個裝飾器屬於傳回被裝飾函數的類別。如果它們想傳回新的函數，需要額外的嵌套，最糟的情況下，需要三層嵌套。
>>> def replacing_decorator_with_args(arg):
... print "defining the decorator"
... def _decorator(function):
... # in this inner function, arg is available too
... print "doing decoration,", arg
... def _wrapper(*args, **kwargs):
... print "inside wrapper,", args, kwargs
... return function(*args, **kwargs)
... return _wrapper
... return _decorator
>>> @replacing_decorator_with_args("abc")
... def function(*args, **kwargs):
... print "inside function,", args, kwargs
... return 14
defining the decorator
doing decoration, abc
>>> function(11, 12)
inside wrapper, (11, 12) {}
inside function, (11, 12) {}
14登入後複製
_wrapper函數被定義為接受所有位置和關鍵字參數。通常我們不知道哪些參數被裝飾函數會接受，所以wrapper將所有東西都創遞給被裝飾函數。一個不幸的結果就是顯式參數很困惑人。
比相比定義為函數的裝飾器，定義為類別的複雜裝飾器更簡單。當物件被創建，__init__方法僅允許傳回None，創建的物件類型不能更改。這意味著當裝飾器被定義為類別時，使用無參數的形式沒什麼意義：最終被裝飾的物件只是裝飾類別的一個實例而已，被建構器(constructor)呼叫返回，並不非常有用。討論在裝飾表達式中給出參數的基於類別的裝飾器，__init__方法被用來建立裝飾器。
>>> class decorator_class(object):
... def __init__(self, arg):
... # this method is called in the decorator expression
... print "in decorator init,", arg
... self.arg = arg
... def __call__(self, function):
... # this method is called to do the job
... print "in decorator call,", self.arg
... return function
>>> deco_instance = decorator_class('foo')
in decorator init, foo
>>> @deco_instance
... def function(*args, **kwargs):
... print "in function,", args, kwargs
in decorator call, foo
>>> function()
in function, () {}登入後複製
相對於正常規則(PEP 8)由類別寫成的裝飾器表現得更像函數，因此它們的名字以小寫字母開始。
事實上，建立一個只傳回被裝飾函數的新類別沒什麼意義。物件應該有狀態，這種裝飾器在裝飾器傳回新物件時更有用。
#
>>> class replacing_decorator_class(object):
... def __init__(self, arg):
... # this method is called in the decorator expression
... print "in decorator init,", arg
... self.arg = arg
... def __call__(self, function):
... # this method is called to do the job
... print "in decorator call,", self.arg
... self.function = function
... return self._wrapper
... def _wrapper(self, *args, **kwargs):
... print "in the wrapper,", args, kwargs
... return self.function(*args, **kwargs)
>>> deco_instance = replacing_decorator_class('foo')
in decorator init, foo
>>> @deco_instance
... def function(*args, **kwargs):
... print "in function,", args, kwargs
in decorator call, foo
>>> function(11, 12)
in the wrapper, (11, 12) {}
in function, (11, 12) {}登入後複製
像这样的装饰器可以做任何事，因为它能改变被装饰函数对象和参数，调用被装饰函数或不调用，最后改变返回值。
复制原始函数的文档字符串和其它属性
当新函数被返回代替装饰前的函数时，不幸的是原函数的函数名，文档字符串和参数列表都丢失了。这些属性可以部分通过设置__doc__(文档字符串)，__module__和__name__(函数的全称)、__annotations__(Python 3中关于参数和返回值的额外信息)移植到新函数上，这些工作可通过functools.update_wrapper自动完成。
>>> import functools
>>> def better_replacing_decorator_with_args(arg):
... print "defining the decorator"
... def _decorator(function):
... print "doing decoration,", arg
... def _wrapper(*args, **kwargs):
... print "inside wrapper,", args, kwargs
... return function(*args, **kwargs)
... return functools.update_wrapper(_wrapper, function)
... return _decorator
>>> @better_replacing_decorator_with_args("abc")
... def function():
... "extensive documentation"
... print "inside function"
... return 14
defining the decorator
doing decoration, abc
>>> function
<function function at 0x...>
>>> print function.__doc__
extensive documentation登入後複製
一件重要的东西是从可迁移属性列表中所缺少的：参数列表。参数的默认值可以通过__defaults__、__kwdefaults__属性更改，但是不幸的是参数列表本身不能被设置为属性。这意味着help(function)将显式无用的参数列表，使使用者迷惑不已。一个解决此问题有效但是丑陋的方式是使用eval动态创建wrapper。可以使用外部external模块自动实现。它提供了对decorator装饰器的支持，该装饰器接受wrapper并将之转换成保留函数签名的装饰器。
综上，装饰器应该总是使用functools.update_wrapper或者其它方式赋值函数属性。
标准库中的示例
首先要提及的是标准库中有一些实用的装饰器，有三种装饰器：
classmethod让一个方法变成“类方法”，即它能够无需创建实例调用。当一个常规方法被调用时，解释器插入实例对象作为第一个参数self。当类方法被调用时，类本身被给做第一个参数，一般叫cls。
类方法也能通过类命名空间读取，所以它们不必污染模块命名空间。类方法可用来提供替代的构建器(constructor):
class Array(object):
def __init__(self, data):
self.data = data
@classmethod
def fromfile(cls, file):
data = numpy.load(file)
return cls(data)登入後複製
这比用一大堆标记的__init__简单多了。
staticmethod应用到方法上让它们“静态”，例如，本来一个常规函数，但通过类命名空间存取。这在函数仅在类中需要时有用(它的名字应该以_为前缀)，或者当我们想要用户以为方法连接到类时也有用——虽然对实现本身不必要。
property是对getter和setter问题Python风格的答案。通过property装饰的方法变成在属性存取时自动调用的getter。
>>> class A(object):
... @property
... def a(self):
... "an important attribute"
... return "a value"
>>> A.a
<property object at 0x...>
>>> A().a
'a value'
登入後複製
例如A.a是只读属性，它已经有文档了：help(A)包含从getter方法获取的属性a的文档字符串。将a定义为property使它能够直接被计算，并且产生只读的副作用，因为没有定义任何setter。
为了得到setter和getter，显然需要两个方法。从Python 2.6开始首选以下语法：
class Rectangle(object):
def __init__(self, edge):
self.edge = edge
@property
def area(self):
"""Computed area.
Setting this updates the edge length to the proper value.
"""
return self.edge**2
@area.setter
def area(self, area):
self.edge = area ** 0.5登入後複製
通过property装饰器取代带一个属性(property)对象的getter方法，以上代码起作用。这个对象反过来有三个可用于装饰器的方法getter、setter和deleter。它们的作用就是设定属性对象的getter、setter和deleter(被存储为fget、fset和fdel属性(attributes))。当创建对象时，getter可以像上例一样设定。当定义setter时，我们已经在area中有property对象，可以通过setter方法向它添加setter，一切都在创建类时完成。
之后，当类实例创建后，property对象和特殊。当解释器执行属性存取、赋值或删除时，其执行被下放给property对象的方法。
为了让一切一清二楚[^5]，让我们定义一个“调试”例子：
>>> class D(object):
... @property
... def a(self):
... print "getting", 1
... return 1
... @a.setter
... def a(self, value):
... print "setting", value
... @a.deleter
... def a(self):
... print "deleting"
>>> D.a
<property object at 0x...>
>>> D.a.fget
<function a at 0x...>
>>> D.a.fset
<function a at 0x...>
>>> D.a.fdel
<function a at 0x...>
>>> d = D() # ... varies, this is not the same `a` function
>>> d.a
getting 1
1
>>> d.a = 2
setting 2
>>> del d.a
deleting
>>> d.a
getting 1
1
登入後複製
属性(property)是对装饰器语法的一点扩展。使用装饰器的一大前提——命名不重复——被违反了，但是目前没什么更好的发明。为getter，setter和deleter方法使用相同的名字还是个好的风格。
一些其它更新的例子包括：
functools.lru_cache记忆任意维持有限 参数：结果 对的缓存函数(Python
3.2)
functools.total_ordering是一个基于单个比较方法而填充丢失的比较(ordering)方法(__lt__,__gt__，__le__等等)的类装饰器。
函数的废弃
比如说我们想在第一次调用我们不希望被调用的函数时在标准错误打印一个废弃函数警告。如果我们不想更改函数，我们可用装饰器
class deprecated(object):
"""Print a deprecation warning once on first use of the function.
>>> @deprecated() # doctest: +SKIP
... def f():
... pass
>>> f() # doctest: +SKIP
f is deprecated
"""
def __call__(self, func):
self.func = func
self.count = 0
return self._wrapper
def _wrapper(self, *args, **kwargs):
self.count += 1
if self.count == 1:
print self.func.__name__, 'is deprecated'
return self.func(*args, **kwargs)登入後複製
也可以实现成函数：
def deprecated(func):
"""Print a deprecation warning once on first use of the function.
>>> @deprecated # doctest: +SKIP
... def f():
... pass
>>> f() # doctest: +SKIP
f is deprecated
"""
count = [0]
def wrapper(*args, **kwargs):
count[0] += 1
if count[0] == 1:
print func.__name__, 'is deprecated'
return func(*args, **kwargs)
return wrapper登入後複製
while-loop移除装饰器
例如我们有个返回列表的函数，这个列表由循环创建。如果我们不知道需要多少对象，实现这个的标准方法如下：
def find_answers():
answers = []
while True:
ans = look_for_next_answer()
if ans is None:
break
answers.append(ans)
return answers登入後複製
只要循环体很紧凑，这很好。一旦事情变得更复杂，正如真实的代码中发生的那样，这就很难读懂了。我们可以通过yield语句简化它，但之后用户不得不显式调用嗯list(find_answers())。
我们可以创建一个为我们构建列表的装饰器：
def vectorized(generator_func):
def wrapper(*args, **kwargs):
return list(generator_func(*args, **kwargs))
return functools.update_wrapper(wrapper, generator_func)登入後複製
然后函数变成这样：
@vectorized
def find_answers():
while True:
ans = look_for_next_answer()
if ans is None:
break
yield ans登入後複製
插件注册系统
这是一个仅仅把它放进全局注册表中而不更改类的类装饰器，它属于返回被装饰对象的装饰器。
class WordProcessor(object):
PLUGINS = []
def process(self, text):
for plugin in self.PLUGINS:
text = plugin().cleanup(text)
return text
@classmethod
def plugin(cls, plugin):
cls.PLUGINS.append(plugin)
@WordProcessor.plugin
class CleanMdashesExtension(object):
def cleanup(self, text):
return text.replace('—', u'\N{em dash}')登入後複製
这里我们使用装饰器完成插件注册。我们通过一个名词调用装饰器而不是一个动词，因为我们用它来声明我们的类是WordProcessor的一个插件。plugin方法仅仅将类添加进插件列表。
关于插件自身说下：它用真正的Unicode中的破折号符号替代HTML中的破折号。它利用unicode literal notation通过它在unicode数据库中的名称(“EM DASH”)插入一个符号。如果直接插入Unicode符号，将不可能区分所插入的和源程序中的破折号。
更多Python中装饰器的用法相关文章请关注PHP中文网！
