Python實現自定義異常堆疊資訊的範例程式碼

2022-07-19 14:01:29

當我們的程式報錯時，直譯器會將整個異常的堆疊資訊全部輸出出來，舉個例子：

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]程式出現異常啦, 客官請看下面:nn")
    # 遍歷
    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()}nn")
        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。而一旦呼叫結束，整個程式就結束了。

以上就是Python實現自定義異常堆疊資訊的範例程式碼的詳細內容，更多關於Python異常堆疊資訊的資料請關注it145.com其它相關文章！

Python實現自定義異常堆疊資訊的範例程式碼

熱門文章