지식을 늘려보세요! Python의 예외 정보는 다음과 같이 표시될 수도 있습니다.

소개

일상 개발에서 대부분의 시간은 역추적 모듈 정보를 읽고 코드를 디버깅하는 데 소비됩니다. 이 글에서는 프롬프트 정보를 더욱 간결하고 정확하게 만들기 위해 역추적 모듈을 개선하겠습니다.

이러한 목적에 따라 우리는 예외 처리 후크(Exception Hooks)를 사용자 정의하여 트레이스백에서 중복된 정보를 제거하고 오류 해결에 필요한 내용만 남겨둘 것입니다. 또한 몇 가지 유용한 타사 라이브러리도 소개할 예정이며, 해당 라이브러리에 포함된 예외 후크를 직접 사용하여 역추적 모듈을 단순화할 수 있습니다.

예외 후크

프로그램의 예외 정보가 try/catch에 의해 캡처되지 않으면 Python 인터프리터는 sys.Exceptionhook() 함수를 호출하여 유형, 값, 역추적이라는 3개의 매개변수를 받습니다. 이 함수는 Exception Hook이라고도 하며 프로그램의 예외 정보를 출력합니다.

다음 예를 살펴보겠습니다.

import sys
def exception_hook(exc_type, exc_value, tb):
 print('Traceback:')
 filename = tb.tb_frame.f_code.co_filename
 name = tb.tb_frame.f_code.co_name
 line_no = tb.tb_lineno
 print(f"File {filename} line {line_no}, in {name}")
 # Exception type 和 value
 print(f"{exc_type.__name__}, Message: {exc_value}")
sys.excepthook = exception_hook

이 예에서는 트레이스백(tb) 객체에서 예외 정보가 나타나는 위치를 얻을 수 있습니다. 위치 정보에는 파일 이름(f_code.co_filename), 함수/ 모듈 이름(f_code.co_name), 라인 번호(tb_lineno). 또한, 예외 정보의 내용을 얻기 위해 exc_type 및 ex_value 변수를 사용할 수 있습니다.

오류를 생성하는 함수를 호출하면 예외_후크는 다음 내용을 출력합니다.

def do_stuff():
 # 写一段会产生异常的代码
 raise ValueError("Some error message")
do_stuff()
# Traceback:
# File /home/some/path/exception_hooks.py line 22, in <module>
# ValueError, Message: Some error message

위의 예는 예외 정보의 일부를 제공하지만 코드를 디버깅하는 데 필요한 모든 정보를 얻고 언제, 언제인지 알 수 있습니다. 예외 발생 위치, 우리는 또한 트레이스백 객체를 조사해야 합니다:

def exception_hook(exc_type, exc_value, tb):
 local_vars = {}
 while tb:
 filename = tb.tb_frame.f_code.co_filename
 name = tb.tb_frame.f_code.co_name
 line_no = tb.tb_lineno
 print(f"File {filename} line {line_no}, in {name}")
 local_vars = tb.tb_frame.f_locals
 tb = tb.tb_next
 print(f"Local variables in top frame: {local_vars}")
...
# File /home/some/path/exception_hooks.py line 41, in <module>
# File /home/some/path/exception_hooks.py line 7, in do_stuff
# Local variables in top frame: {'some_var': 'data'}

위의 예에서 볼 수 있듯이, 트레이스백 객체(tb)는 본질적으로 연결된 목록입니다 - 발생하는 모든 예외를 저장합니다. 따라서 tb_next를 사용하여 tb를 순회하고 각 예외에 대한 정보를 인쇄할 수 있습니다. 이를 바탕으로 tb_frame.f_locals 속성을 사용하여 콘솔에 변수를 출력할 수도 있으며, 이는 코드 디버깅에 도움이 됩니다.

추적 개체를 사용하여 예외 정보를 출력하는 것이 가능하지만 출력 정보를 읽기가 더 어렵습니다. 보다 편리한 접근 방식은 예외 정보를 추출하기 위한 많은 보조 기능이 내장된 역추적 모듈을 사용하는 것입니다.

이제 예외 후크에 대한 기본 지식을 소개했습니다. 다음으로 예외 후크를 사용자 정의하고 몇 가지 실용적인 기능을 추가할 수 있습니다.

사용자 정의 예외 후크

1. 예외 정보를 파일에 자동으로 저장하고 나중에 코드를 디버깅할 때 볼 수도 있습니다.

LOG_FILE_PATH = "./some.log"
FILE = open(LOG_FILE_PATH, mode="w")
def exception_hook(exc_type, exc_value, tb):
 FILE.write("*** Exception: ***n")
 traceback.print_exc(file=FILE)
 FILE.write("n*** Traceback: ***n")
 traceback.print_tb(tb, file=FILE)
# *** Exception: ***
# NoneType: None
#
# *** Traceback: ***
# File "/home/some/path/exception_hooks.py", line 82, in <module>
# do_stuff()
# File "/home/some/path/exception_hooks.py", line 7, in do_stuff
# raise ValueError("Some error message")

2. 예외 정보는 기본적으로 stderr에 저장됩니다. 저장 위치에서 다음을 수행할 수 있습니다:

import logging
logging.basicConfig(
 level=logging.CRITICAL,
 format='[%(asctime)s] {%(pathname)s:%(lineno)d} %(levelname)s - %(message)s',
 datefmt='%H:%M:%S',
 stream=sys.stdout
)
def exception_hook(exc_type, exc_value, exc_traceback):
 logging.critical("Uncaught exception:", exc_info=(exc_type, exc_value, exc_traceback))
# [17:28:33] {/home/some/path/exception_hooks.py:117} CRITICAL - Uncaught exception:
# Traceback (most recent call last):
# File "/home/some/path/exception_hooks.py", line 122, in <module>
# do_stuff()
# File "/home/some/path/exception_hooks.py", line 7, in do_stuff
# raise ValueError("Some error message")
# ValueError: Some error message

3. 프롬프트 메시지의 특정 부분에 대한 색상을 설정할 수도 있습니다.

# pip install colorama
from colorama import init, Fore
init(autoreset=True)# Reset the color after every print
def exception_hook(exc_type, exc_value, tb):
 local_vars = {}
 while tb:
 filename = tb.tb_frame.f_code.co_filename
 name = tb.tb_frame.f_code.co_name
 line_no = tb.tb_lineno
 # Prepend desired color (e.g. RED) to line
 print(f"{Fore.RED}File {filename} line {line_no}, in {name}")
 local_vars = tb.tb_frame.f_locals
 tb = tb.tb_next
 print(f"{Fore.GREEN}Local variables in top frame: {local_vars}")

위에 소개된 예 외에도 각 프레임의 로컬 변수를 출력할 수도 있습니다. , 또는 에서 참조하는 변수가 예외가 발생하는 줄을 찾습니다. 이러한 예외 후크는 사용자 정의 예외 후크에 비해 이미 매우 성숙되어 있으므로 다른 개발자의 소스 코드를 읽고 그들의 디자인 아이디어를 배우는 것이 좋습니다.

• 각 프레임의 로컬 변수 출력 [1]
• 예외가 발생한 줄에서 참조되는 변수 찾기 [2]
  

타사 라이브러리의 Exception Hooks

Exception Hook을 사용자 정의하는 것은 매우 흥미롭지만 많은 타사 라이브러리가 이미 이 기능을 구현했습니다. 바퀴를 재발명하는 대신 다른 훌륭한 도구를 살펴보세요.

1. 우선 개인적으로 가장 좋아하는 것은 Rich인데, pip로 직접 설치한 다음 가져와서 사용할 수 있습니다. 한 가지 예에서만 사용하고 싶다면 다음과 같이 할 수 있습니다: python -m rich.traceback

# https://rich.readthedocs.io/en/latest/traceback.html
# pip install rich
# python -m rich.traceback
from rich.traceback import install
install(show_locals=True)
do_stuff()# Raises ValueError

2. better_Exceptions도 매우 인기가 있으므로 환경 변수 BETTER_EXCEPTIONS=1을 먼저 설정해야 합니다. 그런 다음 pip로 설치하세요. 또한 TERM 변수가 xterm이 아닌 경우 SUPPORTS_COLOR를 True로 설정하십시오.

# https://github.com/Qix-/better-exceptions
# pip install better_exceptions
# export BETTER_EXCEPTIONS=1
import better_exceptions
better_exceptions.MAX_LENGTH = None
# 检查你的 TERM 变量是否被设置为 `xterm`, 如果没有执行以下操作
# See issue: https://github.com/Qix-/better-exceptions/issues/8
better_exceptions.SUPPORTS_COLOR = True
better_exceptions.hook()
do_stuff()# Raises ValueError

3. 사용하기 가장 편리한 라이브러리는 Pretty_errors입니다. 그냥 가져오세요.

# https://github.com/onelivesleft/PrettyErrors/
# pip install pretty_errors
import pretty_errors
# 如果你对默认配置满意的话，则无需修改
pretty_errors.configure(
 filename_display= pretty_errors.FILENAME_EXTENDED,
 line_number_first = True,
 display_link= True,
 line_color= pretty_errors.RED + '> ' + pretty_errors.default_config.line_color,
 code_color= '' + pretty_errors.default_config.line_color,
 truncate_code = True,
 display_locals= True
)
do_stuff()

직접 가져오기 외에도 위 코드는 이 라이브러리의 일부 선택적 구성도 보여줍니다. 더 많은 구성은 여기에서 볼 수 있습니다: 구성 [3]

4. IPython의 ultratb 모듈

# https://ipython.readthedocs.io/en/stable/api/generated/IPython.core.ultratb.html
# pip install ipython
import IPython.core.ultratb
# Also ColorTB, FormattedTB, ListTB, SyntaxTB
sys.excepthook = IPython.core.ultratb.VerboseTB(color_scheme='Linux')# Other colors: NoColor, LightBG, Neutral
do_stuff()

5. stackprinter库

# https://github.com/cknd/stackprinter
# pip install stackprinter
import stackprinter
stackprinter.set_excepthook(style='darkbg2')
do_stuff()

结论

本文我们学习了如何自定义Exception Hooks,但我更推荐使用第三方库。你可以在本文介绍的第三方库中任选一个喜欢的，用到项目中。需要注意的是使用自定义Exception Hooks可能会丢失某些关键信息，例如：本文中的某些例子中，输出中缺少文件路径，在远程调试代码这无疑很不方便，因此，需要谨慎使用。

위 내용은 지식을 늘려보세요! Python의 예외 정보는 다음과 같이 표시될 수도 있습니다.의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!