Python中l(wèi)ogging模塊用法示例總結(jié)

更新時(shí)間：2025年08月27日 11:13:51 作者：解析幾何太難啦QAQ

在Python中l(wèi)ogging模塊是一個(gè)強(qiáng)大的日志記錄工具,它允許用戶將程序運(yùn)行期間產(chǎn)生的日志信息輸出到控制臺(tái)或者寫入到文件中,這篇文章主要介紹了Python中l(wèi)ogging模塊用法的相關(guān)資料,需要的朋友可以參考下

前言

logging是Python中拿來進(jìn)行日志記錄的標(biāo)準(zhǔn)庫，可以方便地跟蹤程序的運(yùn)行狀態(tài)，再也不需要手動(dòng)添加一大堆的print了！

這篇文章目的是簡單地介紹一下它的基本用法，其實(shí)這個(gè)模塊內(nèi)容還挺多的，包括記錄器、處理器、過濾器、格式器等多種工具。不過對于平常的應(yīng)用，記錄器就夠了。

一. 基本使用

1. 五種日志等級

首先導(dǎo)入logging，然后可以直接使用下面的函數(shù)來記錄：

logging.debug()，調(diào)試細(xì)節(jié)信息，嚴(yán)重程度最低。
logging.info()，普通的消息。
logging.warning()，警告，但是程序仍可以執(zhí)行；默認(rèn)報(bào)告此級別及以上的日志。
logging.error()，錯(cuò)誤，可能導(dǎo)致程序部分功能失敗。
logging.critical()，嚴(yán)重錯(cuò)誤，可能導(dǎo)致程序直接失敗。

下面是例子：

import logging

logging.debug('調(diào)試')
logging.info('信息')
# 默認(rèn)忽略以上兩個(gè)等級的信息
logging.warning('警告')
logging.error('錯(cuò)誤')
logging.critical('重大錯(cuò)誤')

默認(rèn)情況下，日志是下面的格式：

{日志等級}:{日志記錄器名稱}:{消息}

2. 設(shè)置報(bào)告等級

想要自己定義日志的行為，可以使用logging.basicConfig()來設(shè)置。比如，通過指定level可以更改進(jìn)行報(bào)告的最低日志等級：

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' （逗號之后的數(shù)字為時(shí)間的毫秒部分）。
%(filename)s，執(zhí)行報(bào)告的文件路徑中的文件名部分。
%(module)s，執(zhí)行日志記錄的模塊名稱。
%(levelname)s，日志的等級。
%(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)告等級:%(levelname)s; %(message)s'
)

logging.debug('調(diào)試')
logging.info('信息')
logging.warning('警告')
logging.error('錯(cuò)誤')
logging.critical('重大錯(cuò)誤')

那個(gè)asctime還可以自己定義行為，只要指定datefmt即可。它的格式化微語言和datetime一樣，下面是AI整理的表格：

比如，下面的方法讓asctime只輸出日期和時(shí)分秒：

import logging

logging.basicConfig(
    level=logging.DEBUG,
    format='報(bào)告時(shí)間:%(asctime)s 報(bào)告等級:%(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語言風(fēng)格的格式化方法

如果我想在日志信息中使用一些變量該怎么辦呢？處了用Python的方法，也可以用%s這種C風(fēng)格的格式化方法，logging是一個(gè)元老級的模塊，采用這種遠(yuǎn)古方式是為了向下兼容。

下面是Python的方法：

import logging

logging.basicConfig(
    level=logging.DEBUG,
    format='報(bào)告時(shí)間:%(asctime)s 報(bào)告等級:%(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)告等級:%(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)告等級:%(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í)我們可能想讓日志覆蓋原來的內(nèi)容，這時(shí)可以指定filemode更改寫入方式，例如：

import logging

logging.basicConfig(
    level=logging.DEBUG,
    format='報(bào)告時(shí)間:%(asctime)s 報(bào)告等級:%(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ì)在請求成功時(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;是誰，用getLogger獲取這個(gè)日志記錄器，再用setLevel方法更改它輸出的最低日志等級即可。比如，下面在basicConfig下加了一條語句，阻止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('請求成功%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)在就只輸出了我自己指定的信息：

二. 高級用法

掌握了上面的內(nèi)容，就掌握了這個(gè)模塊的精髓和核心，大部分情況下完全夠用了。

高級用法我就稍微說說吧，如果需要更詳細(xì)的指導(dǎo)請移步官方文檔翻閱資料。

之前說過， logging庫有記錄器、處理器、過濾器、格式器等組件。具體來說，每個(gè)記錄器logger可以有多個(gè)處理器handler，而每個(gè)處理器又可以有自己的格式器formatter。過濾器給logger或handler提供了更詳細(xì)的輸出細(xì)節(jié)，不過這里不談?wù)撍?/p>

為了幫讀者專注于理解API的用法，而不是被混亂的命名弄亂，下面我將使用中文作為變量名。

1. 日志記錄器

可以使用logging.Logger來指定記錄器，推薦傳入__name__參數(shù)作為它的名字。

import logging

記錄器 = logging.Logger(__name__)

使用setLevel()方法可以控制它的日志等級，決定要將什么等級的日志傳給處理器。

單獨(dú)的記錄器什么也做不到，需要和其它組件配合。

2. 日志處理器

處理器可以用來控制日志的輸出方向。比如輸出到終端和文件，分別對應(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的高級用法，我們點(diǎn)到為止。有需求的同志可以去官方文檔繼續(xù)深造。