Python中，如何使用 IPython 調試(debug)程式

關於IPython使用的入門文章，主要介紹瞭如何在程式代碼中嵌入ipython用於調試，並分析了優點與不足。

在 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 複製回我的真實代碼中，使用歷史記錄來查看我曾經輸入的內容。

優點

這種方法的優點是：

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

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

提示和不足

• IPython 有很多很酷的特性可以在 REPL 環境中幫助你，比如 %autoreload 和許多其他很酷的魔法。你應該花時間去瞭解他們！
• 在多線程（或多進程）環境中，IPython 提示表現不是很好。如果可能的話，關閉多線程，或者確保你沒有遇到那個問題。
• 如果您確實在終端中搞砸了，您可能需要手動找到要殺死的進程併在終端中進行重置。
• 使用 Django 開發伺服器：
  • 它預設是多線程的，所以要麼確保你不會多次點擊視圖代碼，要麼使用 --nothreading。
  • 當心自動重新載入，如果你在啟動時仍然處於 IPython 提示符中，它會搞砸你。要麼使用 --noreload 要麼確保在執行任何會觸發重新載入的操作之前乾凈地退出 IPython。
• 當心捕獲標準輸入/輸出的環境，這會破壞這種功能。
• pytest 預設捕獲標準輸入並破壞一些事物。您可以使用 -s 將其關閉。此外，如果您使用的是 pytest-xdist，您應該記得使用 -n0 來關閉多個進程。
• 使用 IPython.embed() 時，由於 Python 的限制，存在一個煩人的錯誤，涉及閉包和未定義的名稱。它經常在使用生成器表達式時出現，但在其他時候也是如此。它通常可以通過以下方式解決：

globals().update(locals())

參考鏈接

• REPL Python programming and debugging with IPython