Python decorator装饰器

文中知识点和代码示例学习自慕课网,python进阶部分(http://www.imooc.com/learn/317) .学习笔记

装饰器的理解

装饰器本质上是一个高阶函数,接受一个函数,进行处理,然后返回一个新的函数。

# 有一个简单的函数
def f1(x):
    return x * 2
print f1(5)

#输出:10

# 实现运行该函数时,输出该函数的名称的日志功能
# 法一:直接在函数中写出,好理解,但是如果函数很多,那每个函数都要加一遍
def f1(x):
    print "call " + f1.__name__ + "().."
    return x*2
print f1(5)

#输出:
#call f1()..
#10

# 法二:使用装饰器,创建装饰器函数
def flog(f):        #定义装饰器函数,接受参数是 f 函数
    def fn(x):      #定义新的函数,来处理 f 函数,添加我们需要的日志信息,并返回 f 函数,参数 x 是 f1 的参数,如果 f1 函数有多个,这边也要写多个,要让 @log 自适应任何参数定义的函数,可以利用Python的 *args 和 **kw,保证任意个数的参数总是能正常调用
        print "call " + f.__name__ + "().." 
        return f(x) #执行原 f 函数
    return fn       #返回新的函数

# 调用装饰器,效果和 g1 = flog(f1);print g1(5) 一致。
@flog               
def f1(x):
    return x * 2
print f1(5)

#输出:
#call f1()..
#10

注: 上边f1(x)只接受一个函数,如果接受两个函数就会报错,要让 @flog 自适应任何参数定义的函数,可以利用Python的 *args**kw,保证任意个数的参数总是能正常调用

例:计算函数调用的时间可以记录调用前后的当前时间戳,然后计算两个时间戳的差。

import time

# 定义装饰器
def performance(f):
    def fn(*args, **kw):    #可以接受任意参数
        t1 = time.time()    #记录执行前的时间
        r = f(*args, **kw)  #执行原函数,并保存执行结果到变量 r 中
        t2 = time.time()    #记录执行结束后的时间
        print 'call %s() in %fs' % (f.__name__, (t2 - t1))  #添加自定义输出内容
        return r            #返回原函数的执行结果
    return fn               #返回新函数

#调用装饰器
@performance
def factorial(n):
    return reduce(lambda x,y: x*y, range(1, n+1))
print factorial(10)

带参数的装饰器

上边的实现的装饰器函数,只能输出固定的内容,除了f.__name__所定义的函数名称。如果想要根据函数的不同来给输出的日志划分等级的,如 a 函数日志等级为info,b 函数日志等级为debug,这里需要用到带参数的装饰器。如:

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

@log('DEBUG')等于之前无参数的装饰器的@log,即@log('DEBUG')这个返回的函数相当于之前无参数装饰器的@log。所以要在无参数的装饰器上层再加一个函数的嵌套。

例:输出日志等级

#coding=utf-8

"""
    带参数的装饰器,写三层嵌套的函数
"""

def flog(devel):    # 定义带参数的装饰器.
    def log_decorator(f):   #和无参数的装饰器相同
        def add_self(*args,**kwargs):   #添加输出的日志,执行f函数
            print "[%s],call %s().." % (devel,f.__name__)
            return  f(*args,**kwargs)
        return add_self     
    return log_decorator    #返回给flog("INFO")

@flog("INFO")
def factorial(n):
    return reduce(lambda x,y: x*y, range(1, n+1))
print factorial(10)

"""
输出
[INFO],call factorial()..
3628800
"""

例2:上一节的@performance只能打印秒,请给@performace增加一个参数,允许传入's''ms'

import time
def performance(unit):s
    def perf_decorator(f):
        def wrapper(*args, **kw):
            t1 = time.time()
            r = f(*args, **kw)
            t2 = time.time()
            t = (t2 - t1) * 1000 if unit=='ms' else (t2 - t1)
            print 'call %s() in %f %s' % (f.__name__, t, unit)
            return r
        return wrapper
    return perf_decorator

@performance('ms')
def factorial(n):
    return reduce(lambda x,y: x*y, range(1, n+1))
print factorial(10)

完善装饰器

经过@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的“改造”,就需要把原函数的一些属性复制到新函数中。

Python内置的functools可以用来自动化完成这个“复制”的任务:

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

最后需要指出,由于我们把原函数签名改成了(*args, **kw),因此,无法获得原函数的原始参数信息。即便我们采用固定参数来装饰只有一个参数的函数

例:该方法使用到上节的例子中

import time, functools
def performance(unit):
    def perf_decorator(f):
        @functools.wraps(f)
        def wrapper(*args, **kw):
            t1 = time.time()
            r = f(*args, **kw)
            t2 = time.time()
            t = (t2 - t1) * 1000 if unit=='ms' else (t2 - t1)
            print 'call %s() in %f %s' % (f.__name__, t, unit)
            return r
        return wrapper
    return perf_decorator

@performance('ms')
def factorial(n):
    return reduce(lambda x,y: x*y, range(1, n+1))
print factorial.__name__

你可能感兴趣的:(Python decorator装饰器)