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

Posted on by

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)

多次運行demo.py後，可以看到在項目的根目錄下面會新增四個文件：

ds_update表示當前日志所存儲的文件，ds_update.2022-09-03_19-24-50、ds_update.2022-09-03_19-24-45和ds_update.2022-09-03_19-24-36表示的是日志備份文件，日志備份文件按照時間順序由近及遠進行滾動。

到此這篇關於Python標準庫中的logging的文章就介紹到這瞭,更多相關Python標準庫logging內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：