日本免费高清视频-国产福利视频导航-黄色在线播放国产-天天操天天操天天操天天操|www.shdianci.com

學無先后,達者為師

網站首頁 編程語言 正文

Python實現自定義異常堆棧信息的示例代碼_python

作者:古明地覺 ? 更新時間: 2022-09-10 編程語言

當我們的程序報錯時,解釋器會將整個異常的堆棧信息全部輸出出來,舉個例子:

def?foo():
????raise?RuntimeError("拋一個異常")

def?bar():
????foo()

def?main():
????bar()

main()

如果執行這段代碼,會得到以下報錯信息:

解釋器會將異常產生的整個調用鏈都給打印出來,那么問題來了,我們能不能自定義這些報錯信息呢?

答案是可以的,我們只要拿到這些報錯信息,然后再進行修改即可。那么如何才能拿到呢?顯然需要借助于 traceback 對象。

import?sys

def?foo():
????raise?RuntimeError("拋一個異常")

def?bar():
????foo()

def?main():
????bar()

try:
????main()
except?Exception:
????#?sys.exc_info()?返回一個元組,里面有三個元素
????#?分別是:異常類型、異常值、異常的堆棧信息
????exc_type,?exc_val,?exc_tb?=?sys.exc_info()

????print(exc_type)
????print(exc_val,?type(exc_val))
????print(exc_tb)
????"""
????<class?'RuntimeError'>
????拋一個異常?<class?'RuntimeError'>
????<traceback?object?at?0x7fe35811de40>
????"""

每一個函數在運行時都會創建一個棧幀,棧幀在 CPython 里面由 PyFrameObject 結構體表示。同時每個棧幀都會對應一個 PyTracebackObject,也就是異常堆棧,即代碼中的 exc_tb。

上面的代碼在執行函數 foo 的時候出現了異常,那么解釋器會創建對應的 traceback 對象,由于 foo 內部沒有異常捕獲,因此會回退到上一級棧幀,繼續尋找異常捕獲邏輯。而 foo 的上一級棧幀是 bar 的棧幀,因此解釋器同樣會基于 bar 的棧幀創建 traceback 對象,并且 bar 的 traceback 對象的 tb_next 指向 foo 的 traceback 對象。

就這樣棧幀一層層的回退,整個過程我們稱之為棧幀展開。在棧幀展開的過程中,解釋器不斷地創建與各個棧幀對應的 traceback,并將其鏈接成鏈表。

如果回退到最外層(模塊)也沒有找到異常捕獲邏輯,那么解釋器就要輸出異常信息了,從模塊對應的 traceback 開始不斷遍歷,將每一層信息都輸出出來,就是我們看到的樣子。

而我們也可以在拿到 traceback 之后,手動輸出出來。

import?sys
import?traceback

def?foo():
????raise?RuntimeError("拋一個異常")

def?bar():
????foo()

def?main():
????bar()

try:
????main()
except?Exception:
????exc_type,?exc_val,?exc_tb?=?sys.exc_info()

????error_msg?=?"".join(
????????traceback.format_exception(
????????????exc_type,?exc_val,?exc_tb)
????)
????print(error_msg)
????"""
????Traceback?(most?recent?call?last):
??????File?"/Users/satori/Desktop/project/main.py",?line?14,?in?<module>
????????main()
??????File?"/Users/satori/Desktop/project/main.py",?line?11,?in?main
????????bar()
??????File?"/Users/satori/Desktop/project/main.py",?line?8,?in?bar
????????foo()
??????File?"/Users/satori/Desktop/project/main.py",?line?5,?in?foo
????????raise?RuntimeError("拋一個異常")
????RuntimeError:?拋一個異常
????"""

Python 有一個標準模塊也叫?traceback,使用它的?format_exception 函數,我們可以拿到格式化后的異常堆棧信息,而該函數接收的參數正是 exc_type, exc_val, exc_tb。

雖然我們拿到了異常的堆棧信息,但是還不夠,因為這里是通過手動捕獲異常的方式。而在生產上,很多時候我們并不知道哪里會拋出異常,所以我們需要在不使用異常捕獲邏輯的前提下,自動捕獲異常。是不是有點繞了呢?我們舉個例子。

import?sys

def?catch(exc_type,?exc_val,?exc_tb):
????"""
????光看名字,就應該知道這三個參數的含義了
????"""
????print("報錯啦")
????print(exc_val)

#?之后當出現異常的時候,如果沒有異常捕獲邏輯
#?就會執行?catch?函數
sys.excepthook?=?catch

raise?ZeroDivisionError("除零錯誤")
"""
報錯啦
除零錯誤
"""

代碼中我們 raise 了一個異常,默認情況下解釋器應該將異常輸出到 stderr 當中,然后中止運行。但是我們替換了 sys.excepthook,那么在出現異常的時候,解釋器會去執行我們這里替換之后的 catch 函數,并自動將 exc_type, exc_val, exc_tb 作為參數傳進去。

而一旦 cache 函數執行完畢,程序就結束了。

那么接下來我們就可以對異常輸出進行改造了,至于怎么改,完全由你來決定,我們這里給個示例。

import?sys
from?io?import?StringIO
import?re
import?traceback
from?rich?import?print

def?catch(exc_type,?exc_val,?exc_tb):
????buf?=?StringIO()
????#?得到一個列表
????errors?=?traceback.format_exception(
????????exc_type,?exc_val,?exc_tb)
????buf.write(f"[blue]程序出現異常啦,?客官請看下面:\n\n")
????#?遍歷
????i?=?1
????while?i?<?len(errors):
????????match?=?re.search(r'File?"(.+?)",?line?(\d+),?in?(.+)\s*(.*)',
??????????????????????????errors[i].strip())
????????if?match?is?not?None:
????????????file_path,?lineno,?where,?reason?=?match.groups()
????????????buf.write(
????????????????f"在文件?[red?bold]{file_path}[/red?bold]?"
????????????????f"[green?bold]{where}[/green?bold]?的"
????????????????f"第?[yellow?bold]{lineno}[/yellow?bold]?行\n"
????????????)
????????????buf.write(f"執行了?{reason.strip()}\n\n")
????????i?+=?1
????buf.write(f"[cyan?bold]{errors[-1].strip()}")
????print(buf.getvalue())

sys.excepthook?=?catch

def?foo():
????#?raise?a?exception
????{}?+?()

def?bar():
????foo()

def?main():
????bar()

main()

我們執行這段代碼,看看它的錯誤輸出是什么樣子。

怎么樣,是不是很好玩呢?只要把?sys.excepthook?= cache?這段邏輯加載到程序中,我們就可以自定義異常顯示信息了。

當然啦,根據異常的不同,解釋器可能輸出更復雜的信息,所以我們上面的代碼并不完善,但你可以根據實際情況進行修改。只要知道如何獲取解釋器輸出的異常信息,以及 sys.excepthook 的用法就足夠了。

最后再強調一下,解釋器在發現異常的時候,會立即調用 sys.excepthook。而一旦調用結束,整個程序就結束了。

原文鏈接:https://mp.weixin.qq.com/s/9cF3K23xKYSH1A2HaH_7bQ

欄目分類
最近更新