Python使用日志模塊快速調(diào)試代碼并記錄異常信息

更新時(shí)間：2023年04月25日 11:36:43 作者：csdn1561168266

本文詳細(xì)介紹了Python logging日志模塊的使用方法，包括如何在代碼中使用logging記錄調(diào)試信息、如何設(shè)置日志級(jí)別、如何記錄異常信息等。通過(guò)本文的指南，讀者可以快速學(xué)會(huì)如何使用logging模塊進(jìn)行調(diào)試，并保留有用的日志信息，便于后續(xù)排查問(wèn)題和優(yōu)化代碼

一、日志層級(jí)

在開(kāi)始之前，需要注意的是，在日志記錄中存在一個(gè)層次結(jié)構(gòu)，稱為日志樹(shù)或日志者層次結(jié)構(gòu)。該層次結(jié)構(gòu)由幾個(gè)級(jí)別組成，每個(gè)級(jí)別代表了日志信息的不同嚴(yán)重程度。最常見(jiàn)的層次是：

CRITICAL #A critical error occurred, the program may not be able to continue running.
ERROR #An error occurred that should be investigated.
WARNING #An indication that something unexpected happened or indicative of some problem in the near future.
INFO #General information about the program's execution.
DEBUG #Detailed information for debugging purposes.

二、創(chuàng)建模塊

讓我們創(chuàng)建一個(gè)名為set_logging.py的python模塊:

import logging
logger = logging.getLogger()
def set_logger():
  logger.setLevel(logging.INFO)
  handler = logging.StreamHandler()
  handler.setLevel(logger_level)
  formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
  handler.setFormatter(formatter)
  logger.addHandler(handler)

為了明確代碼，我們用getLogger函數(shù)創(chuàng)建一個(gè)日志器實(shí)例，并使用setLevel來(lái)設(shè)置日志級(jí)別（DEBUG、INFO等）。日志器的setLevel方法就像一個(gè)過(guò)濾器，它決定了一條日志信息是否應(yīng)該被處理并發(fā)送給處理程序。例如，如果我們將日志記錄器的級(jí)別設(shè)置為INFO，那么日志記錄器就不會(huì)向處理程序發(fā)送級(jí)別為DEBUG的消息，因?yàn)樗鼈兊膰?yán)重程度低于在日志記錄器上設(shè)置的最低級(jí)別。它只將級(jí)別為INFO或更高的日志消息（即WARNING、ERROR或CRITICAL）發(fā)送給處理程序進(jìn)行處理。

我們創(chuàng)建一個(gè)StreamHandler，將日志信息發(fā)送到一個(gè)流中，如控制臺(tái)或終端。它被用來(lái)輸出日志信息以達(dá)到調(diào)試的目的。我們還為處理程序設(shè)置了級(jí)別。

我們這樣做是因?yàn)楫?dāng)處理程序收到來(lái)自日志記錄器的消息時(shí)，它將把這些消息與它的級(jí)別進(jìn)行比較，并在發(fā)出之前過(guò)濾掉嚴(yán)重程度較低的消息。當(dāng)我們有不同的處理程序時(shí)：

logger.setLevel(logging.INFO)
file_handler = logging.FileHandler()
file_handler.setLevel(logging.ERROR)
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.WARNING)

由于日志記錄器的級(jí)別被設(shè)置為INFO，它只向兩個(gè)處理程序發(fā)送級(jí)別為INFO或更高的日志消息，但每個(gè)處理程序只處理達(dá)到或超過(guò)其指定日志級(jí)別的消息。

回到我們的主要例子，然后我們創(chuàng)建一個(gè)格式化器并將其添加到處理程序中。格式化器指定了日志消息的格式，包括時(shí)間戳、日志記錄器名稱、日志級(jí)別和消息。最后，我們將處理程序添加到日志記錄器中"。

現(xiàn)在在代碼中，需要調(diào)用set_logger，如下所示：

import logging
from set_logging import set_logger
set_logger()
logger = logging.getLogger()
def roman_number(s: str) -> int:
    dic = {"I": 1, "V": 5, "X": 10, "L": 50, "C": 100, "D": 500, "M": 1000}
    res = 0
    pre = None
    for char in s:
        res += dic.get(char)
        if dic.get(pre) and dic.get(pre) < dic.get(char):
            res -= 2 * dic.get(pre)
        pre = char
    logger.info("logging is awesome")
    return res
roman_number("IV")

運(yùn)行這段代碼，結(jié)果如下：

2023-03-04 02:26:57,619 - root - INFO - logging is awesome

三、使用日志的優(yōu)點(diǎn)

級(jí)別。一個(gè)日志記錄器提供了一種方法來(lái)為不同類型的消息設(shè)置不同的日志級(jí)別，如DEBUG、INFO、WARNING、ERROR和CRITICAL。這使得根據(jù)日志消息的嚴(yán)重程度來(lái)過(guò)濾和確定其優(yōu)先級(jí)變得更加容易。當(dāng)然，打印可以模仿與日志相同的行為，但它需要更多的硬編碼工作，而且不像日志那樣靈活。
性能。打印日志信息可能比使用記錄器慢，特別是在處理大量數(shù)據(jù)或頻繁進(jìn)行記錄的時(shí)候。
可配置性。記錄器提供了一種方法來(lái)配置應(yīng)用程序的日志行為，如日志級(jí)別、日志目的地和日志格式，而無(wú)需修改源代碼。這使得隨著時(shí)間的推移，更容易管理和維護(hù)日志行為。
靈活性。記錄器允許你將日志信息發(fā)送到多個(gè)目的地，如控制臺(tái)、文件或數(shù)據(jù)庫(kù)。這種靈活性使得管理日志和分析它們變得更加容易。

到此這篇關(guān)于Python使用日志模塊快速調(diào)試代碼并記錄異常信息的文章就介紹到這了,更多相關(guān)Python日志模塊調(diào)試內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: