python如何log

Python中进行日志记录的方法有多种选择，包括使用内置的logging模块、第三方库loguru、以及手动编写日志记录功能。在这里，我们将主要探讨Python标准库中的logging模块，因为它是功能全面且易于使用的，适合大多数应用场景。使用logging模块的步骤包括：配置日志记录器、创建日志消息、将日志输出到不同的目标（如控制台或文件）、设置日志级别。接下来，将详细介绍如何使用Python的logging模块进行日志记录。

一、LOGGING模块简介

Python的logging模块是一个功能强大的标准库模块，专门用于记录日志。它提供了灵活的日志记录功能，能够满足从简单到复杂的日志记录需求。logging模块的核心组件包括日志记录器（Logger）、处理器（Handler）、格式化器（Formatter）和过滤器（Filter）。这些组件协同工作，帮助开发者有效地记录和管理日志信息。

日志记录器（Logger）

日志记录器是logging模块的核心组件，用于创建和管理日志消息。每个日志记录器都有一个名称，通常使用模块的名称来创建日志记录器，以便于管理和调试。日志记录器提供了多种级别的日志记录方法，如debug()、info()、warning()、error()和critical()。这些方法用于记录不同级别的日志消息。

处理器（Handler）

处理器负责将日志消息发送到指定的输出目标，如控制台、文件、网络等。logging模块提供了多种内置处理器，如StreamHandler（用于控制台输出）、FileHandler（用于文件输出）和SMTPHandler（用于通过电子邮件发送日志）。可以根据需要为日志记录器添加一个或多个处理器。

格式化器（Formatter）

格式化器用于定义日志消息的输出格式。通过格式化器，可以自定义日志消息的显示样式，包括时间戳、日志级别、日志记录器名称、日志消息内容等。logging模块允许开发者为每个处理器设置不同的格式化器，以满足不同的日志输出需求。

过滤器（Filter）

过滤器用于更细粒度地控制日志消息的输出。通过过滤器，可以根据特定的条件选择性地输出日志消息，而不是仅仅依赖于日志级别。logging模块允许开发者为每个日志记录器和处理器添加一个或多个过滤器，以实现复杂的日志过滤逻辑。

二、配置LOGGING模块

在使用logging模块进行日志记录之前，需要对其进行配置。配置logging模块的方法有多种，包括直接在代码中配置、使用配置文件和使用字典配置。这里将介绍直接在代码中配置logging模块的基本步骤。

创建日志记录器

首先，需要创建一个日志记录器。通常使用getLogger()方法来创建日志记录器，并为其指定一个名称。名称可以是模块名称或其他有意义的标识符。

import logging
logger = logging.getLogger('example_logger')

设置日志级别

日志级别用于控制日志消息的输出。logging模块提供了五个标准日志级别：DEBUG、INFO、WARNING、ERROR和CRITICAL。可以使用setLevel()方法为日志记录器设置日志级别。

logger.setLevel(logging.DEBUG)

创建处理器并添加到日志记录器

接下来，需要创建一个或多个处理器，并将其添加到日志记录器。处理器负责将日志消息发送到指定的输出目标。这里以创建一个控制台处理器和一个文件处理器为例。

# 创建控制台处理器
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.DEBUG)
创建文件处理器
file_handler = logging.FileHandler('example.log')
file_handler.setLevel(logging.INFO)
将处理器添加到日志记录器
logger.addHandler(console_handler)
logger.addHandler(file_handler)

创建格式化器并设置到处理器

格式化器用于定义日志消息的输出格式。可以通过Formatter类创建格式化器，并将其设置到处理器上。

# 创建格式化器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
设置格式化器到处理器
console_handler.setFormatter(formatter)
file_handler.setFormatter(formatter)

三、日志消息的创建与记录

完成配置后，可以使用日志记录器的各种方法来记录日志消息。logging模块提供了五个标准日志记录方法，分别用于记录不同级别的日志消息。

DEBUG级别

DEBUG级别用于记录调试信息，通常用于开发和调试阶段，以帮助开发者了解程序的内部状态和流程。

logger.debug('This is a debug message')

INFO级别

INFO级别用于记录一般信息，通常用于记录程序的正常运行状态和重要事件。

logger.info('This is an info message')

WARNING级别

WARNING级别用于记录警告信息，通常用于记录可能影响程序运行的潜在问题。

logger.warning('This is a warning message')

ERROR级别

ERROR级别用于记录错误信息，通常用于记录程序中出现的无法正常处理的错误。

logger.error('This is an error message')

CRITICAL级别

CRITICAL级别用于记录严重错误信息，通常用于记录导致程序终止或崩溃的严重问题。

logger.critical('This is a critical message')

四、LOGGING模块的高级用法

除了基本的日志记录功能外，logging模块还提供了一些高级功能，以满足复杂的日志记录需求。

日志记录器的层级关系

logging模块支持日志记录器的层级关系，通过使用父子关系来管理和组织日志记录器。子日志记录器会继承父日志记录器的配置，包括日志级别和处理器。可以使用getLogger()方法来获取不同层级的日志记录器。

# 创建子日志记录器
sub_logger = logging.getLogger('example_logger.sub')
sub_logger.setLevel(logging.WARNING)
子日志记录器继承父日志记录器的处理器
sub_logger.warning('This is a warning message from sub logger')

使用配置文件

logging模块支持从配置文件中加载日志配置，以实现灵活的日志管理。可以使用配置文件来定义日志记录器、处理器、格式化器和过滤器的配置。logging模块支持INI格式的配置文件，也支持通过第三方库（如json或yaml）加载其他格式的配置文件。

使用字典配置

除了配置文件，logging模块还支持使用字典配置日志记录器。通过定义字典结构，可以灵活地配置日志记录器、处理器和格式化器。

import logging.config
定义字典配置
logging_config = {
    'version': 1,
    'formatters': {
        'default': {
            'format': '%(asctime)s - %(name)s - %(levelname)s - %(message)s',
        },
    },
    'handlers': {
        'console': {
            'class': 'logging.StreamHandler',
            'level': 'DEBUG',
            'formatter': 'default',
        },
        'file': {
            'class': 'logging.FileHandler',
            'level': 'INFO',
            'formatter': 'default',
            'filename': 'example.log',
        },
    },
    'loggers': {
        'example_logger': {
            'level': 'DEBUG',
            'handlers': ['console', 'file'],
        },
    },
}
加载字典配置
logging.config.dictConfig(logging_config)
获取日志记录器
logger = logging.getLogger('example_logger')
logger.info('This is an info message')