资讯专栏INFORMATION COLUMN

Python: 会打扮的装饰器

blastz / 633人阅读

摘要:一般情况下,我们使用装饰器提供的语法糖,来简化上面的写法像上面的情况,可以动态修改函数或类功能的函数就是装饰器。本文标题为会打扮的装饰器本文链接为参考资料修饰器的函数式编程中的装饰器介绍思诚之道装饰器入门与提高赖明星

装饰器

我们知道,在 Python 中,我们可以像使用变量一样使用函数:

函数可以被赋值给其他变量

函数可以被删除

可以在函数里面再定义函数

函数可以作为参数传递给另外一个函数

函数可以作为另一个函数的返回

简而言之,函数就是一个对象

对一个简单的函数进行装饰

为了更好地理解装饰器,我们先从一个简单的例子开始,假设有下面的函数:

def hello():
    return "hello world"

现在我们想增强 hello() 函数的功能,希望给返回加上 HTML 标签,比如 hello world,但是有一个要求,不改变原来 hello() 函数的定义。这里当然有很多种方法,下面给出一种跟本文相关的方法:

def makeitalic(func):
    def wrapped():
        return "" + func() + ""
    return wrapped

在上面的代码中,我们定义了一个函数 makeitalic,该函数有一个参数 func,它是一个函数;在 makeitalic 函数里面我们又定义了一个内部函数 wrapped,并将该函数作为返回。

现在,我们就可以不改变 hello() 函数的定义,给返回加上 HTML 标签了:

>>> hello = makeitalic(hello)  # 将 hello 函数传给 makeitalic
>>> hello()
"hello world"

在上面,我们将 hello 函数传给 makeitalic,再将返回赋给 hello,此时调用 hello() 就得到了我们想要的结果。

不过要注意的是,由于我们将 makeitalic 的返回赋给了 hello,此时 hello() 函数仍然存在,但是它的函数名不再是 hello 了,而是 wrapped,正是 makeitalic 返回函数的名称,可以验证一下:

>>> hello.__name__
"wrapped"

对于这个小瑕疵,后文将会给出解决方法。

现在,我们梳理一下上面的例子,为了增强原函数 hello 的功能,我们定义了一个函数,它接收原函数作为参数,并返回一个新的函数,完整的代码如下:

def makeitalic(func):
    def wrapped():
        return "" + func() + ""
    return wrapped

def hello():
    return "hello world"

hello = makeitalic(hello)

事实上,makeitalic 就是一个装饰器(decorator),它『装饰』了函数 hello,并返回一个函数,将其赋给 hello

一般情况下,我们使用装饰器提供的 @ 语法糖(Syntactic Sugar),来简化上面的写法:

def makeitalic(func):
    def wrapped():
        return "" + func() + ""
    return wrapped

@makeitalic
def hello():
    return "hello world"

像上面的情况,可以动态修改函数(或类)功能的函数就是装饰器。本质上,它是一个高阶函数,以被装饰的函数(比如上面的 hello)为参数,并返回一个包装后的函数(比如上面的 wrapped)给被装饰函数(hello)

装饰器的使用形式

装饰器的一般使用形式如下:

@decorator
def func():
    pass

等价于下面的形式:

def func():
    pass
func = decorator(func)

装饰器可以定义多个,离函数定义最近的装饰器先被调用,比如:

@decorator_one
@decorator_two
def func():
    pass

等价于:

def func():
    pass

func = decorator_one(decorator_two(func))

装饰器还可以带参数,比如:

@decorator(arg1, arg2)
def func():
    pass

等价于:

def func():
    pass

func = decorator(arg1, arg2)(func)

下面我们再看一些具体的例子,以加深对它的理解。

对带参数的函数进行装饰

前面的例子中,被装饰的函数 hello() 是没有带参数的,我们看看被装饰函数带参数的情况。对前面例子中的 hello() 函数进行改写,使其带参数,如下:

def makeitalic(func):
    def wrapped(*args, **kwargs):
        ret = func(*args, **kwargs)
        return "" + ret + ""
    return wrapped

@makeitalic
def hello(name):
    return "hello %s" % name
    
@makeitalic
def hello2(name1, name2):
    return "hello %s, %s" % (name1, name2)

由于函数 hello 带参数,因此内嵌包装函数 wrapped 也做了一点改变:

内嵌包装函数的参数传给了 func,即被装饰函数,也就是说内嵌包装函数的参数跟被装饰函数的参数对应,这里使用了 (*args, **kwargs),是为了适应可变参数。

看看使用:

>>> hello("python")
"hello python"
>>> hello2("python", "java")
"hello python, java"
带参数的装饰器

上面的例子,我们增强了函数 hello 的功能,给它的返回加上了标签 ...,现在,我们想改用标签 ...

...

。是不是要像前面一样,再定义一个类似 makeitalic 的装饰器呢?其实,我们可以定义一个函数,将标签作为参数,返回一个装饰器,比如:

def wrap_in_tag(tag):
    def decorator(func):
        def wrapped(*args, **kwargs):
            ret = func(*args, **kwargs)
            return "<" + tag + ">" + ret + ""
        return wrapped

    return decorator

现在,我们可以根据需要生成想要的装饰器了:

makebold = wrap_in_tag("b")  # 根据 "b" 返回 makebold 生成器

@makebold
def hello(name):
    return "hello %s" % name
    
>>> hello("world")
"hello world"

上面的形式也可以写得更加简洁:

@wrap_in_tag("b")
def hello(name):
    return "hello %s" % name

这就是带参数的装饰器,其实就是在装饰器外面多了一层包装,根据不同的参数返回不同的装饰器。

多个装饰器

现在,让我们来看看多个装饰器的例子,为了简单起见,下面的例子就不使用带参数的装饰器。

def makebold(func):
    def wrapped():
        return "" + func() + ""

    return wrapped

def makeitalic(func):
    def wrapped():
        return "" + func() + ""

    return wrapped

@makebold
@makeitalic
def hello():
    return "hello world"

上面定义了两个装饰器,对 hello 进行装饰,上面的最后几行代码相当于:

def hello():
    return "hello world"

hello = makebold(makeitalic(hello))

调用函数 hello

>>> hello()
"hello world"
基于类的装饰器

前面的装饰器都是一个函数,其实也可以基于类定义装饰器,看下面的例子:

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

    def __call__(self, *args, **kwargs):
        return "" + self.func(*args, **kwargs) + ""

@Bold
def hello(name):
    return "hello %s" % name

>>> hello("world")
"hello world"

可以看到,类 Bold 有两个方法:

__init__():它接收一个函数作为参数,也就是被装饰的函数

__call__():让类对象可调用,就像函数调用一样,在调用被装饰函数时被调用

还可以让类装饰器带参数:

class Tag(object):
    def __init__(self, tag):
        self.tag = tag

    def __call__(self, func):
        def wrapped(*args, **kwargs):
            return "<{tag}>{res}".format(
                res=func(*args, **kwargs), tag=self.tag
            )
        return wrapped

@Tag("b")
def hello(name):
    return "hello %s" % name

需要注意的是,如果类装饰器有参数,则 __init__ 接收参数,而 __call__ 接收 func

装饰器的副作用

前面提到,使用装饰器有一个瑕疵,就是被装饰的函数,它的函数名称已经不是原来的名称了,回到最开始的例子:

def makeitalic(func):
    def wrapped():
        return "" + func() + ""
    return wrapped

@makeitalic
def hello():
    return "hello world"

函数 hellomakeitalic 装饰后,它的函数名称已经改变了:

>>> hello.__name__
"wrapped"

为了消除这样的副作用,Python 中的 functool 包提供了一个 wraps 的装饰器:

from functools import wraps

def makeitalic(func):
    @wraps(func)       # 加上 wraps 装饰器
    def wrapped():
        return "" + func() + ""
    return wrapped

@makeitalic
def hello():
    return "hello world"

>>> hello.__name__
"hello"
小结

本质上,装饰器就是一个返回函数的高阶函数。

装饰器可以动态地修改一个类或函数的功能,通过在原有的类或者函数上包裹一层修饰类或修饰函数实现。

事实上,装饰器就是闭包的一种应用,但它比较特别,接收被装饰函数为参数,并返回一个函数,赋给被装饰函数,闭包则没这种限制。

本文由 funhacks 发表于个人博客,采用 Creative Commons BY-NC-ND 4.0(自由转载-保持署名-非商用-禁止演绎)协议发布。
非商业转载请注明作者及出处。商业转载请联系作者本人。
本文标题为: Python: 会打扮的装饰器
本文链接为: https://funhacks.net/2016/11/...

参考资料

Python修饰器的函数式编程 - coolshell

How can I make a chain of function decorators in Python? - Stack Overflow

Python中的装饰器介绍 – 思诚之道

python装饰器入门与提高 | 赖明星

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/44297.html

相关文章

  • Python】一文弄懂python装饰(附源码例子)

    摘要:装饰器的使用符合了面向对象编程的开放封闭原则。三简单的装饰器基于上面的函数执行时间的需求,我们就手写一个简单的装饰器进行实现。函数体就是要实现装饰器的内容。类装饰器的实现是调用了类里面的函数。类装饰器的写法比我们装饰器函数的写法更加简单。 目录 前言 一、什么是装饰器 二、为什么要用装饰器 ...

    liuchengxu 评论0 收藏0
  • Python函数装饰和闭包

    摘要:变量查找规则在中一个变量的查找顺序是局部环境,闭包,全局,内建闭包引用了自由变量的函数。闭包的作用闭包的最大特点是可以将父函数的变量与内部函数绑定,并返回绑定变量后的函数,此时即便生成闭包的环境父函数已经释放,闭包仍然存在。 导语:本文章记录了本人在学习Python基础之函数篇的重点知识及个人心得,打算入门Python的朋友们可以来一起学习并交流。 本文重点: 1、掌握装饰器的本质、功...

    caozhijian 评论0 收藏0
  • Python学习之路26-函数装饰和闭包

    摘要:初步认识装饰器函数装饰器用于在源代码中标记函数,以某种方式增强函数的行为。函数装饰器在导入模块时立即执行,而被装饰的函数只在明确调用时运行。只有涉及嵌套函数时才有闭包问题。如果想保留函数原本的属性,可以使用标准库中的装饰器。 《流畅的Python》笔记本篇将从最简单的装饰器开始,逐渐深入到闭包的概念,然后实现参数化装饰器,最后介绍标准库中常用的装饰器。 1. 初步认识装饰器 函数装饰...

    sunny5541 评论0 收藏0
  • Python装饰

    摘要:一引用书流畅的书二基本概念问题装饰器是什么解答严格来说,装饰器只是语法糖,装饰器是可调用的对象,可以像常规的可调用对象那样调用,特殊的地方是装饰器的参数是一个函数问题装饰器有什么特性解答装饰器有个特性,一是可以把被装饰的函数替换成其他函数, 一, 引用 [书] 流畅的Python [书] Effective Python 二, 基本概念 showImg(https://segme...

    aisuhua 评论0 收藏0
  • Python装饰vs装饰模式

    摘要:希望引以为戒郑传装饰模式如果你了解,你肯定听过装饰器模式。在面向对象中,装饰模式指动态地给一个对象添加一些额外的职责。就增加一些功能来说,装饰模式比生成子类更为灵活。 漫谈 如果作为一个Python入门,不了解Python装饰器也没什么,但是如果作为一个中级Python开发人员,如果再不对python装饰器熟稔于心的话,那么可能并没有量变积累到质变。 我以前也看过很多讲python 装...

    stackvoid 评论0 收藏0

发表评论

0条评论

blastz

|高级讲师

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<