python 装饰器

Posted 2020-08-18

原文地址：https://www.yiibai.com/python/decorator.html

装饰器接收一个功能，添加一些功能并返回。 在本文中，您将学习如何创建装饰器，以及为什么要使用装饰器。

Python有一个有趣的功能，称为装饰器，以便为现有代码添加功能。

这也称为元编程，作为程序的一部分，尝试在编译时修改程序的另一部分。

学习装修器之前需要了解什么？

为了了解装饰器，我们首先在Python中了解一些基本的东西。

Python中的一切(是的，甚至是类)都是对象。 我们定义的名称只是绑定到这些对象的标识符。 函数也不例外，它们也是对象(带有属性)。 各种不同的名称可以绑定到同一个功能对象。

看看下面一个示例 -

def first(msg):
    print(msg)    

first("Hello")

second = first
second("Hello")

Python

当运行代码时，first和second函数都提供相同的输出。 这里名称first和second引用相同的函数对象。

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

如果您在Python中使用了map，filter和reduce等功能，那么您就了解了。

将其他函数作为参数的函数也称为高阶函数。下面是这样子的一个函数的例子。

def inc(x):
    return x + 1

def dec(x):
    return x - 1

def operate(func, x):
    result = func(x)
    return result

Python

我们调用函数如下 -

>>> operate(inc,3)
4
>>> operate(dec,3)
2

Python

此外，一个函数可以返回另一个函数。

def is_called():
    def is_returned():
        print("Hello")
    return is_returned

new = is_called()

#Outputs "Hello"
new()

Python

这里，is_returned()是一个定义的嵌套函数，在每次调用is_called()时返回。

回到装饰器

实际上，实现特殊方法__call__()的任何对象都被称为可调用。 因此，在最基本的意义上，装饰器是可调用的，并且可以返回可调用。

基本上，装饰器接收一个函数，添加一些函数并返回。

def make_pretty(func):
    def inner():
        print("I got decorated")
        func()
    return inner

def ordinary():
    print("I am ordinary")

Python

当在shell中运行以下代码时，如下 -

>>> ordinary()
I am ordinary

>>> # let‘s decorate this ordinary function
>>> pretty = make_pretty(ordinary)
>>> pretty()
I got decorated
I am ordinary

Python

在上面的例子中，make_pretty()是一个装饰器。 在分配步骤。

pretty = make_pretty(ordinary)

Python

函数ordinary()得到了装饰，返回函数的名字：pretty。

可以看到装饰函数为原始函数添加了一些新功能。这类似于包装礼物。 装饰器作为包装纸。 装饰物品的性质(里面的实际礼物)不会改变。 但现在看起来很漂亮(因为装饰了)。

一般来说，我们装饰一个函数并重新分配它，

ordinary = make_pretty(ordinary).

Python

这是一个常见的结构，Python有一个简化的语法。

可以使用@符号和装饰器函数的名称，并将其放在要装饰的函数的定义之上。 例如，

@make_pretty
def ordinary():
    print("I am ordinary")

Python

上面代码相当于 -

def ordinary():
    print("I am ordinary")
ordinary = make_pretty(ordinary)

Python

用参数装饰函数

上面的装饰器很简单，只适用于没有任何参数的函数。 如果有函数要接受如下的参数怎么办？

def divide(a, b):
    return a/b

Python

该函数有两个参数a和b。 我们知道，如果将b的值设置为0并传递那么是会出错的。

>>> divide(2,5)
0.4
>>> divide(2,0)
Traceback (most recent call last):
...
ZeroDivisionError: division by zero

Python

现在使用一个装饰器来检查这个错误。

def smart_divide(func):
   def inner(a,b):
      print("I am going to divide",a,"and",b)
      if b == 0:
         print("Whoops! cannot divide")
         return

      return func(a,b)
   return inner

@smart_divide
def divide(a,b):
    return a/b

Python

如果发生错误，这个新的实现将返回None。

>>> divide(2,5)
I am going to divide 2 and 5
0.4

>>> divide(2,0)
I am going to divide 2 and 0
Whoops! cannot divide

Python

以这种方式就可以装饰函数的参数了。

应该会注意到，装饰器中嵌套的inner()函数的参数与其装饰的函数的参数是一样的。 考虑到这一点，现在可以让一般装饰器使用任何数量的参数。

在Python中，这个由function(* args，** kwargs)完成。 这样，args将是位置参数的元组，kwargs将是关键字参数的字典。这样的装饰器的例子将是。

def works_for_all(func):
    def inner(*args, **kwargs):
        print("I can decorate any function")
        return func(*args, **kwargs)
    return inner

Python

在Python中链接装饰器

多个装饰器可以在Python中链接。

这就是说，一个函数可以用不同(或相同)装饰器多次装饰。只需将装饰器放置在所需函数之上。

def star(func):
    def inner(*args, **kwargs):
        print("*" * 30)
        func(*args, **kwargs)
        print("*" * 30)
    return inner

def percent(func):
    def inner(*args, **kwargs):
        print("%" * 30)
        func(*args, **kwargs)
        print("%" * 30)
    return inner

@star
@percent
def printer(msg):
    print(msg)
printer("Hello")

Python

执行上面代码，将输出结果如下 -

******************************
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Hello
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
******************************

Python

以上语法，

@star
@percent
def printer(msg):
    print(msg)

Python

相当于以下 -

# 会吧percent当做参数传给start函数，首先会执行start函数

def printer(msg):

    print(msg)
printer = star(percent(printer))

Python

链装饰器的顺序是重要的。 所以如果把顺序颠倒了执行结果就不一样了，如下 -

@percent
@star
def printer(msg):
    print(msg)

Python

执行上面代码，将输出结果如下 -

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
******************************
Hello
******************************
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%