1.在jupyter notebook中,可使用try…except块捕获异常,并通过traceback.format_exception格式化异常信息;2.使用ipython.excepthook定义全局异常处理函数custom_exception_handler,设置sys.excepthook实现未捕获异常的统一处理;3.通过ipython.display.html将异常信息渲染为html,实现高亮显示效果;4.利用traceback.extract_stack提取堆栈信息并限制输出层数,保留关键部分提升可读性;5.使用Logging模块配置日志记录,将异常信息写入文件以便后续分析。
在Jupyter Notebook中,定制异常的可视化输出格式,简单来说,就是让你看到的报错信息更清晰、更友好,而不是一堆难以理解的堆栈信息。
定制异常可视化输出,让调试更高效。
如何捕获和格式化异常?
在Jupyter Notebook里,最直接的方法就是使用try…except块。但仅仅捕获异常还不够,我们需要对异常信息进行格式化。可以自定义一个函数,专门用于格式化异常信息,然后在except块中调用它。
import traceback def format_exception(e): """格式化异常信息,使其更易读。""" exception_list = traceback.format_exception(None, e, e.__traceback__) exception_string = "".join(exception_list) return exception_string try: 1 / 0 except Exception as e: formatted_exception = format_exception(e) print(formatted_exception)
这段代码的核心在于traceback.format_exception,它能将异常信息转换为一个字符串列表,方便我们进行后续处理。当然,你也可以根据自己的需求,添加更多的格式化逻辑,比如高亮显示关键信息。
使用IPython.excepthook定制全局异常处理
如果想对所有未捕获的异常进行统一处理,可以使用IPython.excepthook。这允许你定义一个全局的异常处理函数,当程序出现未捕获的异常时,会自动调用该函数。
import sys from IPython.core import ultratb def custom_exception_handler(shell, etype, evalue, tb, tb_offset=None): """自定义全局异常处理函数。""" shell.showtraceback((etype, evalue, tb), tb_offset=tb_offset) # 默认行为 print("发生了一个错误!请检查你的代码。") import IPython IPython.get_ipython().pt_show_in_pager = False # 关闭分页 sys.excepthook = custom_exception_handler
这里,我们首先定义了一个custom_exception_handler函数,它接收异常类型、异常值、堆栈信息等参数。在这个函数里,你可以做任何你想做的事情,比如记录日志、发送邮件、或者显示更友好的错误提示。然后,我们将sys.excepthook设置为这个自定义函数,这样,所有的未捕获异常都会经过它的处理。关闭分页是为了防止在控制台输出过多信息。
如何在Jupyter Notebook中高亮显示异常信息?
仅仅是格式化异常信息还不够,如果能高亮显示关键信息,那就更好了。可以使用IPython.display模块来实现这一点。
from IPython.display import HTML, display def format_exception_html(e): """格式化异常信息为HTML,并高亮显示关键信息。""" exception_list = traceback.format_exception(None, e, e.__traceback__) exception_string = "".join(exception_list) # 使用HTML标记高亮显示 html = f"<pre style='color:red;'>{exception_string}
” return html try: 1 / 0 except Exception as e: html_exception = format_exception_html(e) display(HTML(html_exception))
这段代码将异常信息格式化为HTML,并使用红色高亮显示。IPython.display.HTML可以将HTML代码渲染到Jupyter Notebook中,从而实现高亮显示的效果。你可以根据自己的喜好,修改HTML样式,比如改变颜色、字体、背景等等。
如何在Jupyter Notebook中隐藏部分堆栈信息?
有时候,堆栈信息太长,我们只想看到最关键的部分。可以使用traceback模块的extract_stack函数来提取堆栈信息,并只显示最后几层。
import traceback def format_exception_short(e): """格式化异常信息,只显示最后几层堆栈信息。""" extracted_stack = traceback.extract_stack() # 只显示最后3层堆栈信息 formatted_stack = extracted_stack[-3:] formatted_lines = traceback.format_list(formatted_stack) exception_string = "".join(formatted_lines) + repr(e) return exception_string try: def inner_function(): raise ValueError("Something went wrong") def outer_function(): inner_function() outer_function() except Exception as e: formatted_exception = format_exception_short(e) print(formatted_exception)
这里,我们使用traceback.extract_stack提取堆栈信息,然后只保留最后3层。traceback.format_list将堆栈信息格式化为字符串列表,方便我们进行后续处理。
如何在Jupyter Notebook中记录异常日志?
除了显示异常信息,记录异常日志也是一个好习惯。可以使用logging模块来实现这一点。
import logging # 配置日志 logging.basicConfig(filename='error.log', level=logging.ERROR, format='%(asctime)s - %(levelname)s - %(message)s') try: 1 / 0 except Exception as e: logging.error(f"An error occurred: {e}") print("An error occurred. See error.log for details.")
这段代码将异常信息记录到error.log文件中。logging.basicConfig用于配置日志,可以设置日志文件名、日志级别、日志格式等等。logging.error用于记录错误信息。