pdb --- Python 的調(diào)試器?

調(diào)試器命令?

下方列出的是調(diào)試器可接受的命令。如下所示，大多數(shù)命令可以縮寫為一個(gè)或兩個(gè)字母。如 h(elp) 表示可以輸入 h 或 help 來輸入幫助命令（但不能輸入 he 或 hel，也不能是 H 或 Help 或 HELP）。命令的參數(shù)必須用空格（空格符或制表符）分隔。在命令語法中，可選參數(shù)括在方括號(hào) ([]) 中，使用時(shí)請(qǐng)勿輸入方括號(hào)。命令語法中的選擇項(xiàng)由豎線 (|) 分隔。

輸入一個(gè)空白行將重復(fù)最后輸入的命令。例外：如果最后一個(gè)命令是 list 命令，則會(huì)列出接下來的 11 行。

調(diào)試器無法識(shí)別的命令將被認(rèn)為是 Python 語句，并在正在調(diào)試的程序的上下文中執(zhí)行。Python 語句也可以用感嘆號(hào) (!) 作為前綴。這是檢查正在調(diào)試的程序的強(qiáng)大方法，甚至可以修改變量或調(diào)用函數(shù)。當(dāng)此類語句發(fā)生異常，將打印異常名稱，但調(diào)試器的狀態(tài)不會(huì)改變。

調(diào)試器支持 別名。別名可以有參數(shù)，使得調(diào)試器對(duì)被檢查的上下文有一定程度的適應(yīng)性。

Multiple commands may be entered on a single line, separated by ;;. (A single ; is not used as it is the separator for multiple commands in a line that is passed to the Python parser.) No intelligence is applied to separating the commands; the input is split at the first ;; pair, even if it is in the middle of a quoted string. A workaround for strings with double semicolons is to use implicit string concatenation ';'';' or ";"";".

If a file .pdbrc exists in the user's home directory or in the current directory, it is read with 'utf-8' encoding and executed as if it had been typed at the debugger prompt. This is particularly useful for aliases. If both files exist, the one in the home directory is read first and aliases defined there can be overridden by the local file.

h(elp) [command]?

不帶參數(shù)時(shí)，顯示可用的命令列表。參數(shù)為 command 時(shí)，打印有關(guān)該命令的幫助。help pdb 顯示完整文檔（即 pdb 模塊的文檔字符串）。由于 command 參數(shù)必須是標(biāo)識(shí)符，因此要獲取 ! 的幫助必須輸入 help exec。

w(here)?

打印堆?；厮荩钚乱粠诘撞?。有一個(gè)箭頭指向當(dāng)前幀，該幀決定了大多數(shù)命令的上下文。

d(own) [count]?

在堆棧回溯中，將當(dāng)前幀向下移動(dòng) count 級(jí)（默認(rèn)為 1 級(jí)，移向更新的幀）。

u(p) [count]?

在堆棧回溯中，將當(dāng)前幀向上移動(dòng) count 級(jí)（默認(rèn)為 1 級(jí)，移向更老的幀）。

b(reak) [([filename:]lineno | function) [, condition]]?

如果帶有 lineno 參數(shù)，則在當(dāng)前文件相應(yīng)行處設(shè)置一個(gè)斷點(diǎn)。如果帶有 function 參數(shù)，則在該函數(shù)的第一條可執(zhí)行語句處設(shè)置一個(gè)斷點(diǎn)。行號(hào)可以加上文件名和冒號(hào)作為前綴，以在另一個(gè)文件（可能是尚未加載的文件）中設(shè)置一個(gè)斷點(diǎn)。另一個(gè)文件將在 sys.path 范圍內(nèi)搜索。請(qǐng)注意，每個(gè)斷點(diǎn)都分配有一個(gè)編號(hào)，其他所有斷點(diǎn)命令都引用該編號(hào)。

如果第二個(gè)參數(shù)存在，它應(yīng)該是一個(gè)表達(dá)式，且它的計(jì)算值為 true 時(shí)斷點(diǎn)才起作用。

如果不帶參數(shù)執(zhí)行，將列出所有中斷，包括每個(gè)斷點(diǎn)、命中該斷點(diǎn)的次數(shù)、當(dāng)前的忽略次數(shù)以及關(guān)聯(lián)的條件（如果有）。

tbreak [([filename:]lineno | function) [, condition]]?

臨時(shí)斷點(diǎn)，在第一次命中時(shí)會(huì)自動(dòng)刪除。它的參數(shù)與 break 相同。

cl(ear) [filename:lineno | bpnumber ...]?

如果參數(shù)是 filename:lineno，則清除此行上的所有斷點(diǎn)。如果參數(shù)是空格分隔的斷點(diǎn)編號(hào)列表，則清除這些斷點(diǎn)。如果不帶參數(shù)，則清除所有斷點(diǎn)（但會(huì)先提示確認(rèn)）。

disable [bpnumber ...]?

禁用斷點(diǎn)，斷點(diǎn)以空格分隔的斷點(diǎn)編號(hào)列表給出。禁用斷點(diǎn)表示它不會(huì)導(dǎo)致程序停止執(zhí)行，但是與清除斷點(diǎn)不同，禁用的斷點(diǎn)將保留在斷點(diǎn)列表中并且可以（重新）啟用。

enable [bpnumber ...]?

啟用指定的斷點(diǎn)。

ignore bpnumber [count]?

為指定的斷點(diǎn)編號(hào)設(shè)置忽略次數(shù)。如果省略 count，則忽略次數(shù)將設(shè)置為 0。忽略次數(shù)為 0 時(shí)斷點(diǎn)將變?yōu)榛顒?dòng)狀態(tài)。如果為非零值，在每次達(dá)到斷點(diǎn)，且斷點(diǎn)未禁用，且關(guān)聯(lián)條件計(jì)算值為 true 的情況下，該忽略次數(shù)會(huì)遞減。

condition bpnumber [condition]?

為斷點(diǎn)設(shè)置一個(gè)新 condition，它是一個(gè)表達(dá)式，且它的計(jì)算值為 true 時(shí)斷點(diǎn)才起作用。如果沒有給出 condition，則刪除現(xiàn)有條件，也就是將斷點(diǎn)設(shè)為無條件。

commands [bpnumber]?

為編號(hào)是 bpnumber 的斷點(diǎn)指定一系列命令。命令內(nèi)容將顯示在后續(xù)的幾行中。輸入僅包含 end 的行來結(jié)束命令列表。舉個(gè)例子:

(Pdb) commands 1
(com) p some_variable
(com) end
(Pdb)

要?jiǎng)h除斷點(diǎn)上的所有命令，請(qǐng)輸入 commands 并立即以 end 結(jié)尾，也就是不指定任何命令。

如果不帶 bpnumber 參數(shù)，commands 作用于最后一個(gè)被設(shè)置的斷點(diǎn)。

可以為斷點(diǎn)指定命令來重新啟動(dòng)程序。只需使用 continue 或 step 命令或其他可以繼續(xù)運(yùn)行程序的命令。

如果指定了某個(gè)繼續(xù)運(yùn)行程序的命令（目前包括 continue, step, next, return, jump, quit 及它們的縮寫）將終止命令列表（就像該命令后緊跟著 end）。因?yàn)樵谌魏螘r(shí)候繼續(xù)運(yùn)行下去（即使是簡(jiǎn)單的 next 或 step），都可能會(huì)遇到另一個(gè)斷點(diǎn)，該斷點(diǎn)可能具有自己的命令列表，這導(dǎo)致要執(zhí)行的列表含糊不清。

如果在命令列表中加入 'silent' 命令，那么在該斷點(diǎn)處停下時(shí)就不會(huì)打印常規(guī)信息。如果希望斷點(diǎn)打印特定信息后繼續(xù)運(yùn)行，這可能是理想的。如果沒有其他命令來打印一些信息，則看不到已達(dá)到斷點(diǎn)的跡象。

s(tep)?

運(yùn)行當(dāng)前行，在第一個(gè)可以停止的位置（在被調(diào)用的函數(shù)內(nèi)部或在當(dāng)前函數(shù)的下一行）停下。

n(ext)?

繼續(xù)運(yùn)行，直到運(yùn)行到當(dāng)前函數(shù)的下一行，或當(dāng)前函數(shù)返回為止。（ next 和 step 之間的區(qū)別在于，step 進(jìn)入被調(diào)用函數(shù)內(nèi)部并停止，而 next （幾乎）全速運(yùn)行被調(diào)用函數(shù)，僅在當(dāng)前函數(shù)的下一行停止。）

unt(il) [lineno]?

如果不帶參數(shù)，則繼續(xù)運(yùn)行，直到行號(hào)比當(dāng)前行大時(shí)停止。

如果帶有行號(hào)，則繼續(xù)運(yùn)行，直到行號(hào)大于或等于該行號(hào)時(shí)停止。在這兩種情況下，當(dāng)前幀返回時(shí)也將停止。

在 3.2 版更改: 允許明確給定行號(hào)。

r(eturn)?

繼續(xù)運(yùn)行，直到當(dāng)前函數(shù)返回。

c(ont(inue))?

繼續(xù)運(yùn)行，僅在遇到斷點(diǎn)時(shí)停止。

j(ump) lineno?

設(shè)置即將運(yùn)行的下一行。僅可用于堆棧最底部的幀。它可以往回跳來再次運(yùn)行代碼，也可以往前跳來跳過不想運(yùn)行的代碼。

需要注意的是，不是所有的跳轉(zhuǎn)都是允許的 -- 例如，不能跳轉(zhuǎn)到 for 循環(huán)的中間或跳出 finally 子句。

l(ist) [first[, last]]?

列出當(dāng)前文件的源代碼。如果不帶參數(shù)，則列出當(dāng)前行周圍的 11 行，或繼續(xù)前一個(gè)列表。如果用 . 作為參數(shù)，則列出當(dāng)前行周圍的 11 行。如果帶有一個(gè)參數(shù)，則列出那一行周圍的 11 行。如果帶有兩個(gè)參數(shù)，則列出所給的范圍中的代碼；如果第二個(gè)參數(shù)小于第一個(gè)參數(shù)，則將其解釋為列出行數(shù)的計(jì)數(shù)。

當(dāng)前幀中的當(dāng)前行用 -> 標(biāo)記。如果正在調(diào)試異常，且最早拋出或傳遞該異常的行不是當(dāng)前行，則那一行用 >> 標(biāo)記。

3.2 新版功能: >> 標(biāo)記。

ll | longlist?

列出當(dāng)前函數(shù)或幀的所有源代碼。相關(guān)行的標(biāo)記與 list 相同。

3.2 新版功能.

a(rgs)?

打印當(dāng)前函數(shù)的參數(shù)列表。

p expression?

在當(dāng)前上下文中運(yùn)行 expression 并打印它的值。

備注

print() 也可以使用，但它不是一個(gè)調(diào)試器命令 --- 它執(zhí)行 Python print() 函數(shù)。

pp expression?

與 p 命令類似，但表達(dá)式的值使用 pprint 模塊美觀地打印。

whatis expression?

打印 expression 的類型。

source expression?

嘗試獲取給定對(duì)象的源代碼并顯示出來。

3.2 新版功能.

display [expression]?

如果表達(dá)式的值發(fā)生改變則顯示它的值，每次將停止執(zhí)行當(dāng)前幀。

不帶表達(dá)式則列出當(dāng)前幀的所有顯示表達(dá)式。

3.2 新版功能.

undisplay [expression]?

不再顯示當(dāng)前幀中的表達(dá)式。 不帶表達(dá)式則清除當(dāng)前幀的所有顯示表達(dá)式。

3.2 新版功能.

interact?

啟動(dòng)一個(gè)交互式解釋器（使用 code 模塊），它的全局命名空間將包含當(dāng)前作用域中的所有（全局和局部）名稱。

3.2 新版功能.

alias [name [command]]?

創(chuàng)建一個(gè)標(biāo)識(shí)為 name 的別名來執(zhí)行 command。 執(zhí)行的命令 不可 加上引號(hào)。 可替換形參可通過 %1, %2 等來標(biāo)示，而 %* 會(huì)被所有形參所替換。 如果沒有給出命令，則會(huì)顯示 name 的當(dāng)前別名。 如果沒有給出參數(shù)，則會(huì)列出所有別名。

別名允許嵌套并可包含能在 pdb 提示符下合法輸入的任何內(nèi)容。 請(qǐng)注意內(nèi)部 pdb 命令 可以 被別名所覆蓋。 這樣的命令將被隱藏直到別名被移除。 別名會(huì)遞歸地應(yīng)用到命令行的第一個(gè)單詞；行內(nèi)的其他單詞不會(huì)受影響。

作為示例，這里列出了兩個(gè)有用的別名（特別適合放在 .pdbrc 文件中）:

# Print instance variables (usage "pi classInst")
alias pi for k in %1.__dict__.keys(): print("%1.",k,"=",%1.__dict__[k])
# Print instance variables in self
alias ps pi self

unalias name?

刪除指定的別名。

! statement?

在當(dāng)前堆棧幀的上下文中執(zhí)行 (單行) statement。 感嘆號(hào)可以被省略，除非語句的第一個(gè)單詞與調(diào)試器命令重名。 要設(shè)置全局變量，你可以在同一行上為賦值命令添加前綴的 global 語句，例如:

(Pdb) global list_options; list_options = ['-l']
(Pdb)

run [args ...]?

restart [args ...]?

重啟被調(diào)試的 Python 程序。 如果提供了參數(shù)，它會(huì)用 shlex 來拆分且拆分結(jié)果將被用作新的 sys.argv。 歷史、中斷點(diǎn)、動(dòng)作和調(diào)試器選項(xiàng)將被保留。 restart 是 run 的一個(gè)別名。

q(uit)?

退出調(diào)試器。 被執(zhí)行的程序?qū)⒈恢兄埂?/p>

debug code?

進(jìn)入一個(gè)對(duì)代碼參數(shù)執(zhí)行步進(jìn)的遞歸調(diào)試器（該參數(shù)是在當(dāng)前環(huán)境中執(zhí)行的任意表達(dá)式或語句）。

retval?

打印函數(shù)最后一次返回的返回值。

備注

1

一個(gè)幀是否會(huì)被認(rèn)為源自特定模塊是由幀全局變量 __name__ 來決定的。