python如何写日志

在Python中写日志，最常用的方法是使用logging模块、设置日志级别、配置日志格式、将日志输出到文件或控制台。使用logging模块可以让你方便地记录程序的运行信息、调试错误以及监控程序状态。

首先，我们可以简单地使用Python内置的logging模块来记录日志。logging模块提供了一系列方便的功能，可以帮助开发人员记录不同级别的日志信息。我们可以通过设置日志级别来控制输出的详细程度，从DEBUG到CRITICAL共有五个级别。接下来，我们将详细讨论如何在Python中使用logging模块进行日志记录。

一、LOGGING模块概述

Python的logging模块提供了一个灵活的框架，用于记录程序运行时的事件信息。通过这个模块，你可以将日志输出到不同的目标，如控制台、文件、网络等。logging模块支持五个标准的日志级别：DEBUG、INFO、WARNING、ERROR和CRITICAL。这些级别可以用来指示日志信息的重要性。

1.1 日志级别

DEBUG：最低级别的日志信息，通常用于开发和调试。
INFO：普通的日志信息，用于记录程序的正常操作。
WARNING：警告信息，表示程序运行中出现了潜在的问题。
ERROR：错误信息，表示程序在某个操作中失败。
CRITICAL：最严重的错误，表示程序可能无法继续运行。

1.2 日志记录器、处理器和格式器

logging模块的核心概念包括记录器（Logger）、处理器（Handler）和格式器（Formatter）：

记录器（Logger）：用于生成日志信息。
处理器（Handler）：用于将日志信息输出到指定的位置，如文件或控制台。
格式器（Formatter）：用于指定日志信息的输出格式。

二、如何配置LOGGING模块

在Python中，我们可以通过几种不同的方法来配置logging模块。最简单的方法是使用基本配置函数basicConfig()，但对于复杂的日志记录需求，我们可能需要创建自定义的记录器、处理器和格式器。

2.1 使用BASICCONFIG()方法

basicConfig()方法是logging模块提供的一个快速配置日志输出的函数。它允许我们设置日志级别、日志格式和日志输出目标。以下是一个简单的示例：

import logging
配置日志输出
logging.basicConfig(level=logging.DEBUG,
                    format='%(asctime)s - %(levelname)s - %(message)s',
                    handlers=[logging.FileHandler('app.log', 'w', 'utf-8')])
记录日志
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()方法将日志信息输出到一个名为app.log的文件中，并指定了日志的格式和级别。

2.2 创建自定义记录器、处理器和格式器

对于复杂的日志记录需求，我们可以创建自定义的记录器、处理器和格式器。以下是一个示例：

import logging
创建一个记录器
logger = logging.getLogger('my_logger')
logger.setLevel(logging.DEBUG)
创建一个处理器，将日志输出到文件
file_handler = logging.FileHandler('my_log.log')
file_handler.setLevel(logging.DEBUG)
创建一个格式器，并将其添加到处理器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
file_handler.setFormatter(formatter)
将处理器添加到记录器
logger.addHandler(file_handler)
记录日志
logger.debug('Debug message')
logger.info('Info message')
logger.warning('Warning message')
logger.error('Error message')
logger.critical('Critical message')

在这个示例中，我们创建了一个名为my_logger的记录器，并将日志信息输出到一个名为my_log.log的文件中。我们还创建了一个格式器，用于指定日志信息的格式。

三、日志格式化

日志格式化是指自定义日志信息的输出格式。logging模块提供了强大的格式化功能，可以通过格式化字符串来指定日志信息的输出格式。

3.1 格式化字符串

格式化字符串可以包含以下几个可选的格式化指令：

%(asctime)s：日志事件发生的时间。
%(name)s：记录器的名称。
%(levelname)s：日志级别的名称。
%(message)s：日志信息。
%(filename)s：调用日志记录函数的源文件名。
%(lineno)d：调用日志记录函数的行号。

3.2 自定义格式器

通过创建自定义格式器，我们可以灵活地定义日志信息的输出格式：

import logging
创建记录器
logger = logging.getLogger('custom_logger')
logger.setLevel(logging.DEBUG)
创建处理器
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.DEBUG)
创建格式器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
将格式器添加到处理器
console_handler.setFormatter(formatter)
将处理器添加到记录器
logger.addHandler(console_handler)
记录日志
logger.debug('Debugging')
logger.info('Informational message')
logger.warning('Warning message')
logger.error('Error encountered')
logger.critical('Critical issue')

通过这种方式，我们可以将日志信息输出到控制台，并指定自定义的日志格式。

四、将日志输出到多个目标

在实际应用中，我们可能需要将日志信息输出到多个目标，例如同时输出到文件和控制台。logging模块支持将多个处理器添加到同一个记录器，以实现这一需求。

4.1 同时输出到文件和控制台

以下示例展示了如何将日志信息同时输出到文件和控制台：

import logging
创建记录器
logger = logging.getLogger('multi_output_logger')
logger.setLevel(logging.DEBUG)
创建文件处理器
file_handler = logging.FileHandler('multi_output.log')
file_handler.setLevel(logging.DEBUG)
创建控制台处理器
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.INFO)
创建格式器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
将格式器添加到处理器
file_handler.setFormatter(formatter)
console_handler.setFormatter(formatter)
将处理器添加到记录器
logger.addHandler(file_handler)
logger.addHandler(console_handler)
记录日志
logger.debug('Debug message')
logger.info('Info message')
logger.warning('Warning message')
logger.error('Error message')
logger.critical('Critical message')

在这个示例中，我们创建了一个名为multi_output_logger的记录器，并将日志信息输出到文件multi_output.log和控制台。我们为文件处理器设置了DEBUG级别，而为控制台处理器设置了INFO级别。

五、日志轮换与压缩

在长时间运行的程序中，日志文件可能会变得非常大。为了解决这个问题，我们可以使用日志轮换机制，将日志文件按照一定的策略进行轮换和压缩。logging模块提供了RotatingFileHandler和TimedRotatingFileHandler来实现日志轮换。

5.1 使用ROTATINGFILEHANDLER进行日志轮换

RotatingFileHandler允许我们根据日志文件的大小进行轮换：

import logging
from logging.handlers import RotatingFileHandler
创建记录器
logger = logging.getLogger('rotating_logger')
logger.setLevel(logging.DEBUG)
创建RotatingFileHandler
rotating_handler = RotatingFileHandler('rotating.log', maxBytes=2000, backupCount=5)
rotating_handler.setLevel(logging.DEBUG)
创建格式器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
rotating_handler.setFormatter(formatter)
将处理器添加到记录器
logger.addHandler(rotating_handler)
记录日志
for i in range(100):
    logger.debug(f'Debug message {i}')

在这个示例中，我们创建了一个RotatingFileHandler，并设置了最大日志文件大小为2000字节，最多保留5个备份文件。当日志文件超过指定大小时，日志文件将自动轮换。

5.2 使用TIMEDROTATINGFILEHANDLER进行时间轮换

TimedRotatingFileHandler允许我们根据时间进行日志文件轮换：

import logging
from logging.handlers import TimedRotatingFileHandler
创建记录器
logger = logging.getLogger('timed_rotating_logger')
logger.setLevel(logging.DEBUG)
创建TimedRotatingFileHandler
timed_handler = TimedRotatingFileHandler('timed.log', when='M', interval=1, backupCount=5)
timed_handler.setLevel(logging.DEBUG)
创建格式器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
timed_handler.setFormatter(formatter)
将处理器添加到记录器
logger.addHandler(timed_handler)
记录日志
for i in range(100):
    logger.debug(f'Debug message {i}')

在这个示例中，我们创建了一个TimedRotatingFileHandler，并设置了每分钟轮换一次日志文件，最多保留5个备份文件。

六、日志的国际化与本地化

在多语言环境中，我们可能需要记录多语言的日志信息。logging模块提供了国际化和本地化支持，使得日志信息可以根据不同的语言环境进行翻译。

6.1 使用gettext模块进行国际化

Python的gettext模块可以用于国际化字符串。结合logging模块，我们可以实现多语言的日志记录：

import logging
import gettext
设置语言环境
locale_path = 'locales'
language = gettext.translation('messages', localedir=locale_path, languages=['es'])
language.install()
创建记录器
logger = logging.getLogger('i18n_logger')
logger.setLevel(logging.DEBUG)
创建处理器
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.DEBUG)
创建格式器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
console_handler.setFormatter(formatter)
将处理器添加到记录器
logger.addHandler(console_handler)
记录多语言日志
logger.info(_('Info message'))
logger.warning(_('Warning message'))

在这个示例中，我们使用gettext模块进行字符串的国际化，并将多语言的日志信息记录到控制台。

七、总结

Python的logging模块提供了丰富的功能，用于记录和管理日志信息。通过灵活的配置和自定义，你可以轻松地将日志信息输出到不同的目标，并根据需要格式化日志信息。此外，logging模块还支持日志轮换、国际化等高级功能，使得日志记录更加灵活和强大。在实际应用中，合理地使用logging模块可以帮助你更好地监控和调试程序。