Python 中的日志处理，你掌握了哪些技巧？

在 Python 中进行日志处理是非常重要的，它可以帮助我们快速定位问题，分析程序运行情况，以及优化程序性能。本文将介绍 Python 中日志处理的一些技巧，希望能够帮助你更好地掌握日志处理。

1. 什么是日志处理

在编写程序时，我们可以通过 print() 函数打印一些调试信息，以便于调试。但是在程序运行时，有些信息并不需要打印出来，或者是在正式环境中需要记录下来以便于后续分析。这时候我们就需要使用日志处理来记录这些信息。

日志处理可以将程序运行时的信息记录到文件或者是终端中，方便我们后续分析。同时，日志处理还可以对日志信息进行过滤、格式化和级别控制，以便于我们快速定位问题。

2. Python 中的 logging 模块

Python 中的 logging 模块提供了完整的日志处理功能，它可以将日志信息记录到文件或者是终端中，同时还提供了丰富的日志过滤、格式化和级别控制功能。下面我们来介绍一些常用的日志处理技巧。

首先，我们需要导入 logging 模块：

import logging

3. 日志级别控制

在 logging 模块中，日志信息可以分为不同的级别，包括 DEBUG、INFO、WARNING、ERROR 和 CRITICAL。我们可以通过设置日志级别来控制日志信息的输出。

下面是一个简单的例子：

import logging

logging.basicConfig(level=logging.DEBUG, format="%(asctime)s - %(levelname)s - %(message)s")
logging.debug("debug message")
logging.info("info message")
logging.warning("warning message")
logging.error("error message")
logging.critical("critical message")

运行上面的代码，我们可以看到如下输出：

2021-10-20 10:49:24,066 - DEBUG - debug message
2021-10-20 10:49:24,066 - INFO - info message
2021-10-20 10:49:24,066 - WARNING - warning message
2021-10-20 10:49:24,066 - ERROR - error message
2021-10-20 10:49:24,066 - CRITICAL - critical message

可以看到，我们设置了日志级别为 DEBUG，所以所有级别的日志信息都被输出了。

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

import logging

logging.basicConfig(level=logging.WARNING, format="%(asctime)s - %(levelname)s - %(message)s")
logging.debug("debug message")
logging.info("info message")
logging.warning("warning message")
logging.error("error message")
logging.critical("critical message")

输出结果如下：

2021-10-20 10:51:13,858 - WARNING - warning message
2021-10-20 10:51:13,858 - ERROR - error message
2021-10-20 10:51:13,858 - CRITICAL - critical message

可以看到，只有 WARNING 及以上级别的日志信息被输出了。

4. 日志信息格式化

在输出日志信息时，我们可以通过格式化字符串来控制日志信息的输出格式。logging 模块中默认的日志信息格式为：%(levelname)s:%(name)s:%(message)s。我们可以通过修改 format 参数来改变日志信息的格式。

下面是一个简单的例子：

import logging

logging.basicConfig(level=logging.DEBUG, format="%(asctime)s - %(levelname)s - %(message)s")
logging.debug("debug message")
logging.info("info message")
logging.warning("warning message")
logging.error("error message")
logging.critical("critical message")

输出结果如下：

2021-10-20 10:54:22,874 - DEBUG - debug message
2021-10-20 10:54:22,874 - INFO - info message
2021-10-20 10:54:22,874 - WARNING - warning message
2021-10-20 10:54:22,874 - ERROR - error message
2021-10-20 10:54:22,874 - CRITICAL - critical message

可以看到，我们将 format 参数设置为了 "%(asctime)s - %(levelname)s - %(message)s"，这样输出的日志信息就包含了时间、级别和信息内容。

5. 将日志信息记录到文件中

除了输出到终端，我们还可以将日志信息记录到文件中。logging 模块提供了 FileHandler 类来实现将日志信息写入文件中。

下面是一个简单的例子：

import logging

logging.basicConfig(level=logging.DEBUG, format="%(asctime)s - %(levelname)s - %(message)s")
logger = logging.getLogger(__name__)

# 创建一个 FileHandler，将日志信息写入文件中
file_handler = logging.FileHandler("example.log")
file_handler.setLevel(logging.WARNING)

# 创建一个 StreamHandler，将日志信息输出到终端
stream_handler = logging.StreamHandler()
stream_handler.setLevel(logging.DEBUG)

# 设置日志信息格式
formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
file_handler.setFormatter(formatter)
stream_handler.setFormatter(formatter)

# 添加 handler
logger.addHandler(file_handler)
logger.addHandler(stream_handler)

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

运行上面的代码，我们可以看到终端输出了 WARNING 及以上级别的日志信息，并将所有级别的日志信息记录到了 example.log 文件中。

6. 自定义日志处理器

如果 logging 模块提供的处理器不能满足我们的需求，我们还可以自定义日志处理器。自定义日志处理器需要继承 logging.Handler 类，并实现 emit() 方法。

下面是一个简单的例子：

import logging

class MyHandler(logging.Handler):
    def __init__(self, filename):
        super().__init__()
        self.filename = filename

    def emit(self, record):
        with open(self.filename, "a") as f:
            f.write(self.format(record) + "
")

logging.basicConfig(level=logging.DEBUG, format="%(asctime)s - %(levelname)s - %(message)s")
logger = logging.getLogger(__name__)

# 创建一个自定义的日志处理器
my_handler = MyHandler("example.log")
my_handler.setLevel(logging.WARNING)

# 添加 handler
logger.addHandler(my_handler)

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

运行上面的代码，我们可以看到 WARNING 及以上级别的日志信息被记录到了 example.log 文件中。

7. 总结

本文介绍了 Python 中日志处理的一些技巧，包括日志级别控制、日志信息格式化、将日志信息记录到文件中和自定义日志处理器。希望这些技巧能够帮助你更好地掌握日志处理，提高程序的调试效率和性能。