如何理解Python装饰器

Posted 2023-04-11

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

再回到我们的主题

装饰器本质上是一个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
赞同

反对，不会显示你的姓名 参考技术A 简言之，打个比方，我写了一个python的插件，提供给用户使用，但是在使用的过程中我添加了一些功能，可是又不希望用户改变调用的方式，那么该怎么办呢？这个时候就用到了装饰器。
python装饰器就是用于拓展原来函数功能的一种函数，这个函数的特殊之处在于它的返回值也是一个函数，使用python装饰器的好处就是在不用更改原函数的代码前提下给函数增加新的功能。一般而言，我们要想拓展原来函数代码，比较直接的办法就是侵入代码里面修改。
而且装饰器是程序开发中经常会用到的一个功能，用好了装饰器，开发效率如虎添翼，所以这也是Python面试中必问的问题，但对于好多小白来讲，这个功能有点绕，自学时直接绕过去了，然后面试问到了就挂了，因为装饰器是程序开发的基础知识，不懂就太说不过去啦。
讲完装饰器，相信大家对于Python的发展前景也比较感兴趣，随着人工智能的发展，Python作为人工智能的首选语言，自然也是发展得如火如荼。现在入行，肯定是一个好时机！

如何理解python装饰器

如何理解装饰器
python 学习遇到的第一个难点是装饰器。装饰器的作用是不大规模改动代码的情况下，增加功能。
作用：为已经存在的对象添加额外的功能
特点：不需要对对象做任何的代码上的变动。
以一个例子来讲装饰器

import time
def timer(func):
　　def deco():
　　　　start_time=time.time()
　　　　func()
　　　　stop_time=time.time()
　　　　print("run time is %s"%(stop_time-start_time))
　　return deco

@timer
def test1():
　　time.sleep(3)
　　print("in the test1")

 

@timer
def test2():
　　time.sleep(3)
　　print("in the test2")

test1( )
test2( )

例子是在网上找到的，简单的说就是通过 @timer 对进行了函数进行了改造，在很少的代码量的情况下记录了执行时间。
一般在程序中主要是进行日志记录。