第python使用IPython調(diào)試debug程序目錄安裝使用方法優(yōu)點提示和不足參考鏈接關(guān)于IPython使用的入門文章，主要介紹了如何在程序代碼中嵌入ipython用于調(diào)試，并分析了優(yōu)點與不足。

在Python中編程時，我會花費大量時間使用IPython及其強大的交互式提示，不僅用于一些一次性計算，還用于大量實際編程和調(diào)試。我特別將它用于一些探索性的編程，比如對一些不熟悉的API，或者想知道程序在代碼中特定位置的運行狀態(tài)。

我不確定這種IPython調(diào)試的方法有多普遍，但我很少聽到其他人談論它，所以我認為它值得分享。

安裝

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

pipinstallipython

使用方法

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

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

$ipython

Python3.9.5(default,Jul12025,11:45:58)

Type'copyright','credits'or'license'formoreinformation

IPython8.3.0--AnenhancedInteractivePython.Type''forhelp.

In[1]:

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

如果您想探索編寫一些頂級代碼，例如，在尚未創(chuàng)建入口點的情況下，編寫一個新的功能，那么這種方法很管用。然而，我寫的大部分代碼都不是這樣的。大多數(shù)時候，我發(fā)現(xiàn)自己需要寫代碼時，已經(jīng)想好10層的函數(shù)調(diào)用了比如：

我正在一個Django應用程序中編寫一些視圖代碼，其中有一個請求對象--如果你在IPython提示符下從頭開始，你不可能輕易重新創(chuàng)建這個對象?；蛘?，模型層代碼，比如save（）方法內(nèi)部的代碼，該方法本身正在被您尚未編寫的其他代碼調(diào)用，比如Djangoadmin或某個信號?；蛘?，在一個測試中，設(shè)置代碼已經(jīng)創(chuàng)建了一大堆在打開IPython時不可用的東西。

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

找到我想要修改、探索或調(diào)試的代碼。這通常是我自己的代碼，但也可能是第三方庫。我一直習慣在virtualenv中工作，所以即使使用第三方庫，在我的編輯器中g(shù)otodefinition也會直接將我?guī)У酱a的可寫副本的定義區(qū)（除了不是用Python編寫的代碼）。

插入IPython提示的代碼并保存文件：

importIPython;IPython.embed()

我將此綁定到編輯器中的一個功能鍵。

因此，如果它是Django視圖，那么代碼最終可能會是這樣：

defcontact_us(request):

ifrequest.method=="POST":

form=ContactUsForm_class(request.POST)

ifform.is_valid():

importIPython;IPython.embed()

以適當?shù)姆绞接|發(fā)代碼。對于上述情況，首先需要在終端中運行Django服務器，然后打開網(wǎng)頁，填寫表單并按下提交。對于測試，它將從終端運行特定的測試。對于命令行應用程序，它將直接運行應用程序。

在終端中，我會發(fā)現(xiàn)自己現(xiàn)在已經(jīng)在IPythonREPL中，我可以繼續(xù)：

想出我需要寫什么代碼或者調(diào)試我感到困惑的代碼

請注意，您可以在此REPL中編寫和編輯多行代碼它不像編輯器那么舒服，但沒關(guān)系，并且具有良好的歷史記錄支持。關(guān)于IPython及其更多特性，你可以在官方文檔中了解它。

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

調(diào)試結(jié)束后，我可以將任何有用的片段從REPL復制回我的真實代碼中，使用歷史記錄來查看我曾經(jīng)輸入的內(nèi)容。

優(yōu)點

這種方法的優(yōu)點是：

當您實際擁有一個對象時，您可以更輕松地探索API和對象(APIsandobjects)，而不是閱讀關(guān)于對象的文檔，或者編輯器的自動完成工具推斷對象應該具有的內(nèi)容。例如，Django的HttpRequest上有哪些屬性和方法？你不必確保你有正確的類型注釋，并且希望它們是完整的，或者假設(shè)值是什么你已經(jīng)有了對象，你可以檢查它，用廣泛的合適的制表符自動補全完成。你可以調(diào)用函數(shù)，看看它們是怎么做的。

例如，Django的請求對象通常有一個用戶(user)屬性，該屬性不屬于HttpRequest定義的一部分，因為它是在以后添加的。但它在REPL中是可見的。您可以直接探索程序的整體狀態(tài)。這對于探索性編程和調(diào)試來說都是一個巨大的優(yōu)勢。

對于調(diào)試，pdb和類似的調(diào)試工具和環(huán)境通常會為您提供thestateofthesystem，并且它們更擅長單步執(zhí)行多層代碼。但我經(jīng)常發(fā)現(xiàn)IPython提示的功能和舒適性對于探索和尋找解決方案要好得多。

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

提示和不足

IPython有很多很酷的特性可以在REPL環(huán)境中幫助你，比如%autoreload和許多其他很酷的魔法。你應該花時間去了解他們！

在多線程（或多進程）環(huán)境中，IPython提示表現(xiàn)不是很好。如果可能的話，關(guān)閉多線程，或者確保你沒有遇到那個問題。

如果您確實在終端中搞砸了，您可能需要手動找到要殺死的進程并在終端中進行重置。

使用Django開發(fā)服務器：

它默認是多線程的，所以要么確保你不會多次點擊視圖代碼，要么使用--nothreading。當心自動重新加載，如果你在啟動時仍然處于IPython提示符中，它會搞砸你。要么使用--noreload要么確保在執(zhí)行任何會觸發(fā)重新加載的操作之前干凈地退出IPython。

當心捕獲標準輸入/輸出的環(huán)境，這會破壞這種功能。

pytest默認捕獲標準輸入并破壞一些事物。您可以使用-s將其關(guān)閉。此外，如果您使用的是pytest-xdist，您應該記得使用-n0來關(guān)閉多個進程。

使用IPython.embed()時，由于Python的限制，存在一個煩人的錯誤，涉及閉包和未定義的名稱。它經(jīng)常在使用生成器表達式時出現(xiàn)，但在其他時候也是如此。它通?？梢酝ㄟ^以下方式解決：