Python中l(wèi)ogging模塊用法示例總結(jié)
前言
logging是Python中拿來(lái)進(jìn)行日志記錄的標(biāo)準(zhǔn)庫(kù),可以方便地跟蹤程序的運(yùn)行狀態(tài),再也不需要手動(dòng)添加一大堆的print了!
這篇文章目的是簡(jiǎn)單地介紹一下它的基本用法,其實(shí)這個(gè)模塊內(nèi)容還挺多的,包括記錄器、處理器、過濾器、格式器等多種工具。不過對(duì)于平常的應(yīng)用,記錄器就夠了。
一. 基本使用
1. 五種日志等級(jí)
首先導(dǎo)入logging,然后可以直接使用下面的函數(shù)來(lái)記錄:
- logging.debug(),調(diào)試細(xì)節(jié)信息,嚴(yán)重程度最低。
- logging.info(),普通的消息。
- logging.warning(),警告,但是程序仍可以執(zhí)行;默認(rèn)報(bào)告此級(jí)別及以上的日志。
- logging.error(),錯(cuò)誤,可能導(dǎo)致程序部分功能失敗。
- logging.critical(),嚴(yán)重錯(cuò)誤,可能導(dǎo)致程序直接失敗。
下面是例子:
import logging logging.debug('調(diào)試') logging.info('信息') # 默認(rèn)忽略以上兩個(gè)等級(jí)的信息 logging.warning('警告') logging.error('錯(cuò)誤') logging.critical('重大錯(cuò)誤')
默認(rèn)情況下,日志是下面的格式:
- {日志等級(jí)}:{日志記錄器名稱}:{消息}
2. 設(shè)置報(bào)告等級(jí)
想要自己定義日志的行為,可以使用logging.basicConfig()來(lái)設(shè)置。比如,通過指定level可以更改進(jìn)行報(bào)告的最低日志等級(jí):
import logging logging.basicConfig( level=logging.DEBUG ) logging.debug('調(diào)試') logging.info('信息') # 現(xiàn)在上面兩條信息也會(huì)報(bào)告 logging.warning('警告') logging.error('錯(cuò)誤') logging.critical('重大錯(cuò)誤')
3. 自定義格式
默認(rèn)的日志格式不太好看,我們可以自定義日志的輸出格式。只要在basicConfig里設(shè)置format就可以了。下面是一些常用的可選項(xiàng):
- %(asctime)s,表示人類易讀的日志生成時(shí)間。 默認(rèn)形式為 '2003-07-08 16:49:45,896' (逗號(hào)之后的數(shù)字為時(shí)間的毫秒部分)。
- %(filename)s,執(zhí)行報(bào)告的文件路徑中的文件名部分。
- %(module)s,執(zhí)行日志記錄的模塊名稱。
- %(levelname)s,日志的等級(jí)。
- %(name)s,日志記錄器的名稱,如果直接用logging就是“root”。
- %(message)s,日志的具體信息。
如要了解全部選項(xiàng),可以去官方文檔查看:
logging:https://docs.python.org/zh-cn/3.13/library/logging.html#logrecord-attributes
比如,下面以自定義格式進(jìn)行日志記錄:
import logging logging.basicConfig( level=logging.DEBUG, format='報(bào)告時(shí)間:%(asctime)s 報(bào)告等級(jí):%(levelname)s; %(message)s' ) logging.debug('調(diào)試') logging.info('信息') logging.warning('警告') logging.error('錯(cuò)誤') logging.critical('重大錯(cuò)誤')
那個(gè)asctime還可以自己定義行為,只要指定datefmt即可。 它的格式化微語(yǔ)言和datetime一樣,下面是AI整理的表格:
比如,下面的方法讓asctime只輸出日期和時(shí)分秒:
import logging logging.basicConfig( level=logging.DEBUG, format='報(bào)告時(shí)間:%(asctime)s 報(bào)告等級(jí):%(levelname)s; %(message)s', datefmt='%d日 %H時(shí) %M分 %S秒' ) logging.debug('調(diào)試') logging.info('信息') logging.warning('警告') logging.error('錯(cuò)誤') logging.critical('重大錯(cuò)誤')
4. C語(yǔ)言風(fēng)格的格式化方法
如果我想在日志信息中使用一些變量該怎么辦呢?處了用Python的方法,也可以用%s這種C風(fēng)格的格式化方法,logging是一個(gè)元老級(jí)的模塊,采用這種遠(yuǎn)古方式是為了向下兼容。
下面是Python的方法:
import logging logging.basicConfig( level=logging.DEBUG, format='報(bào)告時(shí)間:%(asctime)s 報(bào)告等級(jí):%(levelname)s; %(message)s', datefmt='%d日 %H時(shí) %M分 %S秒' ) param = '你好,我是變量!' logging.debug(f'變量:{param}')
下面是C風(fēng)格的方法:
import logging logging.basicConfig( level=logging.DEBUG, format='報(bào)告時(shí)間:%(asctime)s 報(bào)告等級(jí):%(levelname)s; %(message)s', datefmt='%d日 %H時(shí) %M分 %S秒' ) param1 = 'param1' param2 = 'param2' param3 = 'param3' logging.debug('我有三個(gè)變量,它們是:\n%s\n%s\n和%s', param1, param2, param3)
5. 將日志輸出到文件
想要讓日志輸出到文件是很容易的, 只要指定filename即可。還可以指定encoding,如果不指定它,則使用open()函數(shù)的默認(rèn)編碼解碼器。日志文件推薦使用.log而不是.txt后綴:
import logging logging.basicConfig( level=logging.DEBUG, format='報(bào)告時(shí)間:%(asctime)s 報(bào)告等級(jí):%(levelname)s; %(message)s', datefmt='%d日%H時(shí)%M分%S秒', filename='report.log' ) logging.info('Hello') logging.info('World!') logging.info('I is ??')
日志的寫入方式默認(rèn)是“a”,也就是向后追加。有時(shí)我們可能想讓日志覆蓋原來(lái)的內(nèi)容,這時(shí)可以指定filemode更改寫入方式,例如:
import logging logging.basicConfig( level=logging.DEBUG, format='報(bào)告時(shí)間:%(asctime)s 報(bào)告等級(jí):%(levelname)s; %(message)s', datefmt='%d日%H時(shí)%M分%S秒', filename='report.log', filemode='w' ) logging.info('Hello') logging.info('World!') logging.info('I is ??')
6. 屏蔽一些刷屏信息
有些模塊在內(nèi)部使用了logging,如果我們也導(dǎo)入使用logging就會(huì)觸發(fā)它們的報(bào)告。比如,httpx會(huì)在請(qǐng)求成功時(shí)發(fā)送一條info日志,當(dāng)我們配置logging后這些信息就可能出現(xiàn):
import logging import httpx logging.basicConfig( level=logging.INFO, format='%(asctime)s-%(levelname)s; %(message)s', datefmt='%d日%H時(shí)%M分%S秒' ) BASE_URL = 'https://www.httpbin.org/get' def scrape(url): try: response = httpx.get(url) except httpx.RequestError: raise else: return response.text from concurrent.futures import ThreadPoolExecutor with ThreadPoolExecutor() as e: e.map(scrape, [BASE_URL for _ in range(10)])
可以看到,因?yàn)槲抑付╨evel=logging.INFO,httpx的這些info日志就輸出了??粗脽┤税?,如果我不想讓它輸出怎么辦?
首先要找到“罪魁禍?zhǔn)?rdquo;是誰(shuí),用getLogger獲取這個(gè)日志記錄器,再用setLevel方法更改它輸出的最低日志等級(jí)即可。比如,下面在basicConfig下加了一條語(yǔ)句,阻止httpx刷屏。
import logging import httpx logging.basicConfig( level=logging.INFO, format='%(asctime)s-%(levelname)s; %(message)s', datefmt='%d日%H時(shí)%M分%S秒' ) logging.getLogger('httpx').setLevel(logging.WARNING) BASE_URL = 'https://www.httpbin.org/get' def scrape(url): logging.info('開始訪問%s', url) try: response = httpx.get(url) except httpx.RequestError: logging.critical('出錯(cuò)了!%s', url) raise else: logging.info('請(qǐng)求成功%s', url) return response.text from concurrent.futures import ThreadPoolExecutor with ThreadPoolExecutor() as e: e.map(scrape, [BASE_URL for _ in range(10)])
現(xiàn)在就只輸出了我自己指定的信息:
二. 高級(jí)用法
掌握了上面的內(nèi)容,就掌握了這個(gè)模塊的精髓和核心,大部分情況下完全夠用了。
高級(jí)用法我就稍微說說吧,如果需要更詳細(xì)的指導(dǎo)請(qǐng)移步官方文檔翻閱資料。
之前說過, logging庫(kù)有記錄器、處理器、過濾器、格式器等組件。具體來(lái)說,每個(gè)記錄器logger可以有多個(gè)處理器handler,而每個(gè)處理器又可以有自己的格式器formatter。過濾器給logger或handler提供了更詳細(xì)的輸出細(xì)節(jié),不過這里不談?wù)撍?/p>
為了幫讀者專注于理解API的用法,而不是被混亂的命名弄亂,下面我將使用中文作為變量名。
1. 日志記錄器
可以使用logging.Logger來(lái)指定記錄器,推薦傳入__name__參數(shù)作為它的名字。
import logging 記錄器 = logging.Logger(__name__)
使用setLevel()方法可以控制它的日志等級(jí),決定要將什么等級(jí)的日志傳給處理器。
單獨(dú)的記錄器什么也做不到,需要和其它組件配合。
2. 日志處理器
處理器可以用來(lái)控制日志的輸出方向。比如輸出到終端和文件,分別對(duì)應(yīng)下面兩個(gè)常用的處理器類:
- StreamHandler()
- FileHandler()
處理器也有setLevel()方法,用于篩選在從logger那里接收到的日志,決定發(fā)送哪些。
下面指定一個(gè)流處理器和一個(gè)文件處理器:
import logging 記錄器 = logging.Logger(__name__) 流處理器 = logging.StreamHandler() 文件處理器 = logging.FileHandler('report.log', mode='w', encoding='utf-8')
3. 日志格式器
這個(gè)其實(shí)就是basicConfig的format參數(shù)的封裝,作用是一樣的??梢灾付╢mt和datefmt參數(shù),例如:
import logging 記錄器 = logging.Logger(__name__) 流處理器 = logging.StreamHandler() 文件處理器 = logging.FileHandler('report.log', mode='w', encoding='utf-8') 流格式器 = logging.Formatter( fmt='%(asctime)s-%(levelname)s; %(message)s', datefmt='時(shí)間:%H:%M:%S' ) 文件格式器 = logging.Formatter( fmt='%(asctime)s=%(levelname)s=%(name)s; %(message)s', datefmt='記錄時(shí)間:%I:%M:%S,%p' )
4. 拼接組件
下面拼接一下這些組件,就能讓logger獲取相應(yīng)的功能。
首先,為處理器綁定格式器:
流處理器.setFormatter(流格式器) 文件處理器.setFormatter(文件格式器)
然后,為記錄器綁定處理器:
記錄器.setLevel(logging.INFO) 記錄器.addHandler(流處理器) 記錄器.addHandler(文件處理器)
現(xiàn)在記錄器就可以使用了。它會(huì)同時(shí)完成向終端和向文件輸出的兩個(gè)任務(wù):
記錄器.info('這是個(gè)信息') 記錄器.warning('警告!沒事沒事') 記錄器.error('錯(cuò)誤!雖然我也不知道哪里錯(cuò)了') 記錄器.critical('天塌了!我當(dāng)被子蓋') 記錄器.info('縱有疾風(fēng)起,人生不言棄')
完整代碼:
import logging 記錄器 = logging.Logger(__name__) 流處理器 = logging.StreamHandler() 文件處理器 = logging.FileHandler('report.log', mode='w', encoding='utf-8') 流格式器 = logging.Formatter( fmt='%(asctime)s-%(levelname)s; %(message)s', datefmt='時(shí)間:%H:%M:%S' ) 文件格式器 = logging.Formatter( fmt='%(asctime)s=%(levelname)s=%(name)s; %(message)s', datefmt='記錄時(shí)間:%I:%M:%S,%p' ) 流處理器.setFormatter(流格式器) 文件處理器.setFormatter(文件格式器) 記錄器.setLevel(logging.INFO) 記錄器.addHandler(流處理器) 記錄器.addHandler(文件處理器) 記錄器.info('這是個(gè)信息') 記錄器.warning('警告!沒事沒事') 記錄器.error('錯(cuò)誤!雖然我也不知道哪里錯(cuò)了') 記錄器.critical('天塌了!我當(dāng)被子蓋') 記錄器.info('縱有疾風(fēng)起,人生不言棄')
關(guān)于logging的高級(jí)用法,我們點(diǎn)到為止。有需求的同志可以去官方文檔繼續(xù)深造。
三. 總結(jié)
我們了解了一下logging模塊的用法,對(duì)于高級(jí)用法點(diǎn)到為止了。這個(gè)模塊相當(dāng)強(qiáng)大,適用于想要跟蹤程序行為的情況,可以使得捕獲和修復(fù)錯(cuò)誤更容易。它的上限遠(yuǎn)不止于此,歡迎同志們繼續(xù)學(xué)習(xí)(* ̄▽ ̄)~*
到此這篇關(guān)于Python中l(wèi)ogging模塊用法的文章就介紹到這了,更多相關(guān)Python logging模塊用法內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- Python中內(nèi)置的日志模塊logging用法詳解
- python標(biāo)準(zhǔn)日志模塊logging的使用方法
- Python中使用logging模塊打印log日志詳解
- Python中使用logging模塊代替print(logging簡(jiǎn)明指南)
- Python logging模塊handlers用法詳解
- 解決Python logging模塊無(wú)法正常輸出日志的問題
- Python使用logging模塊實(shí)現(xiàn)打印log到指定文件的方法
- Python logging日志模塊 配置文件方式
- 詳解?python?logging日志模塊
- Python中的logging模塊實(shí)現(xiàn)日志打印
相關(guān)文章
正則給header的冒號(hào)兩邊參數(shù)添加單引號(hào)(Python請(qǐng)求用)
這篇文章主要介紹了正則給header的冒號(hào)兩邊參數(shù)添加單引號(hào)(Python請(qǐng)求用)的相關(guān)知識(shí),非常不錯(cuò),具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2019-08-08Python 保持登錄狀態(tài)進(jìn)行接口測(cè)試的方法示例
這篇文章主要介紹了Python 保持登錄狀態(tài)進(jìn)行接口測(cè)試的方法示例,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來(lái)看看吧2019-08-08Python pandas如何獲取數(shù)據(jù)的行數(shù)和列數(shù)
這篇文章主要介紹了Python pandas如何獲取數(shù)據(jù)的行數(shù)和列數(shù)問題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-02-02python實(shí)現(xiàn)倒計(jì)時(shí)的示例
這篇文章主要介紹了python實(shí)現(xiàn)的倒計(jì)時(shí)的示例,需要的朋友可以參考下2014-02-02python中opencv支持向量機(jī)的實(shí)現(xiàn)
本文主要介紹了python中opencv支持向量機(jī)的實(shí)現(xiàn),文中通過示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2022-03-03python下調(diào)用pytesseract識(shí)別某網(wǎng)站驗(yàn)證碼的實(shí)現(xiàn)方法
下面小編就為大家?guī)?lái)一篇python下調(diào)用pytesseract識(shí)別某網(wǎng)站驗(yàn)證碼的實(shí)現(xiàn)方法。小編覺得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過來(lái)看看吧2016-06-06Python面向?qū)ο蟪绦蛟O(shè)計(jì)之類的定義與繼承簡(jiǎn)單示例
這篇文章主要介紹了Python面向?qū)ο蟪绦蛟O(shè)計(jì)之類的定義與繼承,結(jié)合完整實(shí)例形式分析了Python面向?qū)ο蟪绦蛟O(shè)計(jì)中類的定義、調(diào)用、繼承及相關(guān)操作注意事項(xiàng),需要的朋友可以參考下2019-03-03利用20行Python 代碼實(shí)現(xiàn)加密通信
這篇文章主要介紹了利用Python 代碼實(shí)現(xiàn)加密通信,本文用 20 行 Python 代碼來(lái)演示加密、解密、簽名、驗(yàn)證的功能。大家依樣畫葫蘆,不僅能理解加密技術(shù),更能自己實(shí)現(xiàn)一套加密通信機(jī)制,需要的朋友可以參考一下2022-03-03python基礎(chǔ)知識(shí)之私有屬性和私有方法
這篇文章主要介紹了python基礎(chǔ)知識(shí)之私有屬性和私有方法,本文通過實(shí)例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-03-03