python 中怎么用 logging 日志

Python 中使用 logging 日志能够帮助开发者记录应用程序的运行情况, 方便追踪错误和异常。具体做法包括创建 Logger、设置级别、定义 Handler 和 Formatter。在开发时，首先需要导入 logging 模块，然后通过配置 Logger、Handler、Formatter，合理地输出日志到不同的目的地，如控制台、文件等。

一、创建日志记录器 LOGGER

Python 提供了一个 logging 模块的基础设施，允许通过创建 Logger 实例来开始记录日志。一个日志记录器(Logger)实例可以被看作是一个日志应用的入口。

import logging

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

在这里，首先导入了 logging 模块，之后创建了一个 Logger 实例并设置了日志级别为 DEBUG。Logger 提供了应用程序可直接使用的接口，开发者可以通过日志记录器直接记录日志。

二、设置日志级别

日志级别决定了日志记录的严重性级别。logging 模块定义了多种日志级别。

logger.setLevel(logging.DEBUG)  # 设置日志级别为DEBUG

有效的日志级别包括 DEBUG、INFO、WARNING、ERROR 以及 CRITICAL，分别对应不同层级的严重程度，从调试信息到致命错误。

三、配置处理器 HANDLER

处理器(Handler)对象将日志记录（消息）发送到日志的指定目的地。

# 创建一个控制台处理器，并设置其日志级别为DEBUG

console_handler = logging.StreamHandler()
console_handler.setLevel(logging.DEBUG)
可以创建其他处理器，比如文件处理器
file_handler = logging.FileHandler(filename='app.log')
file_handler.setLevel(logging.INFO)

创建了一个控制台处理器和一个文件处理器，并分别设置了它们的日志级别。开发者可以根据需要将日志输出到不同的位置，比如文件、网络服务器等。

四、定义格式器 FORMATTER

Formatter 对象定义了最终输出中日志记录的布局。

# 定义格式器

formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
将定义好的格式器添加到处理器中
console_handler.setFormatter(formatter)
file_handler.setFormatter(formatter)

创建 Formatter 的实例，并定义了一种特定的日志格式。这种格式包含时间戳、记录器名称、日志级别，以及实际的消息文本。

五、将处理器添加到记录器 LOGGER

完成了上述步骤后，需要将 Handler 对象添加到 Logger 中。

logger.addHandler(console_handler)

logger.addHandler(file_handler)

将先前定义的 console_handler 和 file_handler 添加到 logger 中。这样就完成了 Logger 的基本配置，可以根据需要记录日志。

六、日志记录

日志级别一旦设置，就可以开始记录日志：

logger.debug('Debugging information')

logger.info('Informational message')
logger.warning('Warning occurred')
logger.error('An error has happened')
logger.critical('Critical issue')

使用 logger 对象，根据不同的级别记录不同类型的日志。这些方法接受一个日志消息作为必填参数，并且可以提供额外的关键字参数用于记录更多信息。

通过配置 logging 模块，可以使代码日志化，极大地提升应用的可维护性和可监控性。业界标准实践通常会进一步对日志系统进行抽象和封装，便于在不同的程序模块间复用并提高代码整洁性。

相关问答FAQs：

如何在Python中使用logging模块记录日志？

1. 什么是logging模块和为何使用它记录日志？
   logging是Python标准库中的一个模块，用于记录应用程序的运行时信息。通过使用logging模块，您可以在代码中插入日志语句，在程序运行时捕获和记录相关信息。

2. 如何在代码中添加日志记录语句？
   首先，您需要导入logging模块：import logging。然后，您可以使用logging.basicConfig()方法进行基本的配置设置，例如指定日志文件的名称、格式等。接下来，可以在代码中使用logging.debug()、logging.info()、logging.warning()等方法来记录不同级别的日志信息。

3. 如何控制日志的级别和记录的信息？
   logging模块支持多个日志级别，包括DEBUG、INFO、WARNING、ERROR和CRITICAL等。您可以使用logging.setLevel()方法来设置日志的最低级别，从而控制日志的输出。此外，您还可以使用logging.getLogger()方法创建或获取一个logger对象，在其中设置记录的格式、日志处理程序等。

4. 如何将日志记录到文件中？
   使用logging.basicConfig()方法中的filename参数，可以将日志记录到指定的文件中。您可以使用绝对路径或相对路径来指定文件的位置和名称。如果您没有指定文件名，则日志将被输出到控制台。

5. 如何在不同模块中共享日志配置？
   您可以在一个模块中配置日志，然后将此配置导入其他模块，以便在整个应用程序中共享相同的日志设置。这样，不同模块中的日志信息将一致，并遵循相同的格式和级别。

总之，使用logging模块可以方便地记录和调试代码，帮助开发人员在日后排查问题时更轻松地定位和解决错误。