python logging 模块基础
logging 模块的基本原理是建立一个记录器(logger),然后通过调用 logger 的方法来记录消息。记录器有一个级别,它决定了将记录哪些消息。logging 模块定义了几个预定义的级别,包括 DEBUG、INFO、WARNING、ERROR 和 CRITICAL。
import logging # 创建一个名为 "my_logger" 的记录器,并设置其级别为 INFO logger = logging.getLogger("my_logger") logger.setLevel(logging.INFO)
记录器可以通过其方法来记录消息:
# 记录一条 INFO 级别的消息 logger.info("This is an INFO message") # 记录一条 WARNING 级别的消息 logger.warning("This is a WARNING message") # 记录一条 ERROR 级别的消息 logger.error("This is an ERROR message")
日志处理程序
日志处理程序(handler)将日志消息写入特定目标,例如控制台、文件或网络服务器。logging 模块提供了几个预定义的处理程序:
# 创建一个控制台处理程序 handler = logging.StreamHandler() # 创建一个文件处理程序,将日志写入文件 "my_log.txt" handler = logging.FileHandler("my_log.txt")
处理程序可以通过添加到记录器来附加到记录器:
# 将处理程序添加到记录器 logger.addHandler(handler)
日志格式器
日志格式器(fORMatter)控制日志消息的外观。logging 模块提供了几个预定义的格式器:
# 创建一个基本格式器 formatter = logging.BasicFormatter() # 使用自定义格式字符串创建自定义格式器 formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
格式器可以通过添加到处理程序来附加到处理程序:
# 将格式器添加到处理程序 handler.setFormatter(formatter)
常见问题
1. 如何在 Python 脚本中设置日志记录级别?
import logging # 设置根日志记录器的级别为 INFO logging.basicConfig(level=logging.INFO)
2. 如何记录异常?
try: # 尝试执行一些代码 except Exception as e: # 记录异常 logger.error(e, exc_info=True)
3. 如何禁用特定处理程序?
# 禁用控制台处理程序 logger.removeHandler(handler)
4. 如何使用自定义日志格式?
# 使用自定义格式字符串创建自定义格式器 formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s") # 将格式器添加到处理程序 handler.setFormatter(formatter)
5. 如何捕获未捕获的异常并将其记录到文件?
import sys import logging def exception_handler(type, value, traceback): # 记录未捕获的异常 logger.error(value, exc_info=(type, value, traceback)) sys.excepthook = exception_handler
结论
Python logging 模块是一个功能强大的工具,可以帮助您轻松地记录和处理应用程序消息。通过掌握其关键知识点,您可以有效地使用 logging 模块来调试、故障排除和分析应用程序的行为。