Python 打印日志信息 (logging模块)

1. 介绍

在开发和调试过程中，打印日志是很重要的一项任务。通过打印日志信息，我们可以实时监控程序的运行情况，排查错误，并且有助于代码的优化和维护。Python内置了一个日志模块(logging)，它提供了灵活且可配置的日志记录功能，可以满足各种打印日志的需求。

本文将详细介绍Python中的logging模块的使用方法，包括如何配置日志记录器、设置日志级别、输出日志到不同的目标等。

2. logging模块的基本概念

logging模块是Python标准库中的一个模块，它提供了一些函数和类，用于在程序中输出日志信息。使用logging模块打印日志信息具有以下几个特点：

• 可以提供多种日志级别，包括DEBUG、INFO、WARNING、ERROR和CRITICAL，不同级别的日志用于不同的目的。
• 可以将日志信息输出到不同的目标，如控制台、文件、网络等。
• 可以根据需要自定义日志记录器，并进行灵活的配置。

3. logging模块的使用方法

3.1 创建并配置日志记录器

在使用logging模块之前，需要先创建一个日志记录器。可以通过logging.getLogger()函数创建一个日志记录器对象。如果不指定名称，将使用默认名称”root”。

import logging

logger = logging.getLogger("my_logger")

创建日志记录器后，我们可以对日志记录器进行配置。常见的配置方式有两种：

• 使用basicConfig函数：该函数是logging模块的一个全局配置函数，它可以一次性设置logging的一些基本配置，如输出格式、日志级别等。一般情况下，建议在程序的入口处调用logging.basicConfig()进行全局配置。

import logging

logging.basicConfig(level=logging.DEBUG,
                    format='%(asctime)s %(levelname)s %(message)s')

• 使用文件配置：我们也可以通过加载配置文件的方式来配置logging模块。配置文件可以是一个Python源代码文件，也可以是一个JSON或INI格式的文件。

import logging.config

logging.config.fileConfig('logging.conf')

3.2 设置日志级别

日志级别用于控制哪些级别的日志将会被记录。logging模块提供了5个日志级别，从低到高依次为：DEBUG、INFO、WARNING、ERROR和CRITICAL。默认情况下，日志级别为WARNING，低于或等于该级别的日志将被忽略。

可以通过以下方式来设置日志级别：

import logging

# 设置日志记录器的级别
logger.setLevel(logging.DEBUG)

# 设置全局的日志级别
logging.basicConfig(level=logging.DEBUG)

# 设置特定模块的日志级别
logging.getLogger("my_module").setLevel(logging.DEBUG)

3.3 输出日志信息

一旦我们设置好了日志记录器和日志级别，我们就可以使用日志记录器的不同方法来输出日志信息了。

import logging

logger = logging.getLogger("my_logger")
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")

默认情况下，日志信息会被输出到控制台。如果需要将日志输出到文件或其他目标，可以通过配置logging模块来实现。

3.4 输出到文件

通过配置logging模块，我们可以将日志信息输出到一个文件中。配置方式有两种：

• 通过basicConfig函数进行全局配置。

import logging

logging.basicConfig(filename='app.log', level=logging.DEBUG)

• 通过文件配置。

创建一个配置文件logging.conf，内容如下：

[loggers]
keys=root,sampleLogger

[handlers]
keys=fileHandler

[formatters]
keys=simpleFormatter

[logger_root]
level=DEBUG
handlers=fileHandler

[logger_sampleLogger]
level=DEBUG
handlers=fileHandler
qualname=sampleLogger

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

[formatter_simpleFormatter]
format=%(asctime)s %(levelname)s %(message)s

代码中加载配置文件：

import logging.config

logging.config.fileConfig('logging.conf')

3.5 格式化输出日志信息

我们可以通过格式化字符串的方式，自定义日志信息的输出格式。格式化字符串中可以使用不同的占位符，如”%(asctime)s”、”%(levelname)s”、”%(message)s”等。

import logging

logging.basicConfig(level=logging.DEBUG,
                    format='%(asctime)s %(levelname)-8s %(message)s')

占位符的含义如下：

• %(asctime)s：当前时间，精确到毫秒。
• %(levelname)s：日志级别。
• %(message)s：日志信息。

3.6 处理异常日志

在开发过程中，我们常常需要捕获和处理异常。对于一些关键的异常，我们可以使用logging模块记录下来，方便后续分析和定位问题。

import logging

try:
    # 一些可能抛出异常的代码
    ...
except Exception as e:
    logging.exception("An error occurred")

上述代码中的logging.exception()函数会打印异常信息，并将其记录到日志中。

4. 总结

本文详细介绍了Python中的logging模块的使用方法。通过使用logging模块，我们可以灵活地打印日志信息，并进行日志级别的控制和输出目标的选择。