logging模块定位log的实现

长年打log突然提出一个问题,logging模块是如何定位到打印log的具体位置(文件、函数、行)的呢?以下从logging模块的源码解决这个问题。

Paste_Image.png

调用栈分析

当代码运行到logging.debug('debug')的时候,我们来看看发生了什么。

函数调用路径如下:

函数 函数内调用
logging.debug Logger()._log
Logger()._log Logger().findCaller、 Logger().makeRecord
Logger().findCaller currentframe
currentframe sys.exc_info
makeRecord 调用的函数与本文关系不大

以下详细分析这些函数的细节

currentframe函数

currentframe函数的作用是返回当前的栈帧。实现是制造并捕获一个异常,并通过sys.exc_info函数得到这个异常的信息,实现简单而巧妙。

currentframe函数的实现

def currentframe():
    """Return the frame object for the caller's stack frame."""
    try:
        raise Exception
    except:
        return sys.exc_info()[2].tb_frame.f_back

sys.exc_info函数获取当前正在处理的异常类,exc_type、exc_value、exc_traceback是当前处理的异常详细信息三元组(type, value, traceback)。

sys.exc_info()[2]返回当前异常的栈,调用tb_frame返回当前异常的帧,也就是该函数raise Exception的异常帧,打印log的目的是查看log具体的位置,所以当前的信息肯定是不需要的,所以调用f_back得到他的outer层,并返回。

此时我们返回到父函数findCaller

findCaller

findCaller继续子函数currentframef_back功能,在while循环里面不断追溯上游捕抓Exception的位置,直到当前栈所在文件不是当前的文件_srcfile为止,实现如下:

def findCaller(self):
    f = currentframe() # 调用上面提到的currentframe函数
    if f is not None:
        f = f.f_back
    rv = "(unknown file)", 0, "(unknown function)"
    while hasattr(f, "f_code"): # 利用f_code属性
        co = f.f_code
        filename = os.path.normcase(co.co_filename)
        if filename == _srcfile: # 如果上游捕抓的位置是当前文件,那么继续上溯,最终得到打印log的位置
            f = f.f_back # 继续上溯
            continue
        rv = (co.co_filename, f.f_lineno, co.co_name) # 文件名、行数和函数名
        break
    return rv

# _srcfile定义
_srcfile = os.path.normcase(currentframe.__code__.co_filename) # currentframe函数和findCaller函数在同一个文件里面

返回的rv也是一个三元组(filename、lineno、co_name),包含打印log的文件名、代码行数、函数名字。到这为止,打印log需要的信息就收集到了。

总结

log日志信息的实现是利用异常的捕获机制去做的,我们知道当抛出一个异常的时候,异常会一步一步往上抛,直到得到处理或者程序异常结束为止,这样就一定可以追溯到源头。
另外可以看到,在寻找_srcfile的时候,调用了__code__来返回当前代码所属的文件名;在findCaller里用frame.f_lineno来获取代码行,用co.co_name来获取当前函数的名字;等等。可见,得益于强大自省的特性,整体实现简单明了。

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

推荐阅读更多精彩内容