一篇文章帶你去搞定Python中logging模組

一、基礎使用

1.logging使用場景

日誌是什麼？這個不用多解釋。百分之九十的程式都需要提供日誌功能。 Python內建的logging模組，為我們提供了現成的高效好用的日誌解決方案。但是，不是所有的場景都需要使用logging模組，

以下是Python官方推薦的使用方法：(來源百度）

在不引發例外狀況的情況下回報錯誤

任務場景
	##在普通情況下，在控制台顯示輸出print()################報告正常程式操作過程中發生的事件######## ##############logging.info()#########(或更詳細的#########logging.debug()### ######)######
發出特定事件的警告	#warnings.warn() 或logging.warning#()
報告錯誤	彈出例外
	logging.error(), logging.exception()或logging.critical()

########## #######

logging模組定義了下表所示的日誌級別，按事件嚴重程度由低到高排列（注意是全部大寫！因為它們是常數。）：

import logging
logging.basicConfig(level = logging.INFO,format = '%(asctime)s - %(name)s - %(levelname)s - %(message)s')
logger = logging.getLogger(__name__)


logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
logger.info("Finish")

logging中可以選擇很多訊息級別，如debug、info、warning、error以及critical。透過賦予logger或handler不同的級別，開發者就可以只輸出錯誤訊息到特定的記錄文件，或是在偵錯時才記錄偵錯資訊。

logging.basicConfig(level = logging.DEBUG,format = '%(asctime)s - %(name)s - %(levelname)s - %(message)s')

例如，我們將logger的等級改為DEBUG，

再觀察輸出結果

控制台輸出，可以發現，輸出了debug的資訊。

• logging.basicConfig函數各參數：

• filename：指定日誌檔案名稱；

• filemode：和file函數意義相同，指定日誌檔案的開啟模式，'w'或'a'；

• format：指定輸出的格式和內容，format可以輸出許多有用的信息。

• datefmt：指定时间格式，同time.strftime()；

• level：设置日志级别，默认为logging.WARNNING；

• stream：指定将日志的输出流，可以指定输出到sys.stderr，sys.stdout或者文件，默认输出到sys.stderr，当stream和filename同时指定时，stream被忽略；

#参数：作用
%(levelno)s：打印日志级别的数值
%(levelname)s：打印日志级别的名称
%(pathname)s：打印当前执行程序的路径，其实就是sys.argv[0]
%(filename)s：打印当前执行程序名
%(funcName)s：打印日志的当前函数
%(lineno)d：打印日志的当前行号
%(asctime)s：打印日志的时间
%(thread)d：打印线程ID
%(threadName)s：打印线程名称
%(process)d：打印进程ID
%(message)s：打印日志信息

2. 将日志写入到文件

设置logging，创建一个FileHandler，并对输出消息的格式进行设置，将其添加到logger，然后将日志写入到指定的文件。

import logging
logger = logging.getLogger(__name__)
logger.setLevel(level = logging.INFO)
handler = logging.FileHandler("log.txt")
handler.setLevel(logging.INFO)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)
logger.addHandler(handler)


logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
logger.info("Finish")

打开log.txt文件。

2. 将日志同时输出到屏幕和日志文件

logger中添加StreamHandler，可以将日志输出到屏幕上

import logging
logger = logging.getLogger(__name__)
logger.setLevel(level = logging.INFO) #添加StreamHandler
handler = logging.FileHandler("log.txt")
handler.setLevel(logging.INFO)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)


console = logging.StreamHandler()
console.setLevel(logging.INFO)  #添加StreamHandler


logger.addHandler(handler)
logger.addHandler(console)


logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
logger.info("Finish")

控制台信息。

log.text信息。

3. 设置消息的等级

可以设置不同的日志等级，用于控制日志的输出。

#日志等级：使用范围
FATAL：致命错误
CRITICAL：特别糟糕的事情，如内存耗尽、磁盘空间为空，一般很少使用
ERROR：发生错误时，如IO操作失败或者连接问题
WARNING：发生很重要的事件，但是并不是错误时，如用户登录密码错误
INFO：处理请求或者状态变化等日常事务
DEBUG：调试过程中使用DEBUG等级，如算法中每个循环的中间状态

4. 捕获traceback

Python中的traceback模块被用于跟踪异常返回信息，可以在logging中记录下traceback.

import logging
logger = logging.getLogger(__name__)
logger.setLevel(level = logging.INFO)
handler = logging.FileHandler("log.txt")
handler.setLevel(logging.INFO)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)


console = logging.StreamHandler()
console.setLevel(logging.INFO)


logger.addHandler(handler)
logger.addHandler(console)


logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
try:
    open("sklearn.txt","rb")
except (SystemExit,KeyboardInterrupt):
    raise
except Exception:
    logger.error("Faild to open sklearn.txt from logger.error",exc_info = True)


logger.info("Finish")

控制台和日志文件log.txt中输出。

可以使用logger.exception(msg,args)，它等价于logger.error(msg,exc_info = True,args)。

将logger.error("Faild to open sklearn.txt from logger.error",exc_info = True)

替換為logger.exception("Failed to open sklearn.txt from logger.exception")

控制台和日誌檔log.txt中輸出。

#二、摘要

    本文以Pythonl基礎為例，主要介紹了logging模組的基礎使用方法，以及在現實應用中遇到的問題，進行了詳細的解答。

#

以上是一篇文章帶你去搞定Python中logging模組的詳細內容。更多資訊請關注PHP中文網其他相關文章！