為什么Pycharm輸出的日志全部是紅色!
在上一篇文章1萬字詳解 python logging日志模塊 中,深入淺出的講解了日志的基本原理與用法。但還有一些內(nèi)容并沒有涉及到,所以這篇文章作為上一篇文章的補(bǔ)充。
希望這兩篇文章能幫助你完全理解日志模塊的使用,在項(xiàng)目中對(duì)日志的運(yùn)用游刃有余。上一篇還沒看的建議先閱讀上一篇
1、為什么子記錄器不需要設(shè)置日志等級(jí)也可以輸出?
如果未在記錄器上顯式設(shè)置級(jí)別,則使用其父記錄器的級(jí)別作為其有效級(jí)別。如果父記錄器也沒有設(shè)置級(jí)別,則依此類推,搜索父級(jí)的父級(jí),直到找到明確設(shè)置了級(jí)別的記錄器。根記錄器默認(rèn)下為 WARNING 級(jí)別
- import logging
- parent = logging.getLogger("parent")
- parent.setLevel(logging.INFO)
- parent.addHandler(logging.StreamHandler())
- child = logging.getLogger("parent.child")
- child.info("msg")
輸出
- msg
這里我沒有給child設(shè)置日志等級(jí),他會(huì)從父記錄器查找日志級(jí)別,所以child也可以輸出info級(jí)別的日志。關(guān)于記錄器的繼承關(guān)系可以參考第一篇文章
2、為什么有時(shí)候日志會(huì)輸出兩次?
看下面例子:
- import logging
- # 初始化日志,并設(shè)置日志級(jí)別(為root設(shè)置為DEBUG級(jí)別,關(guān)聯(lián)StreamHandler,設(shè)置BASIC_FORMAT格式)
- logging.basicConfig(level=logging.DEBUG)
- # 定義root記錄器
- root = logging.getLogger()
- # 定義child記錄器
- child = logging.getLogger("child")
- console_handler = logging.StreamHandler()
- # 給child綁定處理器
- child.addHandler(console_handler)
- # 記錄一條info日志
- child.info("child info")
輸出
- child info
- INFO:child:child info
代碼中明明只記錄了一次日志,卻輸出了兩次,而且兩次的日志格式不一樣。這是因?yàn)?child 這個(gè)記錄器添加了一個(gè)叫console_handler的處理器, 而root根記錄器默認(rèn)也帶有自己的處理器(也是StreamHandler實(shí)例)
- print(root.handlers) # [<StreamHandler <stderr> (NOTSET)>]
根據(jù)python中日志模塊的處理機(jī)制,子記錄器記錄的消息會(huì)自動(dòng)傳播給父級(jí)記錄器的關(guān)聯(lián)的處理器。所以在這個(gè)例子中,child記錄的消息除了會(huì)發(fā)給自己的handler外,還是傳播給root記錄器的handler,因此最終輸出了兩次,流程圖如下
logging-flow.png
如果不希望子記錄器記錄的消息傳播給父級(jí)記錄器,可以設(shè)置記錄器的屬性propagate為False,關(guān)閉傳播。
- child.propagate = False
如此一來,最終輸出到終端的日志就只有child自己的處理器輸出的記錄
- child info
配置處理器的最佳實(shí)踐是給頂級(jí)記錄器配置處理器,再根據(jù)需要?jiǎng)?chuàng)建子記錄器, 因?yàn)橛涗涀罱K都會(huì)傳播給父記錄器
- import logging
- parent = logging.getLogger("parent")
- parent.setLevel(logging.DEBUG)
- parent.addHandler(logging.StreamHandler())
- # 不需要給子記錄器單獨(dú)配置handler
- child = logging.getLogger("parent.child")
- child.info("msg")
對(duì)于日志的流程處理,python官方文檔畫了一張更為細(xì)致的流程圖,可以參考
logging_flow.png
第一次看估計(jì)有點(diǎn)暈,但先看我畫的這張圖再來看這張圖,你就能懂了,為了簡化我省去了過濾器以及不斷循環(huán)查找父級(jí)記錄器的這個(gè)流程。
3、 為什么我的pycharm中輸出的日志是紅色?
不知道你的pycharm輸出的日志不管是info信息還是error信息,反正都是紅色,一看以為整屏都是錯(cuò)誤。
把下面代碼放在Pycharm運(yùn)行看效果:
- import logging
- logging.basicConfig(level=logging.DEBUG)
- logging.info("hello")
這是因?yàn)槭褂胷oot記錄器記錄日志時(shí),默認(rèn)配置的handler是一個(gè)StreamHandler。
我們打開StreamHandler的源碼
- class StreamHandler(Handler):
- """
- A handler class which writes logging records, appropriately formatted,
- to a stream. Note that this class does not close the stream, as
- sys.stdout or sys.stderr may be used.
- """
- terminator = '\n'
- def __init__(self, stream=None):
- """
- Initialize the handler.
- If stream is not specified, sys.stderr is used.
- """
- Handler.__init__(self)
- if stream is None:
- stream = sys.stderr
- self.stream = stream
初始化這個(gè)Handler時(shí),會(huì)接收一個(gè)stream的參數(shù),如果不傳,默認(rèn)就使用的系統(tǒng)標(biāo)準(zhǔn)錯(cuò)誤流(sys.stderr)輸出,pycharm對(duì)錯(cuò)誤流輸出的字體樣式做了紅色渲染,如果換成 sys.stdout 輸出的就不再紅色了。
- import logging
- import sys
- handler = logging.StreamHandler(stream=sys.stdout)
- logging.basicConfig(level=logging.DEBUG, handlers=[handler])
- # 或者指定stream參數(shù)
- # logging.basicConfig(level=logging.DEBUG, stream=sys.stdout)
- logging.info("hello")
4、怎么生成以日期時(shí)間命名的日志?
實(shí)際應(yīng)用中,我們會(huì)對(duì)日志進(jìn)行歸檔存儲(chǔ),每天生成一份日志,如果哪天出了問題,也方便定位,直接找到當(dāng)天的日志文件就可以分析。我們只需要給logger添加一個(gè)TimedRotatingFileHandler處理器就行。
- file_handler = TimedRotatingFileHandler(‘'logs/api.log'),
- when="D", interval=1, backupCount=10,
- encoding="UTF-8", delay=False, utc=True)
- formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
- file_handler.setFormatter(formatter)
- file_handler.setLevel(logging.INFO)
- logger.addHandler(file_handler)
5、為什么我日志配置后不生效?
可能跟程序的加載順序有關(guān),看個(gè)例子
- import logging
- logger = logging.getLogger()
- handler = logging.StreamHandler()
- logger.addHandler(handler)
- logger.info("hello1")
- logger.setLevel(logging.INFO)
- logger.info("hello2")
像上面的代碼最后只輸出了hello2,不過實(shí)際場景中,代碼沒這么簡單,通常是在a模塊中的某個(gè)函數(shù)中初始化日志框架配置, 在b模塊外層創(chuàng)建了名字叫 logger_b的記錄器,然后在a中導(dǎo)入b模塊時(shí),這時(shí)候日志配置還沒初始化,最后導(dǎo)致logger_b的配置就成了默認(rèn)配置。所以有可能出現(xiàn)日志不生效的情況。
因此最佳實(shí)踐是能盡早初始化日志配置就盡早提前。