Loguru 日志无法输出文件的解决方法

<p>本文旨在解决 Python Loguru 库中错误日志仅输出到终端，无法同步输出到日志文件的问题。通过分析 `sys.excepthook` 的工作原理，解释了 Loguru 无法捕获未处理异常的原因，并介绍了使用 `@logger.catch` 装饰器来捕获和记录这些异常的方法，确保所有错误信息都能正确记录到日志文件中。</p> 在使用 Loguru 进行日志记录时，有时会遇到一个问题：普通的日志信息（如 `logger.info()` 或 `logger.debug()` 输出的内容）可以同时显示在终端和日志文件中，但程序中未捕获的异常错误却只显示在终端，而不会写入日志文件。这给问题排查带来不便，因为我们希望所有重要的信息，包括错误信息，都能记录到日志文件中。 **问题分析：`sys.excepthook` 的作用** 要理解这个问题，需要了解 Python 中 `sys.excepthook` 的作用。当程序中发生未被 `try...except` 块捕获的异常时，Python 解释器会调用 `sys.excepthook` 来处理这个异常。默认情况下，`sys.excepthook` 会将异常信息输出到标准错误输出 (`sys.stderr`)。 Loguru 库配置的日志记录器可以捕获通过 `logger.info()`、`logger.error()` 等方法显式记录的信息，但它无法自动捕获 `sys.excepthook` 输出的异常信息。这是因为 Loguru 并未直接接管 `sys.excepthook` 的行为，而是依赖于用户通过日志记录器主动记录信息。因此，错误信息虽然显示在终端上（因为终端通常会显示 `sys.stdout` 和 `sys.stderr` 的内容），但不会被 Loguru 写入日志文件。 **解决方案：使用 `@logger.catch` 装饰器** Loguru 提供了一个方便的装饰器 `@logger.catch`，可以用来捕获未处理的异常，并将它们记录到配置的日志输出中。 `@logger.catch` 实际上是在被装饰的函数周围添加了一个 `try...except` 块，当函数内部发生异常时，`except` 块会捕获该异常，并使用 Loguru 记录异常信息。 以下是一个使用 `@logger.catch` 的示例： ```python from loguru import logger def divide(): try: result = 1 / 0 # 触发 ZeroDivisionError 异常 return result except Exception as e: logger.error(f"发生异常: {e}") raise # 重新抛出异常，以便后续处理 (可选) @logger.catch def main(): divide() if __name__ == "__main__": main()

在这个例子中，divide() 函数内部会触发 ZeroDivisionError 异常。@logger.catch 装饰器装饰了 main() 函数，因此 main() 函数内部未捕获的异常会被 Loguru 捕获并记录到日志文件中。

代码解释：

1. from loguru import logger: 导入 Loguru 库的 logger 对象。
2. @logger.catch: 这个装饰器告诉 Loguru 捕获 main() 函数中发生的任何未处理的异常。
3. main(): 程序的入口点。
4. divide(): 一个简单的函数，用于演示异常的产生。这里故意触发一个 ZeroDivisionError 异常。
5. if __name__ == "__main__":: Python 的标准入口点判断。

配置 Loguru

确保 Loguru 已经正确配置，以便将日志输出到文件。例如：

import sys
from loguru import logger
import os

root_dir = os.path.dirname(os.path.abspath(__file__))
log_level = "DEBUG"  # 设置日志级别

logger.remove(0) # 删除默认的handler，否则会重复打印
log_format = "<green>{time:YYYY-MM-DD HH:mm:ss.SSS zz}</green> | <level>{level: <8}</level> | <yellow>Line {line: >4} ({file}):</yellow> <b>{message}</b>"
logger.add(sys.stdout, level=log_level, format=log_format, colorize=True, backtrace=True, diagnose=True)
logger.add(root_dir + '/cron_run.log', rotation='2 MB', level=log_level, format=log_format, colorize=False, backtrace=True, diagnose=True)

注意事项：

• @logger.catch 装饰器应该用于装饰程序的入口函数（如 main()），或者任何你希望捕获未处理异常的函数。
• 如果函数内部已经使用了 try...except 块来处理异常，并且你不想让 @logger.catch 再次捕获这些异常，可以在 except 块中重新抛出异常（使用 raise 语句），或者不使用 @logger.catch 装饰器。
• 使用 @logger.catch 会略微增加程序的运行开销，因为它需要在函数调用时添加额外的异常处理逻辑。

总结

通过使用 Loguru 的 @logger.catch 装饰器，可以方便地捕获程序中未处理的异常，并将它们记录到日志文件中。这对于调试和问题排查非常有帮助，可以确保所有重要的信息，包括错误信息，都能被记录下来，方便后续分析。请确保正确配置 Loguru，以便将日志输出到文件，并根据需要选择性地使用 @logger.catch 装饰器。