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
  • PasteSpider是什麼? 一款使用.net編寫的開源的Linux容器部署助手,支持一鍵發佈,平滑升級,自動伸縮, Key-Value配置,項目網關,環境隔離,運行報表,差量升級,私有倉庫,集群部署,版本管理等! 30分鐘上手,讓開發也可以很容易的學會在linux上部署你得項目! [從需求角度介 ...
  • SQLSugar是什麼 **1. 輕量級ORM框架,專為.NET CORE開發人員設計,它提供了簡單、高效的方式來處理資料庫操作,使開發人員能夠更輕鬆地與資料庫進行交互 2. 簡化資料庫操作和數據訪問,允許開發人員在C#代碼中直接操作資料庫,而不需要編寫複雜的SQL語句 3. 支持多種資料庫,包括但 ...
  • 在C#中,經常會有一些耗時較長的CPU密集型運算,因為如果直接在UI線程執行這樣的運算就會出現UI不響應的問題。解決這類問題的主要途徑是使用多線程,啟動一個後臺線程,把運算操作放在這個後臺線程中完成。但是原生介面的線程操作有一些難度,如果要更進一步的去完成線程間的通訊就會難上加難。 因此,.NET類 ...
  • 一:背景 1. 講故事 前些天有位朋友在微信上丟了一個崩潰的dump給我,讓我幫忙看下為什麼出現了崩潰,在 Windows 的事件查看器上顯示的是經典的 訪問違例 ,即 c0000005 錯誤碼,不管怎麼說有dump就可以上windbg開幹了。 二:WinDbg 分析 1. 程式為誰崩潰了 在 Wi ...
  • CSharpe中的IO+NPOI+序列化 文件文件夾操作 學習一下常見的文件、文件夾的操作。 什麼是IO流? I:就是input O:就是output,故稱:輸入輸出流 將數據讀入記憶體或者記憶體輸出的過程。 常見的IO流操作,一般說的是[記憶體]與[磁碟]之間的輸入輸出。 作用 持久化數據,保證數據不再 ...
  • C#.NET與JAVA互通之MD5哈希V2024 配套視頻: 要點: 1.計算MD5時,SDK自帶的計算哈希(ComputeHash)方法,輸入輸出參數都是byte數組。就涉及到字元串轉byte數組轉換時,編碼選擇的問題。 2.輸入參數,字元串轉byte數組時,編碼雙方要統一,一般為:UTF-8。 ...
  • CodeWF.EventBus,一款靈活的事件匯流排庫,實現模塊間解耦通信。支持多種.NET項目類型,如WPF、WinForms、ASP.NET Core等。採用簡潔設計,輕鬆實現事件的發佈與訂閱。通過有序的消息處理,確保事件得到妥善處理。簡化您的代碼,提升系統可維護性。 ...
  • 一、基本的.NET框架概念 .NET框架是一個由微軟開發的軟體開發平臺,它提供了一個運行時環境(CLR - Common Language Runtime)和一套豐富的類庫(FCL - Framework Class Library)。CLR負責管理代碼的執行,而FCL則提供了大量預先編寫好的代碼, ...
  • 本章將和大家分享在ASP.NET Core中如何使用高級客戶端NEST來操作我們的Elasticsearch。 NEST是一個高級別的Elasticsearch .NET客戶端,它仍然非常接近原始Elasticsearch API的映射。所有的請求和響應都是通過類型來暴露的,這使得它非常適合快速上手 ...
  • 參考delphi的代碼更改為C# Delphi 檢測密碼強度 規則(仿 google) 仿 google 評分規則 一、密碼長度: 5 分: 小於等於 4 個字元 10 分: 5 到 7 字元 25 分: 大於等於 8 個字元 二、字母: 0 分: 沒有字母 10 分: 全都是小(大)寫字母 20 ...