本文旨在解决 python 中使用 loguru 库时，程序错误（exception）无法正常输出到日志文件，但能在终端正常显示的问题。我们将深入探讨 `sys.excepthook()` 的工作原理，并介绍如何使用 loguru 提供的 `@logger.catch` 装饰器来捕获和记录未处理的异常，确保所有错误信息都能被正确记录到日志文件中。
在使用 Loguru 进行日志记录时，有时会遇到一个令人困惑的问题：常规的日志信息可以同时输出到终端和日志文件，但当程序出现未处理的异常时，错误信息却只显示在终端，而没有被记录到日志文件中。 这通常是由于 Python 默认的异常处理机制与 Loguru 的日志记录机制之间的交互方式导致的。 ### 理解 Python 的默认异常处理 当 Python 程序遇到未被 `try...except` 块捕获的异常时，会触发默认的异常处理机制，即调用 `sys.excepthook()` 函数。 这个函数会将异常信息输出到 `sys.stderr`，通常情况下，`sys.stderr` 会被重定向到终端，因此我们能在终端看到错误信息。 然而，Loguru 默认情况下并不会自动捕获通过 `sys.excepthook()` 输出的错误信息。 它只负责记录程序中通过 `logger.debug()`, `logger.info()`, `logger.warning()`, `logger.error()`, `logger.critical()` 等方法显式记录的日志信息。 因此，未处理的异常信息不会被 Loguru 记录到日志文件中，导致了只在终端显示错误，日志文件却缺失错误信息的现象。 ### 使用 `@logger.catch` 捕获未处理的异常 Loguru 提供了一个方便的装饰器 `@logger.catch`，专门用于捕获未处理的异常并将其记录到配置的日志 sinks 中。 它的工作原理是在被装饰的函数外部包裹一个 `try...except` 块，当函数内部发生未处理的异常时，`except` 块会捕获该异常，并使用 Loguru 的 `logger.exception()` 方法记录异常信息。 以下是一个使用 `@logger.catch` 的示例： ```python from loguru import logger import sys logger.remove() # Remove default handler logger.add(sys.stdout, level="INFO") # Add stdout handler logger.add("error.log", level="ERROR") # Add file handler def divide(): return 1 / 0 # This will cause a ZeroDivisionError @logger.catch def main(): divide() if __name__ == "__main__": main()在这个例子中，@logger.catch 装饰器被应用到了 main() 函数上。当 divide() 函数抛出 ZeroDivisionError 异常时，@logger.catch 会捕获这个异常，并将其记录到所有配置的 sinks 中，包括终端（sys.stdout）和日志文件（error.log）。
运行这段代码后，你将在终端看到错误信息，同时 error.log 文件中也会包含完整的异常堆栈信息，从而实现了将所有错误信息都记录到日志文件的目的。
配置 Loguru 的 sinks
确保 Loguru 配置了正确的 sinks，以便将日志信息输出到所需的位置。 在上面的例子中，我们使用了以下配置：
- logger.add(sys.stdout, level="INFO"): 将 INFO 级别及以上的日志信息输出到标准输出（终端）。
- logger.add("error.log", level="ERROR"): 将 ERROR 级别及以上的日志信息输出到名为 "error.log" 的文件中。
你可以根据自己的需求配置不同的 sinks，例如：
立即学习“Python免费学习笔记（深入）”；
- 输出到不同的文件，并设置不同的日志级别。
- 使用不同的日志格式。
- 使用不同的 rotation 策略（例如按文件大小或时间分割日志文件）。
注意事项
- @logger.catch 装饰器应该被应用到程序的主函数或任何可能抛出未处理异常的函数上。
- 确保 Loguru 配置了正确的 sinks，以便将日志信息输出到所需的位置。
- @logger.catch 只能捕获未处理的异常。如果异常已经被 try...except 块捕获并处理，@logger.catch 将不会起作用。
- 在生产环境中，建议配置更完善的日志记录策略，例如设置日志级别、日志格式、rotation 策略等，以便更好地管理和分析日志信息。
总结
通过使用 Loguru 提供的 @logger.catch 装饰器，我们可以方便地捕获未处理的异常，并将其记录到配置的日志 sinks 中，从而确保所有错误信息都能被正确记录到日志文件中。 这对于调试和排查问题非常有帮助，尤其是在生产环境中。 理解 Python 的默认异常处理机制以及 Loguru 的日志记录机制，可以帮助我们更好地使用 Loguru 来管理应用程序的日志信息。
