学习笔记：Python 日志记录全攻略，关键字让你搞定！

Python 日志记录全攻略

在编写 Python 代码时，我们经常需要记录程序运行过程中的信息，例如程序中出现的错误、调试信息等。这时候，我们就需要使用 Python 的日志记录模块。本文将为大家介绍 Python 日志记录的全攻略，包括日志记录的基本概念、日志记录的级别、日志记录的格式、以及如何在 Python 中使用日志记录模块。

一、日志记录的基本概念

日志记录是一种记录程序运行过程中信息的方法。在 Python 中，我们可以使用 logging 模块来实现日志记录。logging 模块提供了一个日志记录器（Logger）类，用于创建日志记录器对象。日志记录器对象可以记录不同级别的日志信息，并将这些信息输出到不同的输出目标（例如控制台、文件等）。

在使用 logging 模块时，我们需要指定日志记录的级别。Python logging 模块提供了以下五个日志记录级别：

• DEBUG：详细的调试信息，通常只在开发阶段使用。
• INFO：程序正常运行时的信息。
• WARNING：程序运行时的警告信息。
• ERROR：程序发生错误时的信息。
• CRITICAL：程序发生严重错误时的信息。

二、日志记录的级别

在 Python logging 模块中，日志记录的级别是通过 Logger 对象的 setLevel() 方法来设置的。Logger 对象的默认级别是 WARNING。我们可以通过以下代码来设置日志记录的级别：

import logging

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

在上面的代码中，我们首先创建了一个名为 logger 的 Logger 对象，并将其级别设置为 DEBUG。这意味着我们将记录所有级别的日志信息。

如果我们只想记录 WARNING 级别及以上的日志信息，可以将日志记录器的级别设置为 WARNING：

logger.setLevel(logging.WARNING)

除了设置 Logger 对象的级别外，我们还可以通过 setLevel() 方法来设置 Handler 对象的级别。Handler 对象用于定义日志记录的输出目标。例如，我们可以将日志信息输出到控制台：

import logging

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

# 创建控制台输出的 Handler
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.WARNING)

# 添加 Handler 到 Logger 对象中
logger.addHandler(console_handler)

# 记录日志信息
logger.debug("debug message")
logger.info("info message")
logger.warning("warning message")
logger.error("error message")
logger.critical("critical message")

在上面的代码中，我们首先创建了一个名为 console_handler 的 Handler 对象，并将其级别设置为 WARNING。然后，我们将该 Handler 对象添加到 logger 对象中。最后，我们记录了不同级别的日志信息，并将这些信息输出到控制台。

三、日志记录的格式

在 Python logging 模块中，我们可以通过 Formatter 对象来设置日志记录的格式。Formatter 对象可以指定日志记录的时间、级别、文件名、行号等信息。例如，我们可以使用以下代码来设置日志记录的格式：

import logging

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

# 创建控制台输出的 Handler，并设置其日志格式
console_handler = logging.StreamHandler()
formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
console_handler.setFormatter(formatter)
logger.addHandler(console_handler)

# 记录日志信息
logger.debug("debug message")
logger.info("info message")
logger.warning("warning message")
logger.error("error message")
logger.critical("critical message")

在上面的代码中，我们首先创建了一个名为 formatter 的 Formatter 对象，并将其格式设置为 "%(asctime)s - %(name)s - %(levelname)s - %(message)s"。这意味着我们将记录日志信息的时间、日志记录器的名称、日志记录的级别以及日志信息本身。

然后，我们将该 Formatter 对象设置到 console_handler 中，并将 console_handler 添加到 logger 对象中。最后，我们记录了不同级别的日志信息，并将这些信息输出到控制台。

四、在 Python 中使用日志记录模块

在 Python 中，我们可以使用 logging 模块来实现日志记录。下面是一个示例代码，演示了如何在 Python 中使用日志记录模块：

import logging

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

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

# 创建控制台输出的 Handler，并设置其日志格式
console_handler = logging.StreamHandler()
formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
console_handler.setFormatter(formatter)

# 创建文件输出的 Handler，并设置其日志格式
file_handler = logging.FileHandler("example.log")
file_handler.setFormatter(formatter)

# 添加 Handler 到 Logger 对象中
logger.addHandler(console_handler)
logger.addHandler(file_handler)

# 记录日志信息
logger.debug("debug message")
logger.info("info message")
logger.warning("warning message")
logger.error("error message")
logger.critical("critical message")

在上面的代码中，我们首先创建了一个名为 logger 的 Logger 对象，并将其级别设置为 DEBUG。然后，我们创建了两个不同的 Handler 对象：一个用于将日志信息输出到控制台，另一个用于将日志信息输出到文件 example.log 中。

最后，我们将这两个 Handler 对象添加到 logger 对象中，并记录了不同级别的日志信息。这些日志信息将同时输出到控制台和文件中。

总结

本文介绍了 Python 日志记录的全攻略，包括日志记录的基本概念、日志记录的级别、日志记录的格式以及如何在 Python 中使用日志记录模块。通过学习本文，您可以轻松地实现 Python 日志记录，并了解如何控制日志记录的级别和格式，从而更好地记录程序运行过程中的信息。