Python装饰器应用于日志输出

1 入门

装饰器应该是Python里面最难理解的概念了,网络很多文章和教程都试图把装饰器讲的很明白,其实是讲明白了,但对于没有实际项目开发经验的人来说装饰器不容易掌握,且在日常业务开发中,尽快将业务开发完成上线才是首要任务,代码质量往往成为其次,偶尔闲来需要不断补充新的知识而不是细细品味已经上线的代码。

2 函数装饰器

既然是装饰,那么就是在函数真正执行之前(或者之后)进行一些装饰(包裹),装饰可以对函数的输入参数,也可以在函数运行之前进行一些操作,也可以在函数运行之后进行一些操作,装饰器只是一个语法糖语法糖,就是这样写就是这样的结果,为什么是这样的结果?没有为什么)。

3 接近实际的例子

以日志输出为例,在日志系统设计中,往往会设计如下几个函数:

def debug(msg):
    msg = "debug " + msg
    print(msg)

def info(msg):
    msg = "info " + msg
    print(msg)

如果有很多日志级别如error,warn,trace等,那么msg = "debug" + msg将会重复又重复,这个时候装饰器是可以派上用场,如之前所说,装饰器可以在函数执行之前对参数进行一些操作,这里主要就是对输入参数msg进行操作,突然感觉装饰器也有点类似C++的模板,方便代码复用,当然这也是装饰器的重要意义。

4 使用装饰器

使用装饰器将提取一个wrapper函数(包裹函数),使用语法糖@do_log完成装饰器的使用。

from functools import wraps

def do_log(func):
    @wraps(func)
    def wrapper(*args, **kw):
        if func.__name__ == "debug":
            msg = "debug {}".format(args[0])
        elif func.__name__ == "info":
            msg = "info {}".format(args[0])
        else:
            msg =  "unknown {}".format(args[0])
        return func(msg, **kw)
    return wrapper

@do_log
def debug(msg):
    print(msg)

@do_log
def info(msg):
    print(msg)

if __name__ == "__main__":
    debug("123")
    info("abc")

当然这个例子还有许多地方值得完善,比如参数直接使用了args[0]等,其实装饰器只是帮我们做了一件事情,即通过语法糖实现了 debug = do_log(debug),然后debug("123"),执行的是wrapper("123")。当然实际实现会比这里所说的略微复杂,但是大体如此。

5 总结

装饰器虽然是Python的重要语法糖,但是阅读开源代码来看使用没有那么普通,上述例子通过函数封装可以实现同样的工作,除非是已经习惯装饰器这种语法糖。

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

推荐阅读更多精彩内容