几种你可能不知道的Python装饰器使用姿式

在Python中，装饰器是一种十分强大而且好用的语法，一些重复的代码使用装饰器语法的话可以使代码更容易理解及阅读。

所以在这里简单总结了一下Python中装饰器的几种用法以及须要注意的事情。

1、在装饰器中获取被装饰函数的参数

假设咱们在开发web的时候，须要作反爬。要判断接口的访问来源咱们就能够经过下面装饰器的方法来实现：

def mydecorator(func):
    def wrapped(*args, **kwargs):
        print("进入装饰器")
        if args[0]['header'] == 'spider':
            print("code: 400")
            return

        result = func(*args, **kwargs)
        return result

    return wrapped
@mydecorator
def request_page(request):
    print("一个访问请求")
    print("返回了response")
if __name__ == '__main__':
    request = {
        'data': 100,
        'header': 'spider'
    }
    request_page(request)
复制代码

在这个装饰器中，咱们在装饰器中获取了request中的header参数，若是判断访问来源于爬虫，那么便给它返回一个400。

使用装饰器的写法等同于下面不使用装饰器的写法

def mydecorator(*args, **kwargs):
    print("进入函数")
    if args[0]['header'] == 'spider':
        print("code: 400")
        return False
    return True
def request_page(request):
    if not mydecorator(request):
        return
    print("访问一个网页")
    print("获得了response")
if __name__ == '__main__':
    request = {
        'data': 100,
        'header': 'spider'
    }
    request_page(request)
复制代码

在只须要装饰一个函数的时候后面一种写法可能更优于装饰器的写法，可是在须要装饰不少个函数的时候，使用装饰器明显是更好的选择。

2、在装饰器获取函数的返回值

有的时候咱们须要对函数的返回值作出判断，但又不想直接将判断写在函数里的时候，咱们也能够使用装饰器来实现：

def mydecorator(func):
    def wrapped(*args, **kwargs):
        print("进入装饰器")
        result = func(*args, **kwargs)
        if result == 400:
            print("response is 400!")
            return False
        return True
    return wrapped

@mydecorator
def request_page():
    print("访问一个网页")
    print("获得了response")
    return 200

if __name__ == '__main__':
    print(request_page())
复制代码

3、给装饰器传入参数

在实际应用中，咱们有时须要根据函数的执行状态来重复执行。例如在编写爬虫的时候，可能因为网络的缘由会致使一些页面访问失败，这时咱们就须要根据爬虫的返回结果进行重复请求。

def retry(MAXRETRY=3):
    def decorator(func):
        def wrapped(*args, **kwargs):
            print("进入装饰器")

            result = 0
            retry = 1
            while result != 200 and retry <= MAXRETRY:
                result = func(*args, **kwargs)
                print("重试第%s次" % retry)
                retry += 1

            return result

        return wrapped

    return decorator
    
@retry(5)
def request_page():
    print("访问一个网页")
    print("获得了response")
    return 400

复制代码

在这里咱们假设访问一个网页获得400的时候便从新请求。咱们在retry装饰器里传了一个5，这表示咱们但愿重试的最大次数为5次，若是不传入这个值，那么它的默认重试次数则为3次。

在熟悉了基本装饰器的写法后，传参装饰器的写法也十分的好理解了。就是在外面多加了一层函数，用于传入参数。

4、装饰器文档的问题

咱们都知道经过魔术方法__doc__能够获取咱们写在代码中的文档，那么你是否知道使用装饰器后，会形成被包装函数的文档被装饰器的文档覆盖的问题呢。

def request_page():
    ''' request_page 函数文档 :return: '''
    print("访问一个网页")
    print("获得了response")

if __name__ == '__main__':
    print(request_page.__doc__)
复制代码

在上面对上面未使用装饰的代码使用__doc__方法的时候，咱们获得的结果是：

In[3]: request_page.__doc__
Out[3]: '\n    request_page 函数文档\n    :return:\n    '
复制代码

这是咱们理想中的结果！

可是当咱们将上述函数使用装饰器装饰后：

def decorator(func):
    def wrapped(*args, **kwargs):
        ''' 装饰器文档 :param args: :param kwargs: :return: '''
        print("进入装饰器")
        result = func(*args, **kwargs)
        return result

    return wrapped


@decorator
def request_page():
    ''' request_page 函数文档 :return: '''
    print("访问一个网页")
    print("获得了response")
    
复制代码

咱们再一次运行__doc__魔术方法的时候，获得的结果倒是装饰器的内部文档:

In[4]: request_page.__doc__
Out[4]: '\n 装饰器文档\n :param args:\n :param kwargs:\n :return:\n '
In[5]: request_page.__name__
Out[5]: 'wrapped'
复制代码

这个问题会使得咱们的调试变得困难，也会使许多自动文档生成工具失去效果。

解决这个问题的最好办法就是使用 functools包的wraps()模块来将装饰器进行一个包装。

from functools import wraps
def decorator(func):

 @wraps(func)
    def wrapped(*args, **kwargs):
        ''' 装饰器 :param args: :param kwargs: :return: '''
        print("进入装饰器")
        result = func(*args, **kwargs)
        return result
    return wrapped

@decorator
def request_page():
    ''' request_page 函数文档 :return: '''
    print("访问一个网页")
    print("获得了response")
    
复制代码

使用wraps将装饰器装饰后，这样咱们的函数便可以保存它的一些重要数据了。

In[3]: request_page.__doc__
Out[3]: '\n request_page 函数文档\n :return:\n '
In[3]: request_page.__name__
Out[4]: 'request_page'
复制代码

5、使用class的写法来编写装饰器

虽然大多数的装饰器都是经过函数的写法来实现的，但一样的能够经过类的写法来实现装饰器。

使用类的写法，咱们能够实现一些使用函数写法不太好实现的需求。例如记录一个函数执行的次数

class Decorator():
    def __init__(self,func):
        print('类初始化')
        self.func = func
        self.count = 0
    def __call__(self, *args, **kwargs):
        print('进入装饰器')
        result = self.func(*args,**kwargs)
        self.count += 1

        return result
@Decorator
def request_page():
    ''' request_page :return: '''
    print("访问一个网页")
    print("获得了response")
复制代码

6、总结

装饰器是Python里比较高级的一种语法，这里只是介绍了它的几种使用技巧，以及须要注意的问题。借用金庸先生的话，“武功无高低，修为有深浅”。想要更加灵活的使用装饰器，深刻理解它的原理，咱们在平时仍是须要增强基本功的学习！