Python Logging文件配置详解

前言

在软件开发过程中，我们经常需要输出日志来帮助我们调试和追踪问题。Python提供了logging模块来实现日志功能。logging模块是Python标准库中的模块，它提供了强大而灵活的日志记录功能，可以将日志输出到控制台、文件、网络等地方。

本文将详细介绍如何使用logging模块进行日志记录，以及如何通过配置文件来配置日志输出的方式和格式。

logging模块的基本概念

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

logging模块主要包含以下几个关键组件：

  • Logger：日志记录器，用于产生日志记录。我们可以通过Logger对象来创建和输出日志。
  • Handler：日志处理器，用于处理Logger产生的日志记录。Handler可以将日志输出到不同的目标，如控制台、文件、网络等。
  • Formatter：日志格式化器，用于定义日志输出的格式。Formatter可以设定输出的时间、日志级别、日志消息等。
  • Filter：日志过滤器，用于过滤和筛选Logger产生的日志记录。

在使用logging模块进行日志记录时，我们通常需要完成以下几个步骤：

  1. 创建Logger对象：通过Logger对象来创建和输出日志。
  2. 创建Handler对象：通过Handler对象来处理Logger产生的日志记录。
  3. 创建Formatter对象：通过Formatter对象来定义日志输出的格式。
  4. 设置Logger对象的日志级别：通过设置Logger对象的日志级别来控制日志的输出级别。
  5. 添加Handler对象到Logger对象：通过addHandler()方法将Handler对象添加到Logger对象中。
  6. 添加Formatter对象到Handler对象：通过setFormatter()方法将Formatter对象添加到Handler对象中。
  7. 添加Filter对象到Logger对象或Handler对象：通过addFilter()方法将Filter对象添加到Logger对象或Handler对象中。

有了以上基本概念的了解，我们就可以开始配置我们的日志记录了。

日志配置文件

Python的logging模块提供了通过配置文件来配置日志记录的方式。配置文件是一个包含了日志配置信息的文本文件，我们可以通过修改配置文件中的内容来配置日志的输出方式和格式。

下面是一个典型的日志配置文件的示例：

[loggers]
keys=root,sampleLogger

[handlers]
keys=consoleHandler,fileHandler

[formatters]
keys=simpleFormatter,verboseFormatter

[logger_root]
level=DEBUG
handlers=consoleHandler,fileHandler

[logger_sampleLogger]
level=INFO
handlers=consoleHandler
qualname=sampleLogger
propagate=0

[handler_consoleHandler]
class=StreamHandler
level=DEBUG
formatter=simpleFormatter
args=(sys.stdout,)

[handler_fileHandler]
class=FileHandler
level=DEBUG
formatter=verboseFormatter
args=('app.log','w')

[formatter_simpleFormatter]
format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
datefmt=%Y-%m-%d %H:%M:%S

[formatter_verboseFormatter]
format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
datefmt=%Y-%m-%d %H:%M:%S

上述配置文件中包含了4个部分：loggers、handlers、formatters和filters。每个部分以keys开头，后面跟着各个组件的名称。

  • loggers：定义Logger对象的配置信息，包括Logger的名称、日志级别、Handler等。
  • handlers：定义Handler对象的配置信息，包括Handler的名称、类型、日志级别、Formatter等。
  • formatters：定义Formatter对象的配置信息，包括Formatter的名称、日志输出格式等。

我们可以根据自己的需求来修改和扩展配置文件，以实现各种不同的日志记录方式和格式。

下面我们来看一下如何在代码中使用配置文件。

使用配置文件配置日志

要在代码中使用配置文件来配置日志记录，我们需要使用logging.config模块的fileConfig()方法。

下面是一个使用配置文件来配置日志的示例：

import logging.config

# 加载配置文件
logging.config.fileConfig('logging.conf')

# 创建Logger对象
logger = logging.getLogger('sampleLogger')

# 输出日志