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

来源:https://www.cnblogs.com/jiaoran/archive/2022/05/08/16245921.html
-Advertisement-
Play Games

介紹瞭如何在程式代碼中嵌入IPython用於調試,並分析了優點與不足 ...


關於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())

參考鏈接


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • # JavaScript經典案例練習 P1:支付10秒倒計時 效果: 功能: 點擊立即支付彈出確認款 確認付款後跳轉到支付成功頁面並開始計時 計時結束或者點擊立即返回按鈕返迴首頁 知識點: window.confirm() 用於顯示一個帶有指定消息和確認及取消按鈕的對話框,如果訪問者點擊‘確認’, ...
  • ${}字元串可以用於字元串拼接,一般用於模糊查詢中(因為有sql註入的風險,很少用) ...
  • 在開發過程中,不知道有沒有這樣的經歷,項目實際讀取的配置信息有時候總是與預期不符,今天就來研究下 SpringBoot 讀取配置文件順序。 一、SpringBoot 配置文件載入優先順序 SpringBoot官方文檔說明瞭載入的順序如下,越靠前優先順序越高。 Spring Boot uses a ver ...
  • 前言 嗨嘍!大家好呀 第三方模塊: requests >>> pip install requests 模塊安裝問題: 如果安裝python第三方模塊: win + R 輸入 cmd 點擊確定, 輸入安裝命令 pip install 模塊名 (pip install requests) 回車 在py ...
  • 一、Matplotlib 博文來源:https://www.runoob.com/matplotlib/matplotlib-tutorial.html Matplotlib 是 Python 的繪圖庫,它能讓使用者很輕鬆地將數據圖形化,並且提供多樣化的輸出格式。 Matplotlib 可以用來繪製 ...
  • 在系統開發的過程中,必然存在耗時極高的動作,是基於請求響應模式無法解決的問題,通常會採用解耦的思維,並基於非同步或者事件驅動的方式去調度整個流程的完整執行。 ...
  • 一個工作了2年的粉絲,私信了一個比較簡單的問題。 說: “Spring中事務的傳播行為有哪些?” 他說他能記得一些,但是在項目中基本上不需要配置,所以一下就忘記了。 結果導致面試被拒絕,有點遺憾! ok,關於這個問題,看看普通人和高手的回答。 普通人: 嗯。。。。。。。。 高手: 對於這個問題,需要 ...
  • 函數的定義和使用 def test(x): # x代表形參 ''' 2*x+1 :param x:整形數字 :return:返回計算結果 ''' y = 2*x+1 return y p = test(3) # test()表示運行名為test函數,3代表實參,給x進行賦值 print(p) 函數的 ...
一周排行
    -Advertisement-
    Play Games
  • 一:背景 準備開個系列來聊一下 PerfView 這款工具,熟悉我的朋友都知道我喜歡用 WinDbg,這東西雖然很牛,但也不是萬能的,也有一些場景他解決不了或者很難解決,這時候藉助一些其他的工具來輔助,是一個很不錯的主意。 很多朋友喜歡在項目中以記錄日誌的方式來監控項目的流轉情況,其實 CoreCL ...
  • 本來閑來無事,準備看看Dapper擴展的源碼學習學習其中的編程思想,同時整理一下自己代碼的單元測試,為以後的進一步改進打下基礎。 突然就發現問題了,源碼也不看了,開始改代碼,改了好久。 測試Dapper.LiteSql數據批量插入的時候,耗時20秒,感覺不正常,於是我測試了非Dapper版的Lite ...
  • 需求如下,在DEV框架項目中,需要在表格中增加一列顯示圖片,並且能編輯該列圖片,然後進行保存等操作,最終效果如下 這裡使用的是PictureEdit控制項來實現,打開DEV GridControl設計器,在ColumnEdit選擇PictureEdit: 綁定圖片代碼如下: DataTable dtO ...
  • 前兩天微軟偷偷更新了Visual Studio 2022 正式版版本 17.3 發佈,發佈摘要: MAUI 工作負荷 GA 生成 MAUI/Blazor CSS 熱重載支持 現在,你將能夠使用我們的新增功能在 Visual Studio 中使用每個更新試用一系列新功能。 選擇每個功能以瞭解有關特定功 ...
  • 航天和軍工領域的數字化轉型和建設正在積極推進,在與航天二院、航天三院、航天六院、航天九院、無線電廠、兵工廠等單位交流的過程中,用戶更聚焦試驗和生產過程中的痛點,迫切需要解決軟體平臺統一監測和控制設備及軟體與設備協同的問題。 ...
  • .NET 項目預設情況下 日誌是使用的 ILogger 介面,預設提供一下四種日誌記錄程式: 控制台 調試 EventSource EventLog 這四種記錄程式都是預設包含在 .NET 運行時庫中。關於這四種記錄程式的詳細介紹可以直接查看微軟的官方文檔 https://docs.microsof ...
  • 一:背景 上一篇我們聊到瞭如何去找 熱點函數,這一篇我們來看下當你的程式出現了 非托管記憶體泄漏 時如何去尋找可疑的代碼源頭,其實思路很簡單,就是在 HeapAlloc 或者 VirtualAlloc 時做 Hook 攔截,記錄它的調用棧以及分配的記憶體量, PerfView 會將這個 分配量 做成一個 ...
  • 背景 在 CI/CD 流程當中,測試是 CI 中很重要的部分。跟開發人員關係最大的就是單元測試,單元測試編寫完成之後,我們可以使用 IDE 或者 dot cover 等工具獲得單元測試對於業務代碼的覆蓋率。不過我們需要一個獨立的 CLI 工具,這樣我們才能夠在 Jenkins 的 CI 流程集成。 ...
  • 一、應用場景 大家在使用Mybatis進行開發的時候,經常會遇到一種情況:按照月份month將數據放在不同的表裡面,查詢數據的時候需要跟不同的月份month去查詢不同的表。 但是我們都知道,Mybatis是ORM持久層框架,即:實體關係映射,實體Object與資料庫表之間是存在一一對應的映射關係。比 ...
  • 我國目前並未出台專門針對網路爬蟲技術的法律規範,但在司法實踐中,相關判決已屢見不鮮,K 哥特設了“K哥爬蟲普法”專欄,本欄目通過對真實案例的分析,旨在提高廣大爬蟲工程師的法律意識,知曉如何合法合規利用爬蟲技術,警鐘長鳴,做一個守法、護法、有原則的技術人員。 案情介紹 深圳市快鴿互聯網科技有限公司 2 ...