Question

如何理解Python装饰器

Answer 1

作者：zhijun liu
链接：http://www.zhihu.com/question/26930016/answer/99243411
来源：知乎
著作权归作者所有，转载请联系作者获得授权。

先来个形象比方

内裤可以用来遮羞，但是到了冬天它没法为我们防风御寒，聪明的人们发明了长裤，有了长裤后宝宝再也不冷了，装饰器就像我们这里说的长裤，在不影响内裤作用的前提下，给我们的身子提供了保暖的功效。

再回到我们的主题

装饰器本质上是一个Python函数，它可以让其他函数在不需要做任何代码变动的前提下增加额外功能，装饰器的返回值也是一个函数对象。它经常用于有切面需求的场景，比如：插入日志、性能测试、事务处理、缓存、权限校验等场景。装饰器是解决这类问题的绝佳设计，有了装饰器，我们就可以抽离出大量与函数功能本身无关的雷同代码并继续重用。概括的讲，装饰器的作用就是为已经存在的对象添加额外的功能。

先来看一个简单例子：
def foo():
print('i am foo')

现在有一个新的需求，希望可以记录下函数的执行日志，于是在代码中添加日志代码：
def foo():
print('i am foo')
logging.info("foo is running")

bar()、bar2()也有类似的需求，怎么做？再写一个logging在bar函数里？这样就造成大量雷同的代码，为了减少重复写代码，我们可以这样做，重新定义一个函数：专门处理日志 ，日志处理完之后再执行真正的业务代码
def use_logging(func):
logging.warn("%s is running" % func.__name__)
func()

def bar():
print('i am bar')

use_logging(bar)

逻辑上不难理解， 但是这样的话，我们每次都要将一个函数作为参数传递给use_logging函数。而且这种方式已经破坏了原有的代码逻辑结构，之前执行业务逻辑时，执行运行bar()，但是现在不得不改成use_logging(bar)。那么有没有更好的方式的呢？当然有，答案就是装饰器。

简单装饰器

def use_logging(func):

def wrapper(*args, **kwargs):
logging.warn("%s is running" % func.__name__)
return func(*args, **kwargs)
return wrapper

def bar():
print('i am bar')

bar = use_logging(bar)
bar()

函数use_logging就是装饰器，它把执行真正业务方法的func包裹在函数里面，看起来像bar被use_logging装饰了。在这个例子中，函数进入和退出时 ，被称为一个横切面(Aspect)，这种编程方式被称为面向切面的编程(Aspect-Oriented Programming)。
@符号是装饰器的语法糖，在定义函数的时候使用，避免再一次赋值操作

def use_logging(func):

def wrapper(*args, **kwargs):
logging.warn("%s is running" % func.__name__)
return func(*args)
return wrapper

@use_logging
def foo():
print("i am foo")

@use_logging
def bar():
print("i am bar")

bar()

如上所示，这样我们就可以省去bar = use_logging(bar)这一句了，直接调用bar()即可得到想要的结果。如果我们有其他的类似函数，我们可以继续调用装饰器来修饰函数，而不用重复修改函数或者增加新的封装。这样，我们就提高了程序的可重复利用性，并增加了程序的可读性。

装饰器在Python使用如此方便都要归因于Python的函数能像普通的对象一样能作为参数传递给其他函数，可以被赋值给其他变量，可以作为返回值，可以被定义在另外一个函数内。

带参数的装饰器
装饰器还有更大的灵活性，例如带参数的装饰器：在上面的装饰器调用中，比如@use_logging，该装饰器唯一的参数就是执行业务的函数。装饰器的语法允许我们在调用时，提供其它参数，比如@decorator(a)。这样，就为装饰器的编写和使用提供了更大的灵活性。
def use_logging(level):
def decorator(func):
def wrapper(*args, **kwargs):
if level == "warn":
logging.warn("%s is running" % func.__name__)
return func(*args)
return wrapper

return decorator

@use_logging(level="warn")
def foo(name='foo'):
print("i am %s" % name)

foo()

上面的use_logging是允许带参数的装饰器。它实际上是对原有装饰器的一个函数封装，并返回一个装饰器。我们可以将它理解为一个含有参数的闭包。当我 们使用@use_logging(level="warn")调用的时候，Python能够发现这一层的封装，并把参数传递到装饰器的环境中。

类装饰器
再来看看类装饰器，相比函数装饰器，类装饰器具有灵活度大、高内聚、封装性等优点。使用类装饰器还可以依靠类内部的\_\_call\_\_方法，当使用 @ 形式将装饰器附加到函数上时，就会调用此方法。

class Foo(object):
def __init__(self, func):
self._func = func

def __call__(self):
print ('class decorator runing')
self._func()
print ('class decorator ending')

@Foo
def bar():
print ('bar')

bar()

functools.wraps
使用装饰器极大地复用了代码，但是他有一个缺点就是原函数的元信息不见了，比如函数的docstring、__name__、参数列表，先看例子：
装饰器
def logged(func):
def with_logging(*args, **kwargs):
print func.__name__ + " was called"
return func(*args, **kwargs)
return with_logging

函数
@logged
def f(x):
"""does some math"""
return x + x * x

该函数完成等价于：

def f(x):
"""does some math"""
return x + x * x
f = logged(f)

不难发现，函数f被with_logging取代了，当然它的docstring，__name__就是变成了with_logging函数的信息了。
print f.__name__ # prints 'with_logging'
print f.__doc__ # prints None

这个问题就比较严重的，好在我们有functools.wraps，wraps本身也是一个装饰器，它能把原函数的元信息拷贝到装饰器函数中，这使得装饰器函数也有和原函数一样的元信息了。
from functools import wraps
def logged(func):
@wraps(func)
def with_logging(*args, **kwargs):
print func.__name__ + " was called"
return func(*args, **kwargs)
return with_logging

@logged
def f(x):
"""does some math"""
return x + x * x

print f.__name__ # prints 'f'
print f.__doc__ # prints 'does some math'

内置装饰器
@staticmathod、@classmethod、@property
装饰器的顺序

@a
@b
@c
def f ():

等效于

f = a(b(c(f)))

编辑于 2016-08-09

8 条评论

感谢
分享

收藏

•

没有帮助

•
举报

•

作者保留权利

收起

4
赞同

反对，不会显示你的姓名

许多人选择编程是因为他们喜欢把时间花在…

4 人赞同

先理解一下闭包的概念吧，之前回答过一个有关闭包和装饰器的问题，可以参考一下：Python 里函数里返回一个函数内部定义的函数？ - 知乎用户的回答

显示全部

先理解一下闭包的概念吧，之前回答过一个有关闭包和装饰器的问题，可以参考一下：
Python 里函数里返回一个函数内部定义的函数？ - 知乎用户的回答

发布于 2014-12-09

2 条评论

感谢
分享

收藏

•

没有帮助

•
举报

•

作者保留权利

1
赞同

反对，不会显示你的姓名

罗伊后端工程师

1 人赞同

内置语法糖 格式优美 逼格较高在代码中使用洽到好处的装饰器瞬间让代码优美很多 写起来也很简单 无参的装饰器参数是要装饰的函数 有参装饰器参数是需要的参数 最后返回的是内部函数 参考http://m.blog.csdn.net/blog/yueguanghaidao/10089181

显示全部

内置语法糖 格式优美 逼格较高
在代码中使用洽到好处的装饰器瞬间让代码优美很多
写起来也很简单 无参的装饰器参数是要装饰的函数 有参装饰器参数是需要的参数 最后返回的是内部函数 参考http://m.blog.csdn.net/blog/yueguanghaidao/10089181

发布于 2014-12-06

添加评论

感谢
分享

收藏

•

没有帮助

•
举报

•

作者保留权利

Chasing Stars.

12 人赞同

之前给出一个链接, 现在尝试用自己方式梳理一下 # 有时爱用蹩脚的英文注释, 唔.>># 先从函数说起def foo1():
print('this is a function')

foo1() # print ... in console.'这是一种最为简单的函数-- 不涉及到任何变量, 参数 只是做了一件不以为然的事儿'…

显示全部

之前给出一个链接, 现在尝试用自己方式梳理一下 # 有时爱用蹩脚的英文注释, 唔.
>>

# 先从函数说起

def foo1():
print('this is a function')

foo1() # print ... in console.

'这是一种最为简单的函数-- 不涉及到任何变量, 参数 只是做了一件不以为然的事儿'

# 函数的域 作用范围 以及一个局部变量
global_string = 'this is a global string, my name is global_string'

def foo2():
# lets see its locals variable
# local variable in foo2
x = 3
print('foo2 locals:', locals())

foo2() # foo2 locals: {'x': 3}
print('-'*40)

# check global variable # gets a dictionary, and global_string inside.
# print('globals:' , globals())

# 一个变量的生存的周期

def foo3():
x = 3
print("x value:" , x)
foo3()

'try to run x += 3'
# x += 5, uncomment when you run.
# get NameError -- x is not defined = x is dead.

# 下面来看带有参数的函数

def foo4(s):
print('<i am foo4, i can print>', s)

foo4('foobar')

## 或者可以多个参数, 甚至是默认的

def foo5(s, repeat= 3):
print('<i am foo5, i can print over and over>', s*repeat)

foo5('foobar')

'if call a function with un-matched arguments, error comes'

# foo5(1,2,3) # TypeError: foo5() takes from 1 to 2 positional arguments but 3 were given
'foo5 能接收1-2个参数, 大哥你给了3个. typeerror'

# 嵌套函数

def outer():
x = 71
def inner():
print('hello, i am inner')
print('outer variable x ',x)
inner()

outer()

'可以看到 内部函数能够访问外部函数的变量'

# 把函数当作一个对象

'查看类的属性 __class__ built-in function'
i = 3
print(i.__class__) # <class 'int'>
print(outer.__class__) # <class 'function'>

'''
# ==> 所以 既然 一个整数i 可以当作某函数的参数,
那么 这里的 函数 outer 当然也可以作为某个函数的参数!
'''

def applyfunc(func,args,repeat=3):
i = 0
repeat = 3 if repeat <= 1 else repeat
while i < repeat:
func(args)
i += 1

def test(s):
print('a test function', s)

applyfunc(test, 'love is important', repeat=3)

'可以看到 通过调用一个函数 applyfunc -- 让一个简单函数运行至少3次'

# Closures 不想翻译成闭包

def outer2():
x = 127
def inner2():
print(x)
return inner2

foobar = outer2()
foobar # print nothing

print(foobar.__closure__) # (<cell at 0x00706230: int object at 0x5C3EC7F0>,)

'可以看到 foobar中封存了一个整数对象 int object at 0x......'

foobar() # print
'x 是outer2中的局部变量, 只有当outer2运行时 x才开始出现.'

## Closures-2

def outer(x):
def inner():
print('inner just print x:', x)
return inner

print1 = outer(1)
print2 = outer(2)

print(print1.__closure__) # int object at 0x5C3EC010>
print(print2.__closure__) # int object at 0x5C3EC020>,

print1()
print2()

#== closure 是Python中一种机制, 对enclosing variables 的一个'储藏柜'

# Decorators 终于到了装饰器

def outer(somefunc):
def inner():
print('have not run ', somefunc.__name__, end='\n')
result = somefunc()
print(result + ' finished' )
return inner

def foo6():
return 'i am foo6'

decorator = outer(foo6)

decorator()

'上例演示了decorator 基本作用 - 以函数作参数, 并且输出一个装饰后的新函数'
'就字面理解下, 原来的函数是个毛坯房 只有一床板凑合睡, 找2装修小工后,爽了.'

# decorator - 2 , look like more useful

class Point(object):
def __init__(self, x, y):
self.x = x
self.y = y

def __repr__(self):
return 'I am a {name}, my attributes: {dict}'.format(name = self.__class__.__name__, dict=self.__dict__)

## definition calculation
def add(a, b):
return Point(a.x + b.x, a.y+b.y)

p1 = Point(500, 10)
print(p1)
p2 = Point(30, -100)
print(add(p1,p2))

'Now we want to do some value-check, to make sure the x, y validation'
'比如我们现在只想要点运算时 作数值的检查: 要求点是 100*100这个范围的 (0-100 这个正方形内) ,对于异常作边界处理'

def wrapper(func):
def checker(a, b):
a. x = max(0, a.x) ; a. y = max(0, a.y)
a. x = min(100, a.x);a. y = min(100, a.y)
b. x = max(0, b.x) ; b. y = max(0, b.y)
b. x = min(100, b.x);b. y = min(100, b.y)
result = Point(a.x +b.x, a.y+b.y)
return result
return checker

add_decorator = wrapper(add)

p1 = Point(500, 10)
p2 = Point(30, -100)
# print(add(p1,p2))
print('decorator !')
print(add_decorator(p1, p2))
#=> after check, it becomes 100+30, 10+0

# 最后 @ 符号

'因为装饰会经常使用, 为了避免上述麻烦的装饰方法 就想到一个简写'

@wrapper
def add_checked(a, b):
return Point(a.x +b.x, a.y+b.y)
print('skilled decorator using @')
print(add_checked(p1, p2))

evernote 文字版, 习惯用这个存了.

'一步步理解Python中的Decorator'
原文参考:

# 'refer: simeonfranklin.com'

推荐阅读:
<Python Cookbook> chapter 9 - Metaprogramming, 9.1 9.2 ...