python装饰器---------@Decorator（二）

傷城~ 2022-04-24 03:54 299阅读 0赞

# 1.定义处理任意函数、任意参数和任意默认值设置的装饰器 #

*  解决方法是使用 \*args 和 \*\*kwargs传递内部包装函数的参数

def timer(func):
        import time
        @wraps(func)
        def f(*args,**kwargs):
            start = time.time()
            result = func(*args,**kwargs)
            end = time.time()
            print("{}execute time is {} s" .format(func.__name__,end-start))
            return result
        return f

# 2.创建装饰器时保留函数元信息（如\_\_name\_\_等不因装饰器的修饰而改变） #

*      问题：你写了一个装饰器作用在某个函数上，但是这个函数的重要的元信息比如名字、文档字符串、注解和参数签名都丢失了。
 *  解决方案--------任何时候你定义装饰器的时候，都应该使用 `functools` 库中的 `@wraps` 装饰器来注解底层包装函数。

code6

from functools import wraps
    
    
    '''计时函数'''
    def timer(func):
        import time
        @wraps(func)
        def f(x,y):
            start = time.time()
            result = func(x,y)
            end = time.time()
            print "{}({},{}) execute time is {} s" .format(func.__name__,x,y,end-start) 
            return result
        return f
     
     
    '''@name表示用name装饰器修饰下一行的函数'''
     
    @timer
    def add(x,y):
        result = x + y
        return x + y
    @timer
    def sub(x,y):
       return x-y
    @timer
    def multi(x,y):
        return x*y
     
     
    '''测试'''
    print add.__name__
    print sub.__name__

输出结果：

![20190414221846537.png][]

有兴趣的同学输出[装饰器（一）][Link 1]这篇博客中code5的 add.\_\_name和sub.\_\_name\_\_看看和上面的代码输出结果有什么比不同。

# 3.定义带参数的装饰器 #

带参数的装饰器如下：

@decorator(x, y, z)
    def func(a, b):
        pass

这个装饰器处理过程跟下面的调用是等效的：

def func(a, b):
        pass
    func = decorator(x, y, z)(func)

`decorator(x, y, z)` 的返回结果必须是一个可调用对象，它接受一个函数作为参数并包装它。

下面我们通过一个具体的例子来看一下带参数的装饰器定义过程：

假设你想写一个装饰器，给函数添加日志功能，同时允许用户指定日志的级别和其他的选项。 下面是这个装饰器的定义和使用示例：

from functools import wraps
    import logging
    
    def logged(level, name=None, message=None):
        """
        Add logging to a function. level is the logging
        level, name is the logger name, and message is the
        log message. If name and message aren't specified,
        they default to the function's module and name.
        """
        def decorate(func):
            logname = name if name else func.__module__
            log = logging.basicConfig(level = level)
            logmsg = message if message else func.__name__
    
            @wraps(func)
            def wrapper(*args, **kwargs):
                logging.log(level, logmsg)
                return func(*args, **kwargs)
            return wrapper
        return decorate
    
    # Example use
    @logged(logging.DEBUG)
    def add(x, y):
        return x + y
    
    @logged(logging.CRITICAL, 'example')
    def spam():
        print('Spam!')
      
        
    add(2,14)    
    spam()

初看起来，这种实现看上去很复杂，但是核心思想很简单。 最外层的函数 `logged()` 接受参数并将它们作用在内部的装饰器函数上面。 内层的函数 `decorate()` 接受一个函数作为参数，然后在函数上面放置一个包装器。 这里的关键点是包装器是可以使用传递给 `logged()` 的参数的。

# 4.解除装饰器 #

*  问题-----------------一个装饰器已经作用在一个函数上，你想撤销它，直接访问原始的未包装的那个函数
 *  解决方案---------假设装饰器是通过 `@wraps` (参考9.2小节)来实现的，那么你可以通过访问 `__wrapped__` 属性来访问原始函数

下面的示例中核心代码为：orign\_add = add.\_\_wrapped\_\_

但是注意，python3.3以上版本中才有\_\_wrapped\_\_属性，因此本次我们用python3.7版本测试

from functools import wraps
    
    
    '''计时函数'''
    def timer(func):
        import time
        @wraps(func)
        def f(x,y):
            start = time.time()
            result = func(x,y)
            end = time.time()
            print("{}({},{}) execute time is {} s" .format(func.__name__,x,y,end-start))
            return result
        return f
     
     
    '''@name表示用name装饰器修饰下一行的函数'''
     
    @timer
    def add(x,y):
        result = x + y
        return x + y
    
    
    orign_add = add.__wrapped__ 
     
    '''测试'''
    print(add(3,2))
    print(orign_add(3,2))

输出结果：

![20190414222823994.png][]

--------------------

注意：

*  该方法尽在python3.3以上版本使用
 *  直接访问未包装的原始函数在调试、内省和其他函数操作时是很有用的。 但是我们这里的方案仅仅适用于在包装器中正确使用了 `@wraps` 或者直接设置了 `__wrapped__` 属性的情况。
 *  如果有多个包装器，那么访问 `__wrapped__` 属性的行为是不可预知的，应该避免这样做
 *  并不是所有的装饰器都使用了 `@wraps` ，因此这里的方案并不全部适用。 特别的，内置的装饰器 `@staticmethod` 和 `@classmethod` 就没有遵循这个约定 (它们把原始函数存储在属性 `__func__` 中)

参考资料：

资料一：[python中解除装饰器][python]

资料二：[创建装饰器时保留函数元信息][Link 2]

资料三：[\*args和\*\*kwargs][args_kwargs]

[20190414221846537.png]: /images/20220220/717348697ebf4d55831476d5cabae0cd.png
[Link 1]: https://blog.csdn.net/goodxin_ie/article/details/89296785
[20190414222823994.png]: /images/20220220/c8b0272eb15d4930b1c968c9acae8447.png
[python]: https://python3-cookbook.readthedocs.io/zh_CN/latest/c09/p03_unwrapping_decorator.html
[Link 2]: https://python3-cookbook.readthedocs.io/zh_CN/latest/c09/p02_preserve_function_metadata_when_write_decorators.html
[args_kwargs]: https://blog.csdn.net/qq_29053519/article/details/78671323