對於 bug 鋪天蓋地的 Python 程序,該如何高效的調試?

不管用什麼語言在編寫程序的時候,總會出現形形色色的 bug,由於程序員經常被玩壞,各種屬於程序員的“俚語”也被大衆熟知,出現了 bug 估計連我隔壁老王的三姨媽的四表舅的遠房表姐的鄰居的同學的妹夫的外婆的還在喝奶的侄女都知道要 debug,問題是 debug 說的容易,如何“de”,估計很多人還是一腦門兒


在這裏插入圖片描述


在遙遠的 n 年前,那個時候我還是個憨批,阿不,是個蒟蒻。那個時候我在 寫 C 語言(我的第一門編程語言)的時候,出現了 bug 用 printf 查錯,可能寫的程序又多又爛,printf 被我用的爐火純青,出神入化,debug 的速度比我洗腦殼的時間還要快上一分。


在這裏插入圖片描述


Python 的手段比當年 C 的手段還多了不少,除了“打印”(print)以外,還可以配合 assert、log 來分析錯誤原因,再加上單元測試效率還是四顆星的。但是這種方式,更多的適合“自娛自樂”的情況。啥是自娛自樂,就是這段代碼是你寫的,你知道代碼什麼意思,而且最好這個代碼比較…短。


在這裏插入圖片描述


後來入了 ACM 的坑,有了能讓我抱大腿的隊友,成了一位光榮的划水選手。我不能只看自己的代碼了,我的 printf 如陷入了泥沼中,寸步難行,在“大腿”鄙視的眼神中,被安利了「單步調試」,它的絲滑讓我欲罷不能,只能用這兩個字形容:


在這裏插入圖片描述


因爲對它的迷戀,在學 Python 的第一時間,我就查瞭如何調試 Python 代碼,我發現 Python 對於 debug 的支持還是很給勁的,常用的有兩種:pdb 調試和斷點 + 單步調試。


0x00 pdb 調試


pdb 是 Python 自帶的庫,爲 Python 提供了一種交互式的源碼調試功能,包含當前調試器應有的功能,包括設置斷點、單步調試、查看源碼等。其實如果你之前學過 C/C++ 的話,你可能知道 gdb 這個命令行調試工具,如果你之前用過 gdb,那麼恭喜你你可以直接用 pdb 了,因爲兩個用法是一樣的。

其實還有一個開源的 Python 調試器 – ipdb,它和 pdb 的接口是一樣的,但是 ipdb 相比於 pdb 多了語法高亮,tab 自動補全等友好功能,在易用性方面做了很大的改進,這個感覺就和 Python 和 IPython 一樣。

關於 pdb 調試和 ipdb 調試的用法,我在以前的文章中也寫過,感興趣的可以看一下:

Python 調試器,一個優秀開發人員的必備技能包。


0x01 斷點 + 單步調試


這個更多的是在圖形界面下的調試,很多 IDE 都支持 Python,調試功能都很完善,這裏我主要介紹在 Pycharm 下的調試,畢竟 Pycharm 可以說是當前最好用的 Python IDE。

斷點


在斷點這個地方,主要分爲兩步:「找斷點」和「打斷點」。

找斷點,就是你想調試的代碼塊的第一行代碼即可,也就是一個斷點接足夠了,找到以後就可以打斷點了。可能有同學就有這麼一個問題:


我都不知道是哪部分出了問題,我哪知道我要調試哪段代碼?

在這裏插入圖片描述


好像有點道理,不要慌,問題不大。首先你在關鍵的代碼位置上 print,然後通過分析 print 的值來縮小範圍,當然這個過程你要穩住,可能需要重複多次,一般這樣就可以將範圍縮小到一個比較完整的功能代碼塊中,然後就打斷點好了。


所以知道爲啥叫“打”斷點了吧,誰讓它那麼難找...

在這裏插入圖片描述


下面來說打斷點的方法,就是單擊目標代碼的行號右邊空白處,然後出現一個紅紅的圈,就證明打斷點成功了,請看下圖:


在這裏插入圖片描述

單步調試


斷點打完了,那麼就該「單步調試」了。


調試的方法非常簡單,就是在當前的 py 文件內部點鼠標右鍵,單擊“Debug xxx”(xxx 是 py 文件名):


在這裏插入圖片描述


此時 Pycharm 會調出一個控制檯,這個控制檯大概分爲顯示內容的區域和工具區域:


在這裏插入圖片描述


其中工具區域有兩個面板:Debugger 和 Console。對於 Debugger 面板,它的內容是在內容區域顯示,顯示的爲程序執行過程中的變量及細節;Console 面板則是輸出數據顯示的位置。


對於我們的代碼,如果到調試狀態,該行代碼就處於一個凍結的狀態,在點擊"按步操作"之後,纔會一行一行代碼執行。


主要用到 Step Over 這個按鈕:

在這裏插入圖片描述


單擊 Step Over 這個按鈕之後,代碼會跳到下一行,這時代表着第一行代碼已經執行完畢,此時在 Debugger 面板顯示如下:


在這裏插入圖片描述


在上圖中我們看到了在程序運行狀態下變量中的值,這樣一來,程序的運行過程對於我們來說就變的很透明瞭,我們就可以看到在運行過程中這個值是不是我們期望的值,如果不是,那這就是出 Bug 的原因。

然後我們繼續單擊 Step Over 按鈕,一直到最後一步:

在這裏插入圖片描述


然後你會在 Debugger 面板內看到所有的變量及其值和類型,然後我們再來單擊 Step Over 按鈕,讓我們來看一下發生了什麼:


在這裏插入圖片描述

天吶個天,Debugger 面板中什麼都沒了…

在這裏插入圖片描述

不要慌,這都是有緣由的。還記得在那很久很久以前,我給大家講的變量麼…

在這裏插入圖片描述

忘記沒事,聽我再慢慢道來…

這要從盤古開天闢地,阿不,女媧補天說起…

變量是啥子呢?我們知道變量是存儲數據的。但是變量它住在哪呢?住在內存裏,當然這個住只能是暫住,畢竟內存就這麼大點兒,都賴着不走那內存很快就滿了。它臨時存儲再內存當中,啥叫臨時存儲,就是到點兒了就趕你走,變量的"到點兒"就是程序執行完的時候,那個時候內存中的變量就沒了,所以我們就什麼也看不到了。

Debugger 面板完事兒了,下面就該看 Console 面板了:

在這裏插入圖片描述

當我們切換到 Console 面板的時候,我們看到了兩個 print 輸出的結果(兩個結果是在一步步 Step Over 的過程中,每執行完一個 print 之後產生一個對應的結果)。

使用斷點 + 單步調試的方法可以很完美的展示程序"自上而下"執行這一特徵,同時可以查看程序的執行細節、變量類型和數據輸出這些內容,可以更快速的找出 bug,理解程序運行的過程,省時省力又省心。

文章中我用了很簡單的一段代碼來演示在 Pycharm 中如何打斷點,如何單步調試,其實對於複雜的程序,也是由一個個簡單的代碼塊堆積起來,掌握了方法,多寫 bug,阿不,多用調試方法,相信隨着這個過程的進行,你一定能成爲一個 debug 小能手。


在這裏插入圖片描述

❤️ 看完有所收穫?希望愛學習的你不要吝嗇三連擊喲[點贊 + 收藏 + 評論]~



另外本蒟蒻把公衆號的高分原創文章整理成了一本電子書,取名《Python修煉之道》,一共 400 頁!

具體內容請戳:熬夜爆肝整理 400 頁 《Python 修煉之道》,一本高分原創高清電子書送給你!

目錄如下:


在這裏插入圖片描述

現在免費送給大家,在我的公衆號Python空間(微信搜 Devtogether) 回覆 修煉之道即可獲取。


作者Info:

【作者】:Rocky0429
【原創公衆號】:Python空間。
【簡介】:CSDN 博客專家, 985 計算機在讀研究生,ACM 退役狗 & 亞洲區域賽銀獎划水選手。這是一個堅持原創的技術公衆號,專注Python 編程,每天堅持推送各種 Python 基礎/進階文章,數據分析,爬蟲實戰,數據結構與算法,不定期分享各類資源。
【轉載說明】:轉載請說明出處,謝謝合作!~

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章