Python接口自動化淺析logging日志原理及模塊操作流程
在上一篇Python接口自動化測試系列文章:Python接口自動化淺析pymysql數(shù)據(jù)庫操作流程,主要介紹pymysql安裝、操作流程、語法基礎(chǔ)及封裝操作數(shù)據(jù)庫類。
以下主要介紹日志相關(guān)概念及l(fā)ogging日志模塊的操作流程。
一、日志介紹
01 為什么需要日志?
代碼需要經(jīng)歷開發(fā)、調(diào)試、審查、測試或者上線等不同階段,在開發(fā)時想要打印的信息類型可能和上線后想看到的信息類型完全不同。也就是說,在“測試”時,可能只想看警告和錯誤信息,然而在“調(diào)試”時,可能還想看到跟調(diào)試相關(guān)的信息。 如果你想打印出使用的模塊以及代碼運行的時間,那么代碼很容易變得混亂。使用logging日志模塊,這些問題就能很容易地解決。
02 什么是日志?
日志就是用于記錄系統(tǒng)運行時的信息,對一個事件的記錄,也稱為Log。
03 日志的用途是什么?
日志的基本用途如下:
- 記錄程序運行過程中的錯誤,方便跟蹤定位問題,減少調(diào)試和維護成本;
- 通過日志能還原整個程序的執(zhí)行過程,能了解程序的整體狀態(tài);
- 對用戶行為分析和數(shù)據(jù)統(tǒng)計,知曉信息來自于哪個模塊;
- 在設(shè)計測試框架的時候,也可以通過設(shè)計日志來記錄框架的整個測試流程;
04 日志的級別分為哪些?
常見日志等級,如下:
DEBUG:
調(diào)試級別(Value=10),打印非常詳細的日志信息,通常僅在Debug時使用,如算法中每個循環(huán)的中間狀態(tài);
INFO:
信息級別(Value=20),打印一般的日志信息,突出強調(diào)程序的運行過程 ,主要用于處理請求或者狀態(tài)變化等日常事務(wù);
ERROR:
錯誤級別(Value=40),打印錯誤異常信息,該級別的錯誤可能會導(dǎo)致系統(tǒng)的一些功能無法正常使用,如IO操作失敗或者連接問題;
CRITICAL:
嚴重錯誤(Value=50),一個嚴重的錯誤,導(dǎo)致系統(tǒng)可能無法繼續(xù)運行,如內(nèi)存耗盡、磁盤空間為空,一般很少使用;
05 日志功能的實現(xiàn)
幾乎所有開發(fā)語言都會內(nèi)置日志相關(guān)功能,或者會有比較優(yōu)秀的第三方庫來提供日志操作功能,比如:log4j,log4php等。它們功能強大、使用簡單。
Python自身也提供了一個用于記錄日志的標準庫模塊——logging。
二、Logging模塊
01 logging模塊介紹
logging模塊是Python內(nèi)置的標準模塊,主要用于輸出運行日志,可以設(shè)置輸出日志的等級、日志保存路徑、日志文件回滾等。
02 logging模塊優(yōu)勢
相比print,具備如下優(yōu)點:
- 可以在 logging 模塊中設(shè)置日志等級,在不同的relase版本(如開發(fā)環(huán)境、生產(chǎn)環(huán)境)上通過設(shè)置不同的輸出等級來記錄對應(yīng)的日志,只輸出重要信息,而不必顯示大量的調(diào)試信息;
- print 的輸出信息都會輸出到標準輸出流中,嚴重影響開發(fā)者從標準輸出中查看其它數(shù)據(jù),而 logging 模塊更加靈活,可以設(shè)置輸出到任意位置,如寫入文件、寫入遠程服務(wù)器等;
- logging 模塊具有靈活的配置和格式化功能,如配置輸出當前模塊信息、運行時間等,由開發(fā)者決定將信息輸出到什么地方,以及怎么輸出,相比 print 的字符串格式化更加方便易用。
03 logging日志框架的組成
Logger:
日志,暴露函數(shù)給應(yīng)用程序,基于日志記錄器和過濾器級別決定哪些日志有效。
LogRecord :
日志記錄器,將日志傳到相應(yīng)的處理器處理。
Handler :
處理器, 將(日志記錄器產(chǎn)生的)日志記錄發(fā)送至合適的目的地。
Filter :
過濾器, 提供了更好的粒度控制,它可以決定輸出哪些日志記錄。
Formatter:
格式化器, 指明了最終輸出中日志記錄的布局。
04 logging函數(shù)中的具體參數(shù)
filename:
指定的文件名創(chuàng)建FiledHandler,這樣日志會被存儲在指定的文件中;
filemode:
文件打開方式,在指定了filename時使用這個參數(shù),默認值為“w”還可指定為“a”;
format:
指定handler使用的日志顯示格式;
datefmt:
指定日期時間格式
level:
設(shè)置rootlogger的日志級別;
stream:
用指定的stream創(chuàng)建StreamHandler;
05 簡單的日志小例子
我們試著分別輸出一條不同日志級別的日志記錄:
import logging logging.debug("This is a debug log.") logging.info("This is a info log.") logging.warning("This is a warning log.") logging.error("This is a error log.") logging.critical("This is a critical log.")
輸出結(jié)果為:
WARNING:root:This is a warning log.
ERROR:root:This is a error log.
CRITICAL:root:This is a critical log.
為什么debug、info級別日志沒輸出呢?logging模塊提供的默認的日志級別是WARNING,所以只輸出了WARNING及以上的日志級別。
輸出內(nèi)容格式說明:日志級別:日志器名稱:日志內(nèi)容, 如果未自定義日志器名稱,默認是root。
以下是源碼:
def getLogger(name=None): """ Return a logger with the specified name, creating it if necessary. If no name is specified, return the root logger. """ if name: return Logger.manager.getLogger(name) else: return root
06 自定義logger日志
設(shè)置日志收集器及級別:
# 定義一個日志收集器 logger = logging.getLogger('ITester') # 設(shè)置收集器的級別,不設(shè)定的話,默認收集warning及以上級別的日志 logger.setLevel('DEBUG')
設(shè)置日志格式:
fmt =logging.Formatter('%(filename)s-%(lineno)d-%(asctime)s-%(levelname)s-%(message)s')
常見的日志輸出格式:
設(shè)置日志處理器-輸出到文件:
# 輸出到文件 file_handler = logging.FileHandler('../log/mylog.txt') # 設(shè)置日志處理器級別 file_handler.setLevel("DEBUG") # 處理器按指定格式輸出日志 file_handler.setFormatter(fmt)
在項目下新建一個文件夾log,在文件夾下新建文件mylog.txt用于存放日志。
設(shè)置日志處理器-輸出到控制臺:
# 輸出到控制臺 ch = logging.StreamHandler() # 設(shè)置日志處理器級別 ch.setLevel("DEBUG") # 處理器按指定格式輸出日志 ch.setFormatter(fmt)
收集器和處理器對接,指定輸出渠道:
# 日志輸出到文件 logger.addHandler(file_handler) # 日志輸出到控制臺 logger.addHandler(ch)
logger日志大致流程圖,如下:
我們將以上獨立的介紹糅合到一起,測試功能是否正常。在common目錄下,新建文件logger_handler.py。
import logging # 定義一個日志收集器 logger = logging.getLogger('ITester') # 設(shè)置收集器的級別,不設(shè)定的話,默認收集warning及以上級別的日志 logger.setLevel('DEBUG') # 設(shè)置日志格式 fmt =logging.Formatter('%(filename)s-%(lineno)d-%(asctime)s-%(levelname)s-%(message)s') # 設(shè)置日志處理器-輸出到文件 file_handler = logging.FileHandler('../log/mylog.txt') # 設(shè)置日志處理器級別 file_handler.setLevel("DEBUG") # 處理器按指定格式輸出日志 file_handler.setFormatter(fmt) # 輸出到控制臺 ch = logging.StreamHandler() # 設(shè)置日志處理器級別 ch.setLevel("DEBUG") # 處理器按指定格式輸出日志 ch.setFormatter(fmt) # 收集器和處理器對接,指定輸出渠道 # 日志輸出到文件 logger.addHandler(file_handler) # 日志輸出到控制臺 logger.addHandler(ch) if __name__ == '__main__': logger.debug('自定義的debug日志') logger.info('自定義的info日志') logger.warning('自定義的warning日志') logger.error('自定義的error日志') logger.critical('自定義的critical日志')
控制臺輸出效果:
文件輸出效果:
以上就是Python接口自動化淺析logging日志原理及模塊操作流程的詳細內(nèi)容,更多關(guān)于Python接口自動化logging日志的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
Python中基本數(shù)據(jù)類型和常用語法歸納分享
這篇文章主要為大家整理記錄了Python中基本數(shù)據(jù)類型和常用語法的使用,文中的示例代碼講解詳細,感興趣的小伙伴可以跟隨小編一起了解一下2023-04-04Python OpenCV 針對圖像細節(jié)的不同操作技巧
這篇文章主要介紹了Python OpenCV 針對圖像細節(jié)的不同操作,包括圖像像素的說明,圖像屬性信息的獲取與修改以及圖像通道的知識(包括拆分通道和合并通道),需要的朋友可以參考下2021-08-08Python實現(xiàn)刪除windows下的長路徑文件
這篇文章主要為大家詳細介紹一下如何利用Python語言實現(xiàn)刪除windows下的長路徑文件功能,文中的示例代碼講解詳細,具有一定參考借鑒價值,感興趣的可以了解一下2022-07-07python獲取全國最新省市區(qū)數(shù)據(jù)并存入表實例代碼
我們在開發(fā)中經(jīng)常會遇到獲取省市區(qū)等信息的時候,下面這篇這篇文章主要給大家介紹了關(guān)于python獲取全國最新省市區(qū)數(shù)據(jù)并存入表的相關(guān)資料,需要的朋友可以參考下2021-08-08