Python日志模块详解|极客教程

Python日志模块详解

一、引言

日志对于软件开发来说是一项至关重要的功能。它可以帮助开发者追踪程序的运行状态，记录错误信息，方便排查问题。Python中的日志模块提供了一种简便而灵活的方式来管理和记录程序的日志信息。本文将详细介绍Python日志模块的基本用法和高级特性。

二、日志基本概念

在开始介绍Python的日志模块之前，我们先来了解一下日志的基本概念。

1. 日志级别

日志级别是指根据严重程度进行分类的日志消息。在Python的日志模块中，定义了以下几个级别：

DEBUG: 调试信息，用于开发和调试阶段
INFO: 一般信息，描述程序运行状态或事件
WARNING: 警告信息，表示程序可能出现问题但不会影响程序的正常运行
ERROR: 错误信息，表示程序出现了错误但仍能继续运行
CRITICAL: 严重错误信息，表示程序遇到了严重问题，需要立即处理

2. 日志记录器（Logger）

日志记录器是Python日志模块的核心组件，用于向不同的目标输出日志信息。每个记录器可以设置不同的级别和处理器。

3. 日志处理器（Handler）

日志处理器负责将日志信息发送到指定的目标，比如控制台、文件、网络等。常见的处理器有：

StreamHandler: 将日志输出到控制台
FileHandler: 将日志输出到文件
RotatingFileHandler: 将日志输出到文件，并支持日志轮转

4. 日志格式化器（Formatter）

日志格式化器可以定制日志信息的格式，比如日期时间格式、级别、消息等。通过格式化器可以让日志信息更易于阅读和理解。

三、日志模块基本用法

下面我们来创建一个简单的Python脚本，展示日志模块的基本用法。

import logging

# 创建一个日志记录器
logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)

# 创建一个文件处理器
file_handler = logging.FileHandler('example.log')
file_handler.setLevel(logging.DEBUG)

# 创建一个控制台处理器
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.INFO)

# 创建一个日志格式化器
formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
file_handler.setFormatter(formatter)
console_handler.setFormatter(formatter)

# 将处理器添加到记录器
logger.addHandler(file_handler)
logger.addHandler(console_handler)

# 输出日志信息
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')

运行上述代码后，我们将得到一个名为example.log的日志文件，并在控制台上输出相应的日志信息。

四、高级特性

1. 日志轮转

当日志文件过大时，我们往往需要对日志文件进行轮转，以免占用过多的磁盘空间。Python的RotatingFileHandler处理器可以实现日志轮转功能。下面我们来看一个示例代码：

import logging
from logging.handlers import RotatingFileHandler

logger = logging.getLogger(__name__)
logger.setLevel(logging.INFO)

file_handler = RotatingFileHandler('example.log', maxBytes=500, backupCount=2)
file_handler.setLevel(logging.INFO)

formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
file_handler.setFormatter(formatter)

logger.addHandler(file_handler)

for i in range(10):
    logger.info('This is message {}'.format(i))

运行上述代码后，我们将得到一个轮转后的日志文件，其中包含了信息1到9的日志记录，并且只保留了最新的两个轮转文件。

2. 日志过滤

有时候我们希望只记录特定级别的日志信息，可以使用日志过滤器来实现。下面是一个示例代码：

import logging

class InfoFilter(logging.Filter):
    def filter(self, record):
        return record.levelno == logging.INFO

logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)

file_handler = logging.FileHandler('example.log')
file_handler.setLevel(logging.INFO)
file_handler.addFilter(InfoFilter())

formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
file_handler.setFormatter(formatter)

logger.addHandler(file_handler)

logger.debug('This is a debug message')
logger.info('This is an info message')
logger.warning('This is a warning message')

运行上述代码后，我们将只会在日志文件中看到INFO级别的日志信息。