Python中的logging模块怎么使用

封面图 • 2025-10-11 • Python

Python 的 `logging` 模块是一个非常强大且灵活的日志记录工具，用于在应用程序中记录事件、调试信息或错误消息。它可以帮助开发者跟踪代码执行过程、诊断问题以及生成日志文件。

以下是 `logging` 模块的基本用法和一些常见配置：

### 1. 基本用法

首先，你需要导入 `logging` 模块：

```python
import logging
```

#### 1.1 记录日志到控制台

最简单的用法是将日志输出到控制台：

```python
# 配置日志级别为DEBUG，输出到控制台
logging.basicConfig(level=logging.DEBUG)

# 记录不同级别的日志
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")
```

运行这段代码后，所有级别的日志都会输出到控制台。

#### 1.2 日志格式化

你可以通过 `basicConfig` 方法设置日志的格式，包括时间戳、日志级别、消息等。

```python
# 设置日志格式
logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(levelname)s - %(message)s')

logging.debug("This is a debug message")
logging.info("This is an info message")
```

输出结果可能类似于：

```
2023-01-01 12:00:00,000 - DEBUG - This is a debug message
2023-00-01 12:00:00,000 - INFO - This is an info message
```

#### 1.3 记录日志到文件

如果你想将日志写入文件而不是输出到控制台，可以设置 `filename` 参数：

```python
# 将日志输出到文件
logging.basicConfig(filename='app.log', filemode='w', level=logging.DEBUG, format='%(asctime)s - %(levelname)s - %(message)s')

logging.debug("This will go to the log file")
logging.info("So will this")
logging.warning("And this")
```

这样，所有的日志都会被写入到 `app.log` 文件中。

### 2. 高级用法

#### 2.1 多个日志处理器

你可以为同一个日志记录器添加多个处理器（如同时输出到控制台和文件）。

```python
import logging

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

# 创建一个控制台处理器并设置日志级别
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)

# 创建一个文件处理器并设置日志级别
fh = logging.FileHandler('example.log')
fh.setLevel(logging.ERROR)

# 定义日志格式
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

# 将格式应用到处理器
ch.setFormatter(formatter)
fh.setFormatter(formatter)

# 将处理器添加到日志记录器
logger.addHandler(ch)
logger.addHandler(fh)

# 记录不同级别的日志
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` 文件中。

#### 2.2 自定义日志过滤器

你可以通过自定义过滤器来决定哪些日志需要被记录。

```python
import logging

class MyFilter(logging.Filter):
    def filter(self, record):
        return record.levelno >= logging.WARNING  # 只记录警告及以上的日志

logger = logging.getLogger('example_logger')
logger.setLevel(logging.DEBUG)

# 添加过滤器
logger.addFilter(MyFilter())

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

输出结果只会包含警告及以上的日志。

#### 2.3 日志轮转

如果你的日志文件可能会变得很大，可以使用 `RotatingFileHandler` 或 `TimedRotatingFileHandler` 来实现日志轮转。

```python
import logging
from logging.handlers import RotatingFileHandler

logger = logging.getLogger('example_logger')
logger.setLevel(logging.DEBUG)

# 创建一个文件处理器，并设置最大文件大小和备份数量
handler = RotatingFileHandler('app.log', maxBytes=1000, backupCount=3)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)

logger.addHandler(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')
```

这个例子中，`RotatingFileHandler` 会在日志文件达到 1000 字节时创建一个新的日志文件，并保留最多 3 个旧的日志文件。

### 3. 总结

- `logging` 模块提供了强大的日志记录功能，支持多种日志级别、格式化、输出目标等。
- 使用 `basicConfig` 可以快速配置日志输出。
- 如果需要更复杂的配置，可以通过 `Logger`、`Handler` 和 `Formatter` 等组件进行组合。
- 日志轮转和过滤器等功能可以进一步增强日志管理能力。

希望这些内容对你有所帮助！