Python自定義logger模塊的實(shí)例代碼

更新時(shí)間：2024年02月26日 10:46:13 作者：碼農(nóng)研究僧

Python標(biāo)準(zhǔn)庫(kù)中的logging模塊提供了日志記錄的功能,自定義 Logger 可以根據(jù)項(xiàng)目的需求定制化日志記錄,滿足特定的日志記錄格式、輸出目標(biāo)和日志級(jí)別等要求,本文給大家介紹了Python自定義logger模塊的實(shí)例代碼,需要的朋友可以參考下

1. 內(nèi)置logger

Python標(biāo)準(zhǔn)庫(kù)中的logging模塊提供了日志記錄的功能

允許開(kāi)發(fā)者通過(guò)創(chuàng)建日志記錄器、處理程序和格式化器來(lái)控制日志的生成和輸出

以下是logging模塊的一些主要組件和概念：

日志記錄器 (Logger)：整個(gè)日志系統(tǒng)的主要入口點(diǎn)
每個(gè)日志記錄操作都通過(guò)一個(gè)特定的日志記錄器來(lái)執(zhí)行。通常，每個(gè)模塊或子系統(tǒng)都會(huì)創(chuàng)建自己的日志記錄器
使用logging.getLogger(name)方法來(lái)獲取或創(chuàng)建一個(gè)日志記錄器，其中name參數(shù)是日志記錄器的名稱。如果省略name參數(shù)，則返回根日志記錄器
處理程序 (Handler)：
負(fù)責(zé)將日志記錄發(fā)送到指定的目標(biāo)，比如控制臺(tái)、文件、網(wǎng)絡(luò)等
通過(guò)logging.StreamHandler、logging.FileHandler等類來(lái)創(chuàng)建不同類型的處理程序
格式化器 (Formatter)：定義了日志消息的外觀
通過(guò)指定格式字符串來(lái)自定義日志消息的格式或者使用logging.Formatter類創(chuàng)建格式化器
日志級(jí)別 (Log Level)：
日志級(jí)別用于表示日志消息的重要性或嚴(yán)重程度，按嚴(yán)重程度從低到高排序：DEBUG、INFO、WARNING、ERROR、CRITICAL
日志記錄器和處理程序可以設(shè)置最小日志級(jí)別，只有達(dá)到或超過(guò)該級(jí)別的日志消息才會(huì)被處理

import logging

# 創(chuàng)建日志記錄器
logger = logging.getLogger('碼農(nóng)研究僧')
logger.setLevel(logging.DEBUG)

# 創(chuàng)建處理程序并設(shè)置級(jí)別
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.DEBUG)

# 創(chuàng)建格式化器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
console_handler.setFormatter(formatter)

# 將處理程序添加到日志記錄器
logger.addHandler(console_handler)

# 記錄日志
logger.debug('This is a debug message')
logger.info('This is an info message')
logger.warning('This is a warning message')
logger.error('This is an error message')
logger.critical('This is a critical message')

截圖如下：

在這里插入圖片描述

如果日志記錄器設(shè)置的登記為WARNING

# 創(chuàng)建日志記錄器
logger = logging.getLogger('碼農(nóng)研究僧')
logger.setLevel(logging.WARNING)

則輸出結(jié)果如下：

在這里插入圖片描述

2. 自定義logger

自定義 Logger 可以根據(jù)項(xiàng)目的需求定制化日志記錄，滿足特定的日志記錄格式、輸出目標(biāo)和日志級(jí)別等要求

通過(guò)自定義 Logger，可以實(shí)現(xiàn)以下功能：

定制化日志格式：可以根據(jù)需求定義日志的格式，包括時(shí)間、模塊、級(jí)別、消息等信息
輸出到不同的目標(biāo)：可以將日志記錄到控制臺(tái)、文件、數(shù)據(jù)庫(kù)、網(wǎng)絡(luò)等不同的目標(biāo)，方便日志的查看和管理
靈活設(shè)置日志級(jí)別：可以根據(jù)項(xiàng)目的需要設(shè)置不同級(jí)別的日志記錄，滿足不同的調(diào)試和排錯(cuò)需求
增加額外的功能：可以擴(kuò)展 Logger 的功能，如添加日志的歸檔、壓縮、加密等功能

可以整個(gè)拷貝的logger模塊：

from datetime import datetime
from os import path
from sys import stdout

from loguru import logger


class MyLogger(object):
    def __init__(self, log_name, level="INFO") -> logger:
        logger.remove()
        fmt = '<level>{time:YYYY-MM-DD HH:mm:ss} | {module}: {level} >> {message}</level>'
        logger.add(stdout, format=fmt)
        self.my_logger = logger
        _today = datetime.today().strftime("%Y_%m_%d")
        log_path = f"{log_name}{_today}.log"
        self.name = path.basename(log_path)
        self.my_logger.add(
            log_path, encoding="utf-8", retention='7 days', rotation="50 MB", compression='zip', format=fmt,
            enqueue=True, level=level)

    def info(self, content):
        self.my_logger.opt(depth=1).info(content)

    def debug(self, content):
        self.my_logger.opt(depth=1).debug(content)

    def error(self, content, *args, **kwargs):
        self.my_logger.opt(depth=1).error(content)
        if len(args) > 0 or len(kwargs) > 0:
            self.exception("Error details:", *args, **kwargs)

    def exception(self, content, *args, **kwargs):
        self.my_logger.opt(depth=1).exception(content, *args, **kwargs)

    def warning(self, content):
        self.my_logger.opt(depth=1).warning(content)

測(cè)試如下：

# 創(chuàng)建一個(gè)名為 "my_app" 的日志記錄器，級(jí)別為 INFO
logger = MyLogger("my_app")

# 記錄一條 INFO 級(jí)別的日志
logger.info("This is an informational message.")

# 記錄一條 DEBUG 級(jí)別的日志
logger.debug("This is a debug message.")

# 記錄一條 ERROR 級(jí)別的日志
logger.error("This is an error message.")

# 記錄一條 WARNING 級(jí)別的日志
logger.warning("This is a warning message.")

# 記錄一條 ERROR 級(jí)別的日志，并附帶額外的參數(shù)和關(guān)鍵字參數(shù)
logger.error("An error occurred.", "Extra info", custom_param="Custom value")

# 記錄一條 ERROR 級(jí)別的日志，同時(shí)記錄異常信息
try:
    result = 1 / 0
except Exception as e:
    logger.exception("An error occurred while performing a calculation.")

截圖如下：

在這里插入圖片描述