python中的装饰器decorator

2023-01-31 00:01:38 python decorator 装饰

装饰器是为了解决以下描述的问题而产生的方法

我们在已有的函数代码的基础上，想要动态的为这个函数增加功能而又不改变原函数的代码

例如有三个函数：

def f1(x):
    return x
def f2(x):
    return x*x
def f3(x):
    return x*x*x

而我们想为这三个函数增加一个函数调用打印功能类似print("call f1()")

如果我们直接修改的话，需要对每个函数的内部进行改写。

所以为了简化代码，我们可以使用python内置的@装饰器的方法，可以做到修饰函数的功能

Python的 decorator 本质上就是一个高阶函数，它接收一个函数作为参数，然后，返回一个新函数。

装饰器可以极大地简化代码，避免每个函数写重复性代码

不带参数的decorator

例如我们可以编写一个@log可以打印函数调用的装饰器

def log(f):
    def fn(x):
        print ('call ' + f.__name__ + '()...')
        return f(x)
    return fn

然后我们可以测试一下

@log
def f1(x):
    return x

a=f1(1)

print(a)

结果

call f1()...
1

但是，对于参数不是一个的函数，调用将报错：

@log
def add(x, y):
    return x + y
print (add(1, 2))

Traceback (most recent call last):
  File "D:/pythonwork/cvworktest/final/practice.py", line 12, in <module>
    print (add(1, 2))
TypeError: fn() takes 1 positional argument but 2 were given

这是因为add() 函数需要传入两个参数，但是 @log 写死了只含一个参数的返回函数。

要让 @log 自适应任何参数定义的函数，可以利用Python的 *args 和 **kw，保证任意个数的参数总是能正常调用：

def log(f):
    def fn(*args, **kw):
        print ('call ' + f.__name__ + '()...')
        return f(*args, **kw)
    return fn

现在，对于任意函数，@log 都能正常工作。

带参数decorator

上面的@log不带任何参数，同样我们可以编写一个带参数的decorator

例如如果有的函数非常重要，希望打印出'[INFO] call xxx()...'，有的函数不太重要，希望打印出'[DEBUG] call xxx()...'，这时

log函数本身就需要传入'INFO'或'DEBUG'这样的参数，类似这样：

@log('DEBUG')
def my_func():
    pass

我们把它翻译成高阶函数就是这样：

my_func = log('DEBUG')(my_func)

展开：

log_decorator = log('DEBUG')
my_func = log_decorator(my_func)

又相当于：

log_decorator = log('DEBUG')
@log_decorator
def my_func():
    pass

所以，带参数的log函数首先返回一个decorator函数，再让这个decorator函数接收my_func并返回新函数：

def log(content):
    def log_decorator(f):
        def fn(*args, **kw):
            print ('[%s] %s()...' % (content, f.__name__))
            return f(*args, **kw)
        return fn
    return log_decorator

@log('DEBUG')
def test():
    pass
print (test())

结果：

[DEBUG] test()...
None

decorator的注意事项：

经过@decorator“改造”后的函数，和原函数相比，除了功能多一点外，还有很重要的一点就是函数自身的改变

在没有decorator的情况下，打印函数名：

def f1(x):
    pass
print (f1.__name__)

结果：

f1

有decorator的情况下，再打印函数名：

def log(f):
    def wrapper(*args, **kw):
        print ('call...')
        return f(*args, **kw)
    return wrapper
@log
def f2(x):
    pass
print (f2.__name__)

结果：

wrapper

由于decorator返回的新函数函数名已经不是'f2'，而是@log内部定义的'wrapper'。这对于那些依赖函数名的代码就会失效。decorator还改变了函数的__doc__等其它属性。如果要让调用者看不出一个函数经过了@decorator的“改造”，就需要把原函数的一些属性复制到新函数中：

def log(f):
    def wrapper(*args, **kw):
        print ('call...')
        return f(*args, **kw)
    wrapper.__name__ = f.__name__
    wrapper.__doc__ = f.__doc__
    return wrapper

这样写decorator很不方便，因为我们也很难把原函数的所有必要属性都一个一个复制到新函数上，所以Python内置的functools可以用来自动化完成这个“复制”的任务：

import functools
def log(f):
    @functools.wraps(f)
    def wrapper(*args, **kw):
        print ('call...')
        return f(*args, **kw)
    return wrapper

注意：对于函数的参数信息哦我们无法确定，因为装饰器与原函数的参数名不一定一样

相关文章