python 如何使用log

在Python中使用日志（log）的方法包括：使用内置的logging模块、设置日志的级别、格式化日志输出、将日志输出到文件、根据需求调整日志记录器的配置。其中，使用内置的logging模块是最常见的方法。logging模块提供了灵活且强大的日志功能，可以满足不同场景下的日志需求。下面将详细描述如何在Python中使用logging模块记录日志信息。

一、使用logging模块

Python内置的logging模块是记录日志的标准工具。它提供了多种功能，可以帮助开发者调试和监控应用程序。

基本日志配置

要使用logging模块，首先需要进行基本的配置。这可以通过logging.basicConfig()函数来实现。基本配置通常包括设置日志级别和日志格式。

import logging
配置基本日志
logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(levelname)s - %(message)s')
记录日志
logging.debug('这是调试信息')
logging.info('这是信息消息')
logging.warning('这是警告信息')
logging.error('这是错误消息')
logging.critical('这是严重错误消息')

在上面的例子中，我们使用logging.basicConfig()函数设置了日志级别为DEBUG，这意味着所有级别（DEBUG、INFO、WARNING、ERROR、CRITICAL）的日志信息都会被记录下来。日志格式包括时间、日志级别和消息内容。

日志级别

logging模块提供了五个标准的日志级别，这些级别按严重性递增的顺序排列：

DEBUG：详细的信息，通常只在诊断问题时使用。
INFO：确认一切按预期工作。
WARNING：某些事情可能出问题，或者可能在未来出现问题。
ERROR：记录由于更严重的问题导致程序无法执行某些功能。
CRITICAL：严重错误，表明程序可能无法继续运行。

开发者可以根据需要选择合适的日志级别，以过滤掉不需要的日志信息。

二、格式化日志输出

logging模块允许自定义日志信息的格式，以便更好地理解和分析日志内容。

自定义格式

通过logging.basicConfig()函数的format参数，可以指定日志的输出格式。格式字符串可以包含格式化标志，比如时间、日志级别、文件名、行号等。

import logging
自定义日志格式
logging.basicConfig(format='%(levelname)s:%(message)s')
logging.warning('这是一个警告')

在这个例子中，我们只输出日志级别和日志消息。

复杂格式

对于更复杂的日志需求，可以包括更多的格式化标志。

import logging
复杂格式配置
logging.basicConfig(format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
logging.error('出现了一个错误')

这里，我们添加了日志的生成时间和记录器的名称。

三、将日志输出到文件

在生产环境中，将日志输出到文件通常是一个好习惯，因为它可以帮助持久化日志信息，以便后续分析和审查。

输出到文件

可以通过在basicConfig中设置filename参数，将日志记录到文件中。

import logging
输出日志到文件
logging.basicConfig(filename='app.log', level=logging.INFO)
logging.info('将此信息记录到文件中')

轮转日志文件

对于长时间运行的应用程序，可能需要将日志文件进行轮转，以防止日志文件过大。可以使用RotatingFileHandler或TimedRotatingFileHandler来实现。

import logging
from logging.handlers import RotatingFileHandler
设置轮转日志
handler = RotatingFileHandler('app.log', maxBytes=2000, backupCount=5)
logger = logging.getLogger()
logger.setLevel(logging.INFO)
logger.addHandler(handler)
logger.info('这是轮转日志的测试')

在这个例子中，日志文件的大小限制为2000字节，当达到这个大小时，会创建一个新的日志文件，并保留最多5个旧日志文件。

四、使用多个日志记录器

在复杂的应用程序中，可能需要根据不同的模块或功能使用多个日志记录器。logging模块支持创建和配置多个日志记录器。

创建日志记录器

可以使用logging.getLogger(name)创建一个新的日志记录器。

import logging
创建一个日志记录器
logger = logging.getLogger('my_logger')
设置日志级别
logger.setLevel(logging.DEBUG)
添加处理器
handler = logging.StreamHandler()
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)
logger.addHandler(handler)
logger.debug('这是来自my_logger的调试信息')

为不同模块配置不同的记录器

可以为不同的模块或功能创建不同的日志记录器，并进行独立配置。

import logging
模块A的日志记录器
logger_a = logging.getLogger('module_a')
logger_a.setLevel(logging.INFO)
模块B的日志记录器
logger_b = logging.getLogger('module_b')
logger_b.setLevel(logging.ERROR)
logger_a.info('这是模块A的信息')
logger_b.error('这是模块B的错误')

五、日志处理器和过滤器

logging模块提供了处理器（Handler）和过滤器（Filter）来管理日志的流向和内容。

日志处理器

处理器用于将日志信息发送到不同的输出目标，如控制台、文件、网络等。

import logging
创建控制台处理器
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.WARNING)
创建文件处理器
file_handler = logging.FileHandler('app.log')
file_handler.setLevel(logging.INFO)
创建日志记录器
logger = logging.getLogger('my_app')
logger.setLevel(logging.DEBUG)
添加处理器
logger.addHandler(console_handler)
logger.addHandler(file_handler)
logger.warning('这是警告信息')
logger.info('这是信息消息')

日志过滤器

过滤器用于更细粒度地控制哪些日志信息被输出。可以通过addFilter()方法向记录器或处理器添加过滤器。

import logging
自定义过滤器
class NoDebugFilter(logging.Filter):
    def filter(self, record):
        return record.levelno != logging.DEBUG
创建过滤器
no_debug_filter = NoDebugFilter()
创建处理器
console_handler = logging.StreamHandler()
console_handler.addFilter(no_debug_filter)
创建日志记录器
logger = logging.getLogger('my_app')
logger.setLevel(logging.DEBUG)
logger.addHandler(console_handler)
logger.debug('这条调试信息不会被输出')
logger.info('这条信息会被输出')