Python的装饰器

Python允许使用装饰器对函数进行装饰,这样编写函数时就可以专注于功能的实现,而装饰器可以帮助函数实现一些通用的功能,在函数调用前运行写预备代码或函数调用后执行些清理工作.比如:插入日志,检测性能和事务管理.

装饰器实质上还是一个函数,用来包装别的函数的函数.包装后返回一个装饰后的函数对象,该函数对象将更新原函数对象,程序将不再能访问原原始函数对象.

装饰器使用过程:

1. 定义装饰器函数,假设装饰器函数的名称为decl;
2. 使用装饰器,即@decol

1 无参数装饰器

无参数装饰器格式:

@decol
def fun1():
    ...

以上等价于fun1 = decol1(fun1);

Python也允许使用多个装饰器修饰一个函数,如:

@decol1
@decol2
def fun1():
    ...

以上代码等价于fun1 = decol1(decol2(fun1)).

一下我们通过例子看无参数装饰器的使用:

import time 

# 定义一个计时函数,其参数为一个函数,用于接受被装饰的函数
def time_stt(func):
    # 定义一个内嵌的包装函数,记录函数开始时间和结束时间
    def wrapper():
        start = time.time()
        func()
        usetime = time.time() - start
        print("执行函数%s用时%ds"%(func.__name__,usetime))
    return wrapper

# 调用装饰器
@time_stt
def test():
    time.sleep(4)
    
# 测试结果
test()

以上定义的装饰器函数time_stt可以装饰所有没有参数的函数,统计其用时.但如果用其装饰有参数的函数时就会出错:

import time 

# 定义一个计时函数,其参数为一个函数,用于接受被装饰的函数
def time_stt(func):
    # 定义一个内嵌的包装函数,记录函数开始时间和结束时间
    def wrapper():
        start = time.time()
        func()
        usetime = time.time() - start
        print("执行函数%s用时%ds"%(func.__name__,usetime))
    return wrapper

# 调用装饰器
@time_stt
def test(n):
    time.sleep(n)
    
# 测试结果
test(4)

### TypeError: wrapper() takes 0 positional arguments but 1 was given

这是因为调用使用decol装饰test(4)函数时,实质上是执行wrapper(4),然而以上我们定义的wrapper是一个无参函数.如何改正这个错误,并让装饰器函数decol能够装饰有任意多个任意参数的函数呢?这需要用到可变数量参数.

import time 

# 定义一个计时函数,其参数为一个函数,用于接受被装饰的函数
def time_stt(func):
    # 定义一个内嵌的包装函数,记录函数开始时间和结束时间
    def wrapper(*t,**d):
        start = time.time()
        func(*t,**d)
        usetime = time.time() - start
        print("执行函数%s用时%ds"%(func.__name__,usetime))
    return wrapper

# 调用装饰器
@time_stt
def test(n):
    time.sleep(n)
    
# 测试结果
test(4)

2 带参数装饰器

@deco(deco_arg)
def fun():
    ...

以上等价于fun = deco(deco_arg)(fun).

和无参数装饰器比较可知,带参数装饰器起装饰作用的是deco(deco_arg),即deco函数返回值必须是一个函数.

 

import time 

# 采用带参数的装饰器函数
# 根据装饰器的参数选择是记录函数开始调用的时间韩式函数结束的时间
def deco(sel):
    def startdec(func):
        def r(*t,**d):
            print(func.__name__,"开始调用的时间为:",time.ctime())
            func(*t,**d)
        return r
    def enddec(func):
        def r(*t,**d):
            func(*t,**d)
            print(func.__name__,"结束的时间为:",time.ctime())
        return r
    
    try:
        return {'start':startdec,'end':enddec}[sel]
    except KeyError as e:
        raise(ValueError(e),'必须是start或end')
        
@deco('end')
def sp(seq):
    for n in seq:
        print(n)
        
sp([i for i in range(6)])