目錄
logging 模塊
logging 模塊是 Python 內置的標准模塊, 主要用於輸出運行日志
logging 可以設置信息輸出位置, 以及如何輸出
1. 可以設置輸出日志的等級, 保存路徑, 日志文件回滾等
2. 可以通過設置不同的日志等級, 在 release 版本中只輸出重要信息，而不必顯示大量的調試信息
為什么要使用 logging 模塊
在程序的運行過程中, 難免會產生一些重要的數據信息.
有些是可以展示給用戶看的, 有些就需要默默的收集起來, 作為日后調試優化系統時的重要參考.
處理繁瑣的日志讀寫, Python早已為我們提供了便捷的模塊 logging
如何使用 logging 模塊
導入模塊
import logging
logging 模塊提供了非常豐富的功能 (在此僅介紹本人常用的一些功能)
一個如何使用 logging 模塊的簡單例子
import logging
logging.basicConfig(level=logging.DEBUG,
format="%(asctime)s\t"
"%(filename)s\t"
"[line:%(lineno)d]\t"
"%(levelname)s\n"
"%(message)s",
datefmt="%a, %d %b %Y %H:%M:%S"
)
logging.debug("調試信息")
logging.info("普通信息")
logging.warning("警告信息")
logging.error("錯誤信息")
logging.critical("嚴重錯誤信息")
功能及參數解析
設置基本配置
logging.basicConfig(
指定日志文件名稱
filename="filename"
指定日志文件的打開模式, 'w'或者'a'
filemode="w" 或 "a"
指定輸出的格式和內容
format="格式和內容"
Textual time when the LogRecord was created
日志記錄時的文本時間
"%(asctime)s"
Numeric logging level for the message (DEBUG, INFO, WARNING, ERROR, CRITICAL)
打印日志級別的數值
%(levelno)s
Text logging level for the message ("DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL")
打印日志級別的名稱
%(levelname)s
Full pathname of the source file where the logging call was issued (if available)
打印當前執行程序的路徑，相當於打印sys.argv[0]
%(pathname)s：
Filename portion of pathname
打印當前執行程序名
%(filename)s
Function name
打印日志的當前函數
%(funcName)s
Source line number where the logging call was issued (if available)
打印日志的當前行號
%(lineno)d
The result of record.getMessage(), computed just as the record is emitted
打印日志信息
%(message)s
Thread ID (if available)
打印線程ID
%(thread)d
Thread name (if available)
打印線程名稱
%(threadName)s
Process ID (if available)
打印進程ID
%(process)d
Use the specified date/time format
使用指定的日期/時間格式
%a : 周 %d : 日 %b : 月 %Y : 年(XXXX) %H : 時 %M : 分 %S : 秒
datefmt="%a, %d %b %Y %H:%M:%S"
)
如何利用 logging 模塊寫日志文件
本人暫時只掌握兩種寫入文件的方法
利用 logger 對象
import logging
logger = logging.getLogger() # 實例化一個logger對象
logger.setLevel(logging.INFO) # 設置初始顯示級別
# 創建一個文件句柄
file_handle = logging.FileHandler("log", encoding="UTF-8")
# 創建一個流句柄
stream_handle = logging.StreamHandler()
# 創建一個輸出格式
fmt = logging.Formatter(f"{'*'*28}\n"
"> %(asctime)s\n"
"> %(levelname)s - "
"%(filename)s - "
"[line:%(lineno)d]\n"
f"{'-'*40}\n"
" %(message)s\n"
f"{'-'*40}\n\n",
datefmt="%a, %d %b %Y"
"%H:%M:%S"
)
file_handle.setFormatter(fmt) # 文件句柄設置格式
# stream_handle.setFormatter(fmt) # 流句柄設置格式
logger.addHandler(file_handle) # logger對象綁定文件句柄
# logger.addHandler(stream_handle) # logger對象綁定流句柄
logger.info("這是程序運行過程中的一條提示")
利用logging.basicConfig基本配置
利用這種方法將日志寫入文件通常不支持中文
中文將顯示為亂碼, 雖然網上有許多處理方法, 但是為什么我們不在一開始就解決中文亂碼的問題呢
在此我將分享我的解決方法
import logging
file = open("log", encoding="utf-8", mode="a")
logging.basicConfig(level=logging.DEBUG,
stream=file,
format="%(asctime)s "
"%(filename)s [line:%(lineno)d] "
"%(levelname)s\n"
"%(message)s",
datefmt="%a, %d %b %Y %H:%M:%S"
)
logging.debug("調試信息")
logging.info("普通信息")
logging.warning("警告信息")
logging.error("錯誤信息")
logging.critical("嚴重錯誤信息")
file.close()
stream : 日志的輸出流，可以指定輸出到 sys.stderr, sys.stdout 或者文件, 默認輸出到 sys.stderr, 當 stream 和 filename 同時指定時, stream 被忽略
利用 stream 輸出到文件便可以解決編碼問題, 然而這樣一來卻也帶來了一些問題
首先, 文件在程序運行過程中必須始終保持打開狀態
其次, 不能同時進行寫入文件與控制台輸出
以上
未來學習工作中發現更好的解決措施會回來填坑...