Python標準庫中的logging用法範例詳解

2022-09-04 18:02:01

1、logging的介紹

logging是Python標準庫中記錄常用的記錄紀錄檔庫，通過logging模組儲存各種格式的紀錄檔，主要用於輸出執行紀錄檔，可以設定輸出紀錄檔的等級、紀錄檔儲存路徑、紀錄檔檔案回滾等。

2、簡單用法範例

首先建立一個logger.py的檔案，其裡面的程式碼如下所示：

import logging
 
# 1.建立一個logger範例，並且logger範例的名稱命名為「single info」，設定的嚴重級別為DEBUG
LOGGER = logging.getLogger('single info')
LOGGER.setLevel(logging.DEBUG)
 
# 2.建立一個handler，這個主要用於控制檯輸出紀錄檔，並且設定嚴重級別
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)
 
# 3.建立handler的輸出格式（formatter）
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
 
# 4.將formatter新增到handler中
ch.setFormatter(formatter)
 
# 5.將handler新增到logger中
LOGGER.addHandler(ch)

在與logger.py檔案的同級目錄下建立一個demo.py的檔案，在demo.py檔案中參照前面已經建立好的logger範例，其程式碼如下：

from logger import LOGGER
 
LOGGER.debug("列印DEBUG級別的紀錄檔")
LOGGER.info("列印INFO級別的紀錄檔")

執行demo.py檔案，控制檯中的輸入內容如下：

2022-09-03 17:38:16,554 - single info - DEBUG - 列印DEBUG級別的紀錄檔
2022-09-03 17:38:16,555 - single info - INFO - 列印INFO級別的紀錄檔

3、紀錄檔級別

預設情況下，logging的紀錄檔級別為WARNING，並且將紀錄檔列印到控制檯中。紀錄檔級別大小關係為：CRITICAL > ERROR > WARNING > INFO > DEBUG > NOTSET

import logging
 
LOGGER = logging.getLogger('single info')
 
LOGGER.error("列印ERROR級別紀錄檔")
LOGGER.warning("列印WARNING級別紀錄檔")
LOGGER.info("列印INFO級別紀錄檔")

執行上述程式碼，其輸出內容為：

列印ERROR級別紀錄檔
列印WARNING級別紀錄檔

可以看到由於INFO的紀錄檔級別小於WARNING，所以其對應的紀錄檔沒有輸出

4、列印格式的各個引數

%(asctime)s：紀錄檔記錄時建立人類可讀時間，預設情況下類似於' 2022-09-03 17:28:38,073 '這樣的形式(逗號後的數位是時間的毫秒部分)

%(name)s：表示logger範例的名稱

%(levelname)s：列印紀錄檔的紀錄檔等級

%(message)s：表示紀錄檔的內容

5、紀錄檔輸出到指定檔案

將上述的logger.py檔案修改為如下所示：

import logging
 
# 1、建立一個logger範例，並且logger範例的名稱命名為「single info」，設定的嚴重級別為DEBUG
LOGGER = logging.getLogger('single info')
LOGGER.setLevel(logging.DEBUG)
 
# 2、建立一個handler，用於寫入紀錄檔檔案
fh = logging.FileHandler('test.log',encoding="utf-8", mode="a")
fh.setLevel(logging.WARNING)
 
#3、定義handler的輸出格式（formatter）
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(filename)s - %(lineno)d : %(message)s')
 
# 4、給handler新增formatter
fh.setFormatter(formatter)
 
# 5、給logger新增handler
LOGGER.addHandler(fh)

demo.py檔案中的程式碼為：

from logger import LOGGER
 
LOGGER.debug("列印DEBUG級別的紀錄檔")
LOGGER.error("列印ERROR級別的紀錄檔")

執行demo.py檔案，我們會看到在專案的根目錄下面會產生一個名為test.log的檔案，並且檔案裡面的內容為：

列印ERROR級別紀錄檔
列印WARNING級別紀錄檔

特別提示：由於要在紀錄檔檔案中輸出中文，所以在指定紀錄檔檔案時需要設定好編碼

6、紀錄檔回滾（按照檔案大小卷動）

僅僅修改logger.py檔案：定義一個RotatingFileHandler，最多備份3個紀錄檔檔案，每個紀錄檔檔案最大1K

import logging
from logging.handlers import RotatingFileHandler
 
# 1、建立一個logger範例，並且logger範例的名稱命名為「single info」，設定的嚴重級別為DEBUG
LOGGER = logging.getLogger('single info')
LOGGER.setLevel(logging.DEBUG)
 
# 2、定義一個RotatingFileHandler，最多備份3個紀錄檔檔案，每個紀錄檔檔案最大1K
rHandler = RotatingFileHandler("log.txt",maxBytes = 1,backupCount = 3,encoding="utf-8", mode="a")
rHandler.setLevel(logging.WARNING)
 
#3、定義handler的輸出格式（formatter）
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(filename)s - %(lineno)d : %(message)s')
 
# 4、給handler新增formatter
rHandler.setFormatter(formatter)
 
# 5、給logger新增handler
LOGGER.addHandler(rHandler)

多次執行demo.py後，可以看到在專案的根目錄下面會新增四個檔案：

log.txt表示當前紀錄檔所儲存的檔案，log.txt.1、log.txt.2和log.txt.3表示的是紀錄檔備份檔案。

7、紀錄檔回滾（按照時間捲動）

僅僅修改logger.py檔案：定義一個TimedRotatingFileHandler，最多備份3個紀錄檔檔案，每隔5秒作為一個紀錄檔檔案的間隔點

import logging
from logging.handlers import TimedRotatingFileHandler
from statistics import mode
 
# 1、建立一個logger範例，並且logger範例的名稱命名為「single info」，設定的嚴重級別為DEBUG
LOGGER = logging.getLogger('single info')
LOGGER.setLevel(logging.DEBUG)
 
# 2、定義一個TimedRotatingFileHandler，最多備份3個紀錄檔檔案，每隔5秒作為一個紀錄檔檔案的間隔點
rHandler =TimedRotatingFileHandler(filename="ds_update", when="S", interval=5, backupCount=3,encoding="UTF-8")
rHandler.setLevel(logging.WARNING)
 
# 3、定義handler的輸出格式（formatter）
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(filename)s - %(lineno)d : %(message)s')
 
# 4、給handler新增formatter
rHandler.setFormatter(formatter)
 
# 5、給logger新增handler
LOGGER.addHandler(rHandler)