Python语法详解之decorator装饰器

python 是一门优雅的语言,有些使用方法就像魔法一样。装饰器(decorator)就是一种化腐朽性为神奇的技巧。最近一直都在使用 Tornado 框架,一直还是念念不忘 Flask 。Flask 是我最喜欢的 Python 框架,最早被它吸引也是源自它使用装饰器这个语法糖(Syntactic sugar)来做 Router,让代码看上去就感觉甜甜的。

Tornado 中的 Router 略显平淡,怀念 Flask 的味道,于是很好奇的想知道 Flask 是如何使用这个魔法。通过阅读 Flask 的源码,我们也可以为 Tornado 实现了一个装饰器 Router。

当然对于刚接触 Python 的人,也许很容易理解装饰器本质是设计模式中的装饰器模式。可是 Python 通过@一个实现装饰器的语法糖。下面看下Python语法详解之decorator装饰器。

一、定义

装饰器 decorator 或者称为包装器,是对函数的一种包装。

二、作用

它能使函数的功能得到扩充,而同时不用修改函数本身的代码。它能够增加函数执行前、执行后的行为,而不需对调用函数的代码做任何改变。

三、举例

初始化函数

# 函数hello,输出 hello + name 的字符串 
def hello(name):
    return 'hello ' + name  

希望实现功能:在每一个调用 hello 函数的时候,将输出的字符串用 包住

例如:hello john 变成 hello john

方法一:自定义wrapper函数

这种方法成功修改了函数 hello 的行为,不过需要修改对 hello的调用。

每一个调用hello 的地方,都要给成调用wrapper,并修改参数列表

def hello(name):
    return 'hello ' + name
 
def wrapper(tag, func, *arg, **kvargs):
    tag = "<" + tag + ">"
    return tag + func(*arg, **kvargs) + tag
 
if __name__ == "__main__":
    print(wrapper('p', hello, 'john'))

输出

方法二:自定义decorator函数

为了不改变对 hello的调用。我们需要得到一个新的函数对象,它修改 hello的行为,并用这个对象对 hello赋值。

从而调用 hello的时候,调用的是扩充行为后的 hello

def hello(name):
    return 'hello ' + name
def myDecorator(func, tag):
    def myWrapper(*arg, **kvargs):  # 重新包装func,其参数列表与func一致
        sign = "<" + tag + ">"
        return sign + func(*arg, **kvargs) + sign
 
    return myWrapper
 
hello = myDecorator(hello, "div")  # 用新的函数对象修改hello
 
if __name__ == "__main__":
    print(hello("john")) 

 这样,只要hello被myDecorator 赋值一次,以后再调用hello 时,就调用的是包装后的函数

输出

方法三:python的decorator

python 的装饰器所做的事与方式2类似

它通过语法糖使装饰器看起来更清晰、简介,而不用每次都书写方式2中第7行代码 hello = myDecorator(hello, "div")

def setTag(tag):  # 由于此装饰器需要参数,所以要再套一层
    def myDecorator(func):  # 装饰器的核心,接受函数对象做参数,返回包装后的函数对象
        def myWrapper(*arg, **kvargs):  # 包装的具体过程
            sign = "<" + tag + ">"
            return sign + func(*arg, **kvargs) + sign
 
        return myWrapper
 
    return myDecorator
 
 
@setTag("div")  # 用@标签在定义函数时套上装饰器
def hello(name):
    return 'hello' + name
 
 
if __name__ == '__main__':
    print(hello('john'))

本质上,方式2 与 方式3 完成的是同一件事,只不过方式3 比方式2 代码更简洁,方便。

比如,现在要给 hello 函数套上三个标签

如果用方式2

hello = myDecorator(myDecorator(myDecorator(hello, "body"),"div"),"p")

如果用方式3

@myDecorator("body")
@myDecorator("div")
@myDecorator("p")
def hello(name)
    return 'hello' + name

在多个装饰器嵌套的情况下,python内置的decorator 结构更清晰。

伪代码:

def myDecorator(...):    #定义装饰器,可能带参数
    def decorator(func):    #装饰器核心,以被装饰的函数对象为参数,返回装饰后的函数对象
        def wrapper(*args, **kvargs):    #装饰的过程,参数列表适应不同参数的函数
             ...    #修改函数调用前的行为
             func(*args, **kvargs)    #调用函数
             ...    #修改函数调用后的行为
         return wrapper
     return decorator
 
@myDecorator(...):    #给函数加上装饰器
def myFunc(...):      #自己定义的功能函数
    ...

知识点:

  • 在python中,当*和**符号出现在函数定义的参数中时,表示任意数目参数收集。*arg表示任意多个无名参数,类型为tuple;**kwargs表示关键字参数,为dict,使用时需将*arg放在**kwargs之前,否则会有“SyntaxError: non-keyword arg after keyword arg”的语法错误
  • 在函数调用时,*会以单个元素的形式解包一个元祖,使其成为独立的参数。
  • 在函数调用时,**会以键/值对的形式解包一个字典,使其成为独立的关键字参数。

到此这篇关于Python语法:decorator装饰器的文章就介绍到这了,更多相关Python decorator装饰器内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

你可能感兴趣的:(Python语法详解之decorator装饰器)