0

0

使用 Loguru 捕获并记录 Python 异常到日志文件

碧海醫心

碧海醫心

发布时间:2025-10-19 16:19:00

|

979人浏览过

|

来源于php中文网

原创

 使用 Loguru 捕获并记录 Python 异常到日志文件

本文旨在解决在使用 loguru 进行日志记录时,python 异常信息仅输出到终端,而未记录到日志文件的问题。通过分析异常处理机制,解释了 loguru 无法自动捕获未处理异常的原因,并介绍了使用 @logger.catch 装饰器来捕获并记录这些异常的方法,确保所有错误信息都能被完整地记录到日志文件中,方便问题排查和系统监控。

在使用 Loguru 进行 Python 日志记录时,你可能会遇到一个问题:常规的日志信息(如 `logger.info()` 或 `logger.debug()` 输出的内容)能够同时输出到终端和日志文件,但 Python 运行时产生的未捕获的异常(Exceptions)却只显示在终端,而不会写入日志文件。这使得在排查问题时,无法从日志文件中获取完整的错误信息。 **问题分析:Python 异常处理机制** 要理解这个问题,需要了解 Python 的异常处理机制。当 Python 代码中出现异常,且没有使用 `try...except` 语句进行捕获时,该异常会被 Python 解释器的默认异常处理钩子 `sys.excepthook()` 捕获。这个钩子会将异常信息输出到标准错误输出 `sys.stderr`,然后程序终止。 Loguru 默认情况下只记录通过 `logger` 对象显式输出的信息,并不会自动捕获 `sys.stderr` 中的内容。因此,未被 `try...except` 捕获的异常信息,虽然会在终端显示(因为终端通常会显示 `sys.stdout` 和 `sys.stderr` 的内容),但不会被 Loguru 记录到日志文件中。 **解决方案:使用 `@logger.catch` 装饰器** Loguru 提供了一个方便的装饰器 `@logger.catch`,用于捕获未处理的异常并将其记录到所有配置的日志接收器(sinks)中。 `@logger.catch` 实际上是在被装饰的函数外部包裹了一个 `try...except` 块。当函数内部发生未捕获的异常时,`except` 块会捕获该异常,并使用 `logger.exception()` 方法将异常信息记录到日志中。 **使用示例:** ```python from loguru import logger def divide(): try: result = 1 / 0 # 模拟除零错误 return result except Exception as e: logger.error(f"除法运算发生错误: {e}") return None @logger.catch def main(): result = divide() if result is not None: logger.info(f"结果: {result}") else: logger.warning("divide函数返回了None") if __name__ == "__main__": logger.add("error.log", rotation="500 MB", level="DEBUG") # 配置日志文件 main()

在这个例子中,@logger.catch 装饰器装饰了 main() 函数。如果 main() 函数内部(包括它调用的 divide() 函数)发生任何未捕获的异常,@logger.catch 就会捕获该异常,并将其记录到配置的日志文件 "error.log" 中。

运行结果分析

运行上述代码后,如果 error.log 文件不存在,则会被创建。该文件内容类似如下:

2024-01-01 10:00:00.000000 | ERROR    | __main__::15 - 除法运算发生错误: division by zero
2024-01-01 10:00:00.000000 | ERROR    | __main__:main:11 - An exception was caught!
Traceback (most recent call last):
  File "test.py", line 11, in main
    result = divide()
  File "test.py", line 5, in divide
    result = 1 / 0  # 模拟除零错误
ZeroDivisionError: division by zero

可以看到,error.log 文件中不仅记录了我们使用 logger.error() 显式记录的错误信息,还记录了完整的异常堆信息,这对于调试和问题排查非常有帮助。

立即学习Python免费学习笔记(深入)”;

Beautiful.ai
Beautiful.ai

AI在线创建幻灯片

下载

最佳实践:

  1. 装饰 main() 函数: 通常,建议将 @logger.catch 装饰器应用于程序的入口函数,例如 main() 函数,以确保捕获所有未处理的异常。
  2. 细粒度控制: 对于某些特定的函数,如果希望更精细地控制异常处理,可以使用 try...except 块,并在 except 块中使用 logger.exception() 记录异常信息。logger.exception() 会自动记录异常信息和堆栈跟踪,相当于 logger.error(e, exc_info=True)。
  3. 配合 try...except 使用: 即使使用了 @logger.catch,也建议在适当的地方使用 try...except 块来处理可预见的异常,并进行相应的处理或恢复。这有助于提高程序的健壮性和用户体验。
  4. 配置多个 sinks: 可以配置多个 sinks,例如同时输出到终端和文件,以便在开发和生产环境中都能方便地查看日志信息。

总结:

通过使用 Loguru 的 @logger.catch 装饰器,可以方便地捕获并记录 Python 程序中未处理的异常,从而确保所有错误信息都能被完整地记录到日志文件中。这对于调试、问题排查和系统监控至关重要。在实际应用中,应根据具体情况,灵活运用 @logger.catch 和 try...except 块,以实现最佳的异常处理效果。

					

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

774

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

684

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

767

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

719

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1425

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

571

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

579

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

751

2023.08.11

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

45

2026.01.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 18.9万人学习

Django 教程
Django 教程

共28课时 | 3.5万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号