python中如何打出log

在Python中打出日志（log）可以通过多种方式实现，最常见的方法是使用Python内置的logging模块。logging模块提供了灵活的日志记录功能、支持不同日志级别、可以将日志输出到不同的目的地如控制台、文件等、并且易于配置和管理。在开始使用logging模块之前，了解如何设置和使用它是非常重要的。下面将详细介绍如何在Python中使用logging模块来打日志。

一、LOGGING模块的基础使用

Python的logging模块提供了一个标准接口，用于记录和报告日志消息。它支持多种日志级别，分别是：DEBUG、INFO、WARNING、ERROR和CRITICAL。以下是如何使用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('这是一个严重消息')

在这个例子中，basicConfig函数配置了日志的输出格式为时间戳、日志级别和消息内容，并将日志级别设为DEBUG，这意味着会显示所有级别的日志。

日志级别

每个日志级别都有其特定的用途：
- DEBUG：详细信息，通常只在诊断问题时使用。
- INFO：确认一切按预期运行。
- WARNING：某些情况出现问题的指示，但软件仍然继续运行。
- ERROR：由于更严重的问题，软件未能执行某些功能。
- CRITICAL：非常严重的问题，表明程序可能无法继续运行。

二、日志输出到文件

除了将日志输出到控制台，logging模块还支持将日志记录到文件中。这样可以在需要时查看历史日志。

配置日志输出到文件

通过修改basicConfig的参数，可以指定日志输出的文件。
```
import logging
配置日志输出到文件
logging.basicConfig(filename='app.log', filemode='a', level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
logging.info('这条信息将被记录到文件中')
```
在这个配置中，filename参数指定了日志文件的名称，filemode='a'表示以追加模式打开文件（如果文件存在则在文件末尾追加日志）。
日志文件的管理

在生产环境中，日志文件可能会快速增长，因此需要对日志文件进行管理，例如限制日志文件的大小、自动备份等。logging模块提供了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('这条信息将被记录到轮转文件中')
```
在这个例子中，RotatingFileHandler会在日志文件达到2000字节时创建一个新的文件，并保留最多5个备份。

三、日志格式化

日志格式化是日志记录中的一个重要部分，它决定了日志的外观和信息量。logging模块允许我们通过设置格式化字符串来自定义日志的格式。

基本格式化

使用basicConfig的format参数可以指定日志消息的格式：
```
import logging
logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
logger = logging.getLogger('exampleLogger')
logger.debug('这是一个格式化的调试消息')
```
格式字符串中包含的变量包括：
- %(asctime)s：事件发生的时间
- %(name)s：记录器的名称
- %(levelname)s：日志级别名称
- %(message)s：日志消息

高级格式化

对于更复杂的日志格式，您可以使用Formatter类：

import logging
创建格式化器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
创建处理器
handler = logging.StreamHandler()
handler.setFormatter(formatter)
创建记录器
logger = logging.getLogger('advancedLogger')
logger.setLevel(logging.DEBUG)
logger.addHandler(handler)
logger.info('这是一个高级格式化的信息消息')

在这个例子中，我们创建了一个Formatter对象并将其应用到一个处理器上，然后将该处理器添加到记录器。

四、不同的日志处理器

logging模块支持多种日志处理器，允许将日志输出到多个目的地。

流处理器（StreamHandler）

StreamHandler用于将日志输出到流（如sys.stdout或sys.stderr）。这是默认的处理器类型。

import logging
logger = logging.getLogger('streamLogger')
stream_handler = logging.StreamHandler()
logger.addHandler(stream_handler)
logger.info('这是一个流处理器的信息消息')

文件处理器（FileHandler）

FileHandler用于将日志输出到文件。

import logging
logger = logging.getLogger('fileLogger')
file_handler = logging.FileHandler('app.log')
logger.addHandler(file_handler)
logger.info('这是一个文件处理器的信息消息')

旋转文件处理器（RotatingFileHandler）

RotatingFileHandler用于管理日志文件的大小和备份。

import logging
from logging.handlers import RotatingFileHandler
logger = logging.getLogger('rotatingFileLogger')
rotating_file_handler = RotatingFileHandler('app.log', maxBytes=2000, backupCount=5)
logger.addHandler(rotating_file_handler)
logger.info('这是一个旋转文件处理器的信息消息')

时间旋转文件处理器（TimedRotatingFileHandler）

TimedRotatingFileHandler用于根据时间间隔来管理日志文件。

import logging
from logging.handlers import TimedRotatingFileHandler
logger = logging.getLogger('timedRotatingFileLogger')
timed_rotating_file_handler = TimedRotatingFileHandler('app.log', when='midnight', interval=1, backupCount=7)
logger.addHandler(timed_rotating_file_handler)
logger.info('这是一个时间旋转文件处理器的信息消息')

在这个例子中，日志文件每天午夜创建一个新文件，并保留7个备份。

五、日志记录器的使用

在复杂的应用程序中，通常需要为不同的模块或功能创建不同的日志记录器。logging模块支持层次化的日志记录器结构。

创建命名日志记录器

可以通过logging.getLogger(name)来创建或获取一个命名日志记录器。
```
import logging
创建命名日志记录器
logger = logging.getLogger('myModuleLogger')
logger.setLevel(logging.DEBUG)
logger.debug('这是一个来自myModuleLogger的调试消息')
```
使用命名日志记录器可以更好地组织日志输出，并且可以为不同的模块设置不同的日志级别。

层次化日志记录器

日志记录器可以有父子关系，子记录器继承父记录器的配置。

import logging
创建父记录器
parent_logger = logging.getLogger('parentLogger')
parent_logger.setLevel(logging.INFO)
创建子记录器
child_logger = logging.getLogger('parentLogger.child')
child_logger.info('这是一个来自子记录器的信息消息')

在这个例子中，child_logger继承了parent_logger的配置，并输出信息级别的日志。

六、日志过滤和自定义日志级别

在某些情况下，可能需要过滤掉某些日志消息，或者定义自定义的日志级别。

日志过滤

可以使用过滤器（Filter）来控制哪些日志消息应该被记录。

import logging
class MyFilter(logging.Filter):
    def filter(self, record):
        return '特定关键词' in record.msg
logger = logging.getLogger('filterLogger')
logger.addFilter(MyFilter())
logger.info('这条日志包含特定关键词')
logger.info('这条日志将被过滤掉')

在这个例子中，只有包含“特定关键词”的日志消息才会被记录。

自定义日志级别

可以定义自己的日志级别，并使用logging.addLevelName()来将其添加到logging模块中。

import logging
CUSTOM_LEVEL = 15
logging.addLevelName(CUSTOM_LEVEL, 'CUSTOM')
def custom(self, message, *args, kws):
    if self.isEnabledFor(CUSTOM_LEVEL):
        self._log(CUSTOM_LEVEL, message, args, kws)
logging.Logger.custom = custom
logger = logging.getLogger('customLogger')
logger.setLevel(CUSTOM_LEVEL)
logger.custom('这是一个自定义级别的日志消息')

在这个例子中，我们定义了一个自定义日志级别，并为日志记录器添加了一个方法来记录该级别的日志消息。

七、日志的国际化

对于多语言应用程序，可能需要对日志消息进行国际化处理。logging模块支持使用gettext来实现日志消息的翻译。

使用gettext进行国际化

首先，需要安装gettext库并准备翻译文件。

import logging
import gettext
设置语言环境
gettext.bindtextdomain('myapp', 'locale')
gettext.textdomain('myapp')
_ = gettext.gettext
logger = logging.getLogger('i18nLogger')
logger.info(_('这是一个国际化的日志消息'))

在这个例子中，我们使用gettext库来翻译日志消息。