Python標準庫中的logging用法範例

本篇文章為大家帶來了關於Python的相關知識，logging是Python標準庫中記錄常用的記錄日誌庫，透過logging模組儲存各種格式的日誌，主要用於輸出執行日誌，可以設定輸出日誌的等級、日誌儲存路徑、日誌檔案回溯等，下面一起來看一下，希望對大家有幫助。

【相關推薦：Python3影片教學 】

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-45和ds_update.2022-09-03_19-24-45和ds_update.2022-09-03_19-24-36表示的是4-36表示的是日誌備份文件，日誌備份文件依照時間順序由近及遠進行滾動。

【相關推薦：Python3影片教學 】

以上是Python標準庫中的logging用法範例的詳細內容。更多資訊請關注PHP中文網其他相關文章！