Python Debugging神器 – import pdb

一、pdb是什麼？

Python Debugger是Python標準庫裡面的一個調試工具模塊。其中最常用的模式是使用pdb.set_trace()進行單步調試，可以幫助程序員找到代碼中出現的錯誤和問題。

二、pdb的基本使用方式

使用pdb的方法非常的簡單，只需要在程序中插入pdb.set_trace()代碼即可。一旦執行到這條語句的時候，代碼會停止執行，此時程序會進入到pdb調試器的交互模式。在交互模式中，輸入命令可以幫助我們查看當前程序執行到哪裡。比如輸入變數名可以查看變數值，或者使用p命令查看錶達式執行的結果等等。最終輸入q命令可以退出pdb交互的方式，讓程序繼續往下執行。

import pdb
def add(x, y):
    pdb.set_trace()
    return x + y
print(add(1, 2))

當程序運行到pdb.set_trace()時，會進入pdb調試器環境，可以使用多種命令來查看變數值、控制代碼流程和退出dbg環境：

(Pdb) p x
1
(Pdb) p y
2
(Pdb) p x + y
3
(Pdb) n
> path/to/code.py(4)add()
-> return x + y
(Pdb) p x + y
3
(Pdb) quit

三、pdb常用命令

1. 交互命令

• n – Next，執行下一條語句。
• s – Step，進入函數內部。
• r – Return，執行代碼直到當前函數返回。
• q – Quit，退出pdb調試器環境。
• c – Continue，直到遇到斷點或者程序結束。

2. 輸出命令

• p – Print，輸出變數的值。
• pp – Pretty Print，以更漂亮的方式輸出。
• l – List，輸出當前代碼的執行位置。
• w – Where，查看當前棧的狀態。

3. 斷點命令

• b – Break，設置代碼中斷點。
• c – Clear，清除一個斷點。
• j – Jump，跳轉到指定的行。

4. 其他命令

• h – Help，查看命令的幫助信息。
• h <command> – Help，查看指定命令的幫助信息。
• ! – 執行一個python表達式。

四、pdb注意事項

在使用pdb.set_trace()進行調試的時候，需要注意以下幾個事項：

• 不要將pdb.set_trace()附加到常規代碼。 在進行正常的代碼執行時，使用pdb會使您的代碼變慢，而且會影響運行時間。只有在必要的時候，或者在快要調試的時候才使用pdb。
• 盡量避免在循環中使用pdb。 在循環中使用pdb會使您的代碼變得非常緩慢。
• 不要在開發中使用pdb。 如果您對pdb非常熟悉，並且能夠快速調試代碼，那麼這個規則可以忽略。但是對於新手來說，會使用pdb來彌補對代碼本身的不理解，這樣會導致您的代碼出現大量的錯誤。

五、結語

使用pdb可以幫助我們更好的理解代碼的執行過程，對於程序的調試和問題定位也非常有幫助。在使用的過程中，需要注意pdb的使用規則，才能更好的發揮pdb的作用。