Python logging模块handlers用法详解

1. 介绍logging模块和handlers

Python的logging模块是一个灵活且功能强大的日志记录工具。通过logging模块，我们可以将程序中的关键信息记录下来，以便后续调试、分析和追踪。

而handlers是logging模块中负责将日志写入到不同输出目标的工具。通过使用不同类型的handlers，我们可以将日志输出到控制台、文件、网络等各种位置。

2. 使用StreamHandler将日志输出到控制台

StreamHandler是logging模块中最简单的一个handler，它将日志输出到标准输出流（控制台）。下面是一个简单的示例：

import logging
logger = logging.getLogger(__name__)
logger.setLevel(logging.INFO)
handler = logging.StreamHandler()
handler.setLevel(logging.INFO)
logger.addHandler(handler)
logger.info("Hello, logging!")

在上面的代码中，我们首先创建了一个logger对象，并将其日志级别设置为INFO。然后创建了一个StreamHandler对象，并将其日志级别也设置为INFO。接下来，将handler添加到logger中。

在最后一行代码中，我们使用logger的info()方法输出了一条日志到控制台。注意，只有当logger和handler的日志级别都为INFO或更低级别时，才会将日志输出到控制台。

3. 使用FileHandler将日志输出到文件

除了输出到控制台，我们也可以将日志输出到文件中。这可以通过使用FileHandler来实现。下面是一个示例：

import logging
logger = logging.getLogger(__name__)
logger.setLevel(logging.INFO)
handler = logging.FileHandler("mylog.log")
handler.setLevel(logging.INFO)
logger.addHandler(handler)
logger.info("Hello, logging!")

在上面的代码中，我们首先创建了一个logger对象，并将其日志级别设置为INFO。然后创建了一个FileHandler对象，并指定了输出的文件名为"mylog.log"。将handler的日志级别也设置为INFO，并将handler添加到logger中。

在最后一行代码中，我们使用logger的info()方法输出了一条日志到文件mylog.log中。

4. 使用RotatingFileHandler实现日志文件分割

有时候，我们希望将日志按照一定大小或者数量分割成多个文件。这可以通过使用RotatingFileHandler来实现。下面是一个示例：

import logging
import logging.handlers
logger = logging.getLogger(__name__)
logger.setLevel(logging.INFO)
handler = logging.handlers.RotatingFileHandler("mylog.log", maxBytes=1024, backupCount=3)
handler.setLevel(logging.INFO)
logger.addHandler(handler)
logger.info("Hello, logging!")

在上面的代码中，我们使用RotatingFileHandler替代了FileHandler，并指定了maxBytes参数为1024，这意味着当日志文件大小达到1024字节时，会自动分割成一个新的文件。

我们还可以通过指定backupCount参数来控制保留的日志文件数量。在上面的示例中，我们指定了backupCount为3，这意味着最多保留3个日志文件。

5. 使用TimedRotatingFileHandler实现按时间分割的日志文件

除了按文件大小分割日志文件，我们也可以按时间对日志文件进行分割。这可以通过使用TimedRotatingFileHandler来实现。下面是一个示例：

import logging
import logging.handlers
logger = logging.getLogger(__name__)
logger.setLevel(logging.INFO)
handler = logging.handlers.TimedRotatingFileHandler("mylog.log", when="D", interval=1, backupCount=7)
handler.setLevel(logging.INFO)
logger.addHandler(handler)
logger.info("Hello, logging!")

在上面的代码中，我们使用TimedRotatingFileHandler替代了RotatingFileHandler，并指定了when参数为"D"，这意味着按天对日志文件进行分割。

我们还可以通过设置interval参数来控制分割的间隔。在上面的示例中，我们指定了interval为1，这意味着每隔1天分割一次日志文件。

最后，我们还可以通过设置backupCount参数来控制保留的日志文件数量。

总结

通过使用logging模块的不同handlers，我们可以将日志输出到控制台、文件等不同位置。使用StreamHandler可以将日志输出到控制台，FileHandler可以将日志输出到文件，而RotatingFileHandler和TimedRotatingFileHandler可以实现日志文件的分割。这些功能非常便利，可以帮助我们更好地追踪、调试和分析程序。

在实际使用中，我们可以根据自己的需求选择合适的handler，并根据需要设置不同的参数来实现更加灵活的日志记录。