python 如何引入log

在Python中引入日志（log）的方法有多种，其中最常用的是使用Python内置的logging模块、通过第三方库如loguru增强日志功能、以及自定义日志类来满足特定需求。推荐使用logging模块，因为它提供了灵活的日志配置选项并且是Python标准库的一部分。接下来我们将详细介绍如何使用logging模块，并对其进行配置和优化。

一、使用LOGGING模块

Python的logging模块是记录日志的标准方式。它可以创建简单到复杂的日志记录系统，适用于小型脚本和大型应用程序。

1. 基本使用

要在Python中使用logging模块，我们需要导入它并设置基本的配置：

import logging
logging.basicConfig(level=logging.DEBUG)
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函数配置了日志系统的基本设置，包括日志级别、日志格式等。

2. 日志级别

logging模块提供了多个日志级别，按照严重性递增排序为：DEBUG、INFO、WARNING、ERROR、CRITICAL。在配置中指定的日志级别将过滤掉低于该级别的日志消息。

3. 日志格式化

可以通过basicConfig中的format参数指定日志的输出格式：

logging.basicConfig(format='%(asctime)s - %(levelname)s - %(message)s')

以上格式包含了时间、日志级别和日志消息。

二、配置日志记录器

1. 创建自定义日志记录器

在复杂应用中，通常需要更灵活的日志配置。这可以通过创建自定义的日志记录器（logger）来实现：

logger = logging.getLogger('my_logger')
logger.setLevel(logging.DEBUG)
创建控制台处理器
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)
创建文件处理器
fh = logging.FileHandler('my_log.log')
fh.setLevel(logging.WARNING)
创建格式器并添加到处理器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
ch.setFormatter(formatter)
fh.setFormatter(formatter)
将处理器添加到记录器
logger.addHandler(ch)
logger.addHandler(fh)

2. 使用日志记录器

一旦日志记录器配置完成，可以在程序中使用它来记录日志：

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')

三、LOGGING模块的高级配置

1. 配置文件

对于更复杂的日志配置，可以使用配置文件或字典配置。以下是一个配置文件示例：

[loggers]
keys=root
[handlers]
keys=consoleHandler,fileHandler
[formatters]
keys=formatter
[logger_root]
level=DEBUG
handlers=consoleHandler,fileHandler
[handler_consoleHandler]
class=StreamHandler
level=DEBUG
formatter=formatter
args=(sys.stdout,)
[handler_fileHandler]
class=FileHandler
level=WARNING
formatter=formatter
args=('my_log.log', 'a')
[formatter_formatter]
format=%(asctime)s - %(name)s - %(levelname)s - %(message)s

使用配置文件可以让日志配置与代码分离，便于管理。

2. 日志的旋转和压缩

对于长时间运行的应用，日志文件可能会变得非常大。可以使用logging.handlers中的RotatingFileHandler或TimedRotatingFileHandler来管理日志文件的大小和存储时间。

from logging.handlers import RotatingFileHandler
handler = RotatingFileHandler('my_log.log', maxBytes=2000, backupCount=5)
logger.addHandler(handler)

四、使用第三方库LOGURU

虽然logging模块功能强大，但有时配置起来比较繁琐。loguru是一个简单易用的第三方日志库，提供了更简洁的API。

1. 安装LOGURU

首先需要安装loguru：

pip install loguru

2. 使用LOGURU

loguru的使用非常简单，不需要进行复杂的配置：

from loguru import logger
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")

3. LOGURU的高级特性

loguru允许直接在日志消息中插入变量，这使得日志记录更为直观：

user_id = 123
logger.info("User with id {} has logged in", user_id)

五、自定义日志类

在某些情况下，你可能需要自定义日志类来满足特定需求。这可以通过继承logging.Logger类并重写其方法来实现。

class MyLogger(logging.Logger):
    def __init__(self, name):
        super().__init__(name)
    def custom_log(self, message):
        self.log(logging.INFO, f"Custom log: {message}")
logging.setLoggerClass(MyLogger)
logger = logging.getLogger('custom_logger')
logger.custom_log("This is a custom log message")