Python中的Logging模块

在Python编程中，日志记录（Logging）是一项至关重要的任务，它帮助我们跟踪代码的运行状态、识别错误以及优化程序性能。Python标准库中的logging模块为我们提供了强大而灵活的日志记录功能。本文将介绍如何使用logging模块，并探讨其在Python开发中的实际应用。

一、基本使用

首先，我们需要导入logging模块，并配置基本的日志记录器（Logger）。以下是一个简单的示例：

python
import logging  
  
# 配置日志记录器  
logging.basicConfig(level=logging.DEBUG,  
                    format='%(asctime)s - %(levelname)s - %(message)s',  
                    filename='example.log',  
                    filemode='w')  
  
# 在代码中使用日志记录器  
logging.debug('This is a debug message.')  
logging.info('This is an info message.')  
logging.warning('This is a warning message.')  
logging.error('This is an error message.')  
logging.critical('This is a critical message.')

在这个示例中，我们首先通过basicConfig方法配置了日志记录器。level参数用于设置日志级别，这里我们设置为DEBUG，意味着所有级别的日志都会被记录。format参数用于定义日志消息的格式，包括时间戳、日志级别和消息内容。filename参数指定了日志文件的名称，filemode参数用于设置文件的打开模式。

接下来，我们在代码中使用了不同级别的日志记录方法，如debug、info、warning、error和critical。这些方法会根据配置的日志级别来决定是否记录消息。

二、高级配置

除了基本配置外，logging模块还支持更高级的配置选项，以满足复杂的日志记录需求。例如，我们可以创建多个日志记录器，为每个记录器设置不同的处理器（Handler）和格式化器（Formatter）。

以下是一个更复杂的示例，展示了如何创建多个日志记录器，并将日志输出到控制台和文件：

python
import logging  
  
# 创建一个日志记录器  
logger = logging.getLogger('my_logger')  
logger.setLevel(logging.DEBUG)  
  
# 创建一个控制台处理器，将日志输出到控制台  
console_handler = logging.StreamHandler()  
console_handler.setLevel(logging.INFO)  
  
# 创建一个文件处理器，将日志输出到文件  
file_handler = logging.FileHandler('example.log')  
file_handler.setLevel(logging.DEBUG)  
  
# 创建一个格式化器，定义日志消息的格式  
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')  
  
# 将格式化器添加到处理器中  
console_handler.setFormatter(formatter)  
file_handler.setFormatter(formatter)  
  
# 将处理器添加到记录器中  
logger.addHandler(console_handler)  
logger.addHandler(file_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.')

在这个示例中，我们首先创建了一个名为my_logger的日志记录器，并设置了日志级别为DEBUG。然后，我们创建了一个控制台处理器和一个文件处理器，并分别为它们设置了日志级别和格式化器。最后，我们将这两个处理器添加到了记录器中。这样，当我们使用logger对象记录日志时，消息会同时输出到控制台和文件中。

三、日志模块结构

组件名称	对应的类	对应描述
日志记录器	Logger	提供了应用程序的日志记录功能
处理器	Handler	提供日志的一条处理方式
过滤器	Filter	提供了更细颗粒的控制工具来决定输出日志的记录
格式化器	Formmtter	提供日志的格式

四、项目中应用

如下的代码为django项目中使用日志记录模块的示例

import os
import logging
import sys
from django.conf import settings
from datetime import datetime

os.makedirs(settings.LOGS, exist_ok=True)


class Logger:
    _instance = None

    def __init__(self):
        self.format = '%(asctime)s %(thread)d %(threadName)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s'
        # django中项目的名称
        self.logger = logging.getLogger(settings.PROJECTNAME)
        self.logger.setLevel(logging.DEBUG)
        self.add_stream_handle()
        self.file = os.path.join(settings.LOGS, f'{datetime.now().strftime("%Y%m%d_%H%M%S")}.log')
        self.add_file_handle(self.file)

    def add_stream_handle(self):
        handler = logging.StreamHandler(sys.stdout)
        handler.setLevel(level=logging.INFO)
        handler.setFormatter(logging.Formatter(self.format))
        self.logger.addHandler(handler)

    def add_file_handle(self, file):
        handler = logging.FileHandler(file, encoding="utf-8")
        handler.setLevel(level=logging.DEBUG)
        handler.setFormatter(logging.Formatter(self.format))
        self.logger.addHandler(handler)

    @classmethod
    def get_logger(cls):
    	# 初始化一次，通常__init__.py文件中调用
        if cls._instance is None:
            cls._instance = Logger().logger
        return cls._instance
       

Logger.get_logger()

# 其他模块中使用
import logging
from django.conf import settings

logger = logging.getLogger(settings.PROJECTNAME)

logger.info("INFO")
logger.warning("WARNING")
logger.error("ERROR")