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__
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343

推荐阅读更多精彩内容

  • 前言 Python的修饰器的英文名叫Decorator,当你看到这个英文名的时候,你可能会把其跟Design Pa...
    linheimx阅读 627评论 0 4
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,598评论 18 139
  • 要点: 函数式编程:注意不是“函数编程”,多了一个“式” 模块:如何使用模块 面向对象编程:面向对象的概念、属性、...
    victorsungo阅读 1,461评论 0 6
  • 装饰器 装饰器本质上是一个Python函数,它可以让其他函数在不需要做任何代码变动的前提下增加额外功能,装饰器的返...
    时间之友阅读 2,242评论 0 3
  • 美国作家杜鲁门·卡波蒂在接受采访时曾说: 我总是会有幻觉,认为故事的开端、中间和结尾,整出戏都在我头脑里同时上演—...
    兔U阅读 1,705评论 5 17