python使用IPython偵錯debug程式

2022-05-14 13:01:31

在 Python 中程式設計時，我會花費大量時間使用 IPython 及其強大的互動式提示，不僅用於一些一次性計算，還用於大量實際程式設計和偵錯。我特別將它用於一些探索性的程式設計，比如對一些不熟悉的 API，或者想知道程式在程式碼中特定位置的執行狀態。

我不確定這種IPython偵錯的方法有多普遍，但我很少聽到其他人談論它，所以我認為它值得分享。

安裝

使用前，需要將 IPython 安裝到您當前的 virtualenv 中：

pip install ipython

使用方法

基本上有兩種方法可以開啟 IPython 提示符。

第一種是直接從終端執行它：

$ ipython
Python 3.9.5 (default, Jul  1 2021, 11:45:58)
Type 'copyright', 'credits' or 'license' for more information
IPython 8.3.0 -- An enhanced Interactive Python. Type '?' for help.
In [1]:

在 Django 專案中，如果您安裝了 IPython，也可以使用 ./manage.py shell，好處是它會為幫您正確初始化 Django。

如果您想探索編寫一些“頂級”程式碼，例如，在尚未建立入口點的情況下，編寫一個新的功能，那麼這種方法很管用。然而，我寫的大部分程式碼都不是這樣的。大多數時候，我發現自己需要寫程式碼時，已經想好10層的函數呼叫了——比如：

我正在一個Django應用程式中編寫一些檢視程式碼，其中有一個請求物件--如果你在IPython提示符下從頭開始，你不可能輕易重新建立這個物件。
或者，模型層程式碼，比如 save（） 方法內部的程式碼，該方法本身正在被您尚未編寫的其他程式碼呼叫，比如Django admin或某個訊號。
或者，在一個測試中，設定程式碼已經建立了一大堆在開啟IPython時不可用的東西。

對於這些情況，我使用第二種方法：

找到我想要修改、探索或偵錯的程式碼。這通常是我自己的程式碼，但也可能是第三方庫。我一直習慣在 virtualenv 中工作，所以即使使用第三方庫，在我的編輯器中“go to definition”也會直接將我帶到程式碼的可寫副本的定義區（除了不是用 Python 編寫的程式碼）。

插入 IPython 提示的程式碼並儲存檔案：

import IPython; IPython.embed()

我將此係結到編輯器中的一個功能鍵。
因此，如果它是Django檢視，那麼程式碼最終可能會是這樣：

def contact_us(request):
    if request.method == "POST":
        form = ContactUsForm_class(request.POST)
        if form.is_valid():
            import IPython; IPython.embed()
        # …

以適當的方式觸發程式碼。對於上述情況，首先需要在終端中執行 Django 伺服器，然後開啟網頁，填寫表單並按下提交。對於測試，它將從終端執行特定的測試。對於命令列應用程式，它將直接執行應用程式。

在終端中，我會發現自己現在已經在 IPython REPL 中，我可以繼續：

想出我需要寫什麼程式碼
或者偵錯我感到困惑的程式碼

請注意，您可以在此 REPL 中編寫和編輯多行程式碼——它不像編輯器那麼舒服，但沒關係，並且具有良好的歷史記錄支援。關於 IPython 及其更多特性，你可以在官方檔案中瞭解它。

對於那些有其他語言背景的人來說，可能還值得指出的是，Python REPL 與普通 Python 並沒有什麼不同。你可以在普通 Python 中做的所有事情，比如定義函數和類，都可以在 REPL 中進行。

偵錯結束後，我可以將任何有用的片段從 REPL 複製回我的真實程式碼中，使用歷史記錄來檢視我曾經輸入的內容。

優點

這種方法的優點是：

當您實際擁有一個物件時，您可以更輕鬆地探索API和物件(APIs and objects)，而不是閱讀關於物件的檔案，或者編輯器的自動完成工具推斷物件應該具有的內容。例如，Django的HttpRequest上有哪些屬性和方法？你不必確保你有正確的型別註釋，並且希望它們是完整的，或者假設值是什麼——你已經有了物件，你可以檢查它，用廣泛的合適的製表符自動補全完成。你可以呼叫函數，看看它們是怎麼做的。
例如，Django的請求物件通常有一個使用者(user)屬性，該屬性不屬於HttpRequest定義的一部分，因為它是在以後新增的。但它在REPL中是可見的。
您可以直接探索程式的整體狀態。這對於探索性程式設計和偵錯來說都是一個巨大的優勢。
對於偵錯，pdb 和類似的偵錯工具和環境通常會為您提供“the state of the system”，並且它們更擅長單步執行多層程式碼。但我經常發現 IPython 提示的功能和舒適性對於探索和尋找解決方案要好得多。

這種環境的感覺並不像Lisp中REPL驅動的程式設計那樣流暢，但我仍然覺得它非常有趣和高效。與許多其他方法相比，比如迭代程式碼，然後進行手動或自動測試，它將反饋迴圈的延遲從幾秒或幾分鐘減少到幾毫秒，這是巨大的效率提升。