調試應用有時是一個不受歡迎的工作，當你長期編碼之后，只希望寫的代碼順利運行。但是，很多情況下，我們需要學習一個新的語言功能或者實驗檢測新的方法，從而去理解其中運行的機制原理。
即使不考慮這樣的場景，調試代碼仍然是有必要的，所以學會在工作中使用調試器是很重要的。本篇教程中，我將會給出基本的使用關于pdb----python‘s interative source code debugger。
首先給出一些pdb的基礎知識，大家可以保存這篇文章方便后續的閱讀。pdb類似于其他的調試器，是獨立的工具，當你需要一個調試器時，它們是不可替代的。本篇教程的最后，大家將會學習到如何使用調試器來查看應用中的任何變量，可以在任何時刻停止或恢復應用執行流程，從而了解到每行代碼是如何影響應用的內部狀態的。
這有助于追蹤難以發現的bug，并且實現快速可靠的解決缺陷代碼。有時候，在pdb中單步調試代碼，然后查看變量值的變化，可以有助于我們對應用代碼的深層次理解。pdb是python標準庫的一部分，所以只要我們使用了python解釋器，也就可以使用pdb，非常方便。
本文所使用的實例代碼會放在文章的末尾，使用的環境是python3.6及以后的解釋器，大家可以下載源碼方便學習。
1.開始階段：答應一個變量值
開始案例，我們首先探索pdb最簡單的使用：查閱一個變量的值。首先，我們在一個源碼文件中某一行，寫入下列語句：
|
1
|
import pdb; pdb.set_trace() |
當這一行代碼被執行后，python代碼文件就會被暫停運行，等待你發布命令來指導它下一步如何操作。運行上面的代碼后，你可以在命令行界面看到（pdb）的提示符，這就意味著，代碼被停止了，等待命令的輸入。
自從python3.7以來，官方標準建議使用標準庫內部函數breakpoint()替代上面的代碼（注意：本文附帶的代碼都使用的上面代碼形式），這樣可以更加加快解釋器的運行和調試：
|
1
|
breakpoint() |
默認情況下，breakpoint()將會倒入pdb模塊，然后調用pdb.set_trace()函數，只是它進行了進一步封裝。但是，使用breakpoint()可以更加靈活，并且允許用戶通過調用它的api來控制調試行為，以及使用環境變量pythonbreakpoint。例如，當我們設置pythonbreakpoint=0在我們的環境中，這就會完全關閉breakpoint()的功能，從而關閉調試功能。
此外，我們還可以不用手動在源代碼文件中加入斷點代碼，只需要在命令行輸入運行指令時通過參數傳遞來設置，例如：
|
1
|
$ python3 -m pdb app.py arg1 arg2 |
那么，讓我們直接進入本小節的內容，也就是查閱代碼中變量的值，看下面的案例，使用的源碼文件是codeexample1.py：
|
1
2
3
4
5
|
#!/usr/bin/env python3filename = __file__import pdb; pdb.set_trace()print(f'path={filename}') |
而在你命令行界面，運行上述的python代碼，你就可以得到下面的輸出結果：
|
1
2
3
4
|
$ ./codeexample1.py> /code/codeexample1.py(5)<module>()-> print(f'path={filename}')(pdb) |
接下來，讓我們輸入p filename這個命令，來查看filename這個變量的值，可以看到下述結果：
|
1
2
3
|
(pdb) p filename'./codeexample1.py'(pdb) |
因為我們使用的是一個命令行接口界面程序（command-line interface），那么注意一下輸出的字符和格式，解釋如下：
-
>開始的第一行告訴我們所運行的源碼文件名稱，源碼名稱之后，用小括號包含的是當前代碼行數，再后面就是函數名稱。這里，因為我們沒用調用任何函數，而是處于模塊級別，所用見到的是()。 -
->開始的第二行表示目前行數代碼對應的具體代碼內容。 -
(pdb)是一個pdb提示符，等待下一個命令的輸入。
我們可以使用q命令，表示推出調試（quit）。
2.打印表達式
當使用命令p，我們同樣可以輸入一個表達式，讓python來計算表達式的值。 如果傳入一個變量名，pdb就會答應當前變量對應的值。但是，我們可以進一步調查我們應用程序當前的運行狀態。
下面案例中，當函數get_path()被調用，為了查看在這個函數中發生了什么，我已經提前插入斷點程序pdb.set_trace()，來阻斷程序的運行，源碼codeexample2.py內容如下：
|
1
2
3
4
5
6
7
8
9
10
|
#!/usr/bin/env python3import osdef get_path(filename): """return file's path or empty string if no path.""" head, tail = os.path.split(filename) import pdb; pdb.set_trace() return headfilename = __file__print(f'path = {get_path(filename)}') |
如果在命令行中運行這個文件，可以得到下面的輸出：
|
1
2
3
4
|
$ ./codeexample2.py > /code/example2.py(10)get_path()-> return head(pdb) |
那么此時，我們處于什么階段：
-
>：表示我們在源碼文件codeexample2.py的第10行代碼處，此處是函數get_path()。如果運行命令p輸出的標量，就是當前所引用的代碼幀，也就是當前上下文內的標量。 -
->：運行的代碼已經被停止在return head處，這一行代碼還沒有被執行，是位于codeexample2.py文件的第10行處，具體是在函數get_path()內。
如果想要查看應用當前狀態代碼上下文情況，可以使用命令ll（longlist），來查看代碼內容，具體內容如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
(pdb) ll 6 def get_path(filename): 7 """return file's path or empty string if no path.""" 8 head, tail = os.path.split(filename) 9 import pdb; pdb.set_trace() 10 -> return head(pdb) p filename'./codeexample2.py'(pdb) p head, tail('.', 'codeexample2.py')(pdb) p 'filename: ' + filename'filename: ./codeexample2.py'(pdb) p get_path<function get_path at 0x100760e18>(pdb) p getattr(get_path, '__doc__')"return file's path or empty string if no path."(pdb) p [os.path.split(p)[1] for p in os.path.sys.path]['pdb-basics', 'python36.zip', 'python3.6', 'lib-dynload', 'site-packages'](pdb) |
你可以輸入任何有效的python表達式接在p后面，來進行計算。當你正在調試并希望在運行時直接在應用程序中測試替代實現時，這尤其有用。您還可以使用命令 pp（漂亮打印）來美觀打印表達式。 如果您想打印具有大量輸出的變量或表達式，例如列表和字典。 如果可以，漂亮打印將對象保留在一行上，如果它們不適合允許的寬度，則將它們分成多行。
3.調試代碼
在這一部分，我們主要是用兩個命令來實現代碼的調試，如下圖所示：
命令n（next）和s（step）的區別是，pdb運行停止的位置。使用n（next），pdb會進行執行，直到運行到當前函數或模塊的下一行代碼，即：如果有外部函數被調用，不會跳轉到外部函數代碼中，可以把n理解為“step over”。使用s（step）來執行當前代碼，但是如果有外部函數被調用，會跳轉到外部函數中，可以理解為“step into”，如果執行到外部跳轉函數，s命令會輸出--call--。
n（next）和s（step）命令都會暫定代碼的執行，當運行到當前函數的結束部分，并且打印出--return--，下面是codeexample3.py文件源碼內容：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
#!/usr/bin/env python3import osdef get_path(filename): """return file's path or empty string if no path.""" head, tail = os.path.split(filename) return headfilename = __file__import pdb; pdb.set_trace()filename_path = get_path(filename)print(f'path = {filename_path}') |
如果在命令行中運行這個文件，同時輸入命令n，可以得到下面的輸出：
|
1
2
3
4
5
6
7
|
$ ./codeexample3.py > /code/example3.py(14)<module>()-> filename_path = get_path(filename)(pdb) n> /code/example3.py(15)<module>()-> print(f'path = {filename_path}')(pdb) |
通過使用命令n（next），我們停止在15行代碼，并且我們也只是在此模塊中，沒有跳轉到函數get_path()。此處函數表示為
再讓我們嘗試使用s（step）命令，輸出為：
|
1
2
3
4
5
6
7
8
|
$ ./codeexample3.py > /code/example3.py(14)<module>()-> filename_path = get_path(filename)(pdb) s--call--> /code/example3.py(6)get_path()-> def get_path(filename):(pdb) |
通過使用s（step）命令，我們停止在函數get_path()內部的第6行代碼處，因為這個函數是在代碼文件中第14行處被調用的，注意在s命令之后輸出了--call--，表明是函數調用。為了方便，pdb有命令記憶功能，如果我們要調試很多代碼，可以輸入enter回車鍵，來重復執行命令。
下面是我們混合使用n（next）和s（step）命令的案例，首先輸入s（step），因為我們想要進入函數get_path()，然后通過命令n（next）在局部調試代碼，并且使用enter回車鍵，避免重復輸入命令：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
$ ./codeexample3.py > /code/codeexample3.py(14)<module>()-> filename_path = get_path(filename)(pdb) s--call--> /code/codeexample3.py(6)get_path()-> def get_path(filename):(pdb) n> /code/codeexample3.py(8)get_path()-> head, tail = os.path.split(filename)(pdb) > /code/codeexample3.py(9)get_path()-> return head(pdb) --return--> /code/codeexample3.py(9)get_path()->'.'-> return head(pdb) > /code/codeexample3.py(15)<module>()-> print(f'path = {filename_path}')(pdb) path = .--return--> /code/codeexample3.py(15)<module>()->none-> print(f'path = {filename_path}')(pdb) |
注意輸出的--call--和--return--，這是pdb輸出的信息，提示我們調試過程的狀態信息，n（next）和s（step）命令都會在函數返回后停止，這也就是我們會看到--return--信息的輸出。此外，還要注意->'.'在第一個--return--輸出上面的結尾處：
|
1
2
3
4
|
--return--> /code/example3.py(9)get_path()->'.'-> return head(pdb) |
當pdb停止到一個函數的結尾，但是還沒有運行到return時，pdb同樣會打印return值，在上面例子中就是'.'.
3.1顯示代碼
不要忘記，我們上面提到了命令ll（longlist：顯示當前函數或幀的源代碼），在我們調試進入到不熟悉的代碼上下文中，這個命令非常有效，我們可以打印出整個函數代碼，顯示樣例如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
$ ./codeexample3.py > /code/codeexample3.py(14)<module>()-> filename_path = get_path(filename)(pdb) s--call--> /code/codeexample3.py(6)get_path()-> def get_path(filename):(pdb) ll 6 -> def get_path(filename): 7 """return file's path or empty string if no path.""" 8 head, tail = os.path.split(filename) 9 return head(pdb) |
如果想要查看簡短的代碼片段，我們可以使用命令l（list），不需要輸入參數，它將會打印11行目前代碼附近的代碼內容，案例如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
$ ./codeexample3.py > /code/codeexample3.py(14)<module>()-> filename_path = get_path(filename)(pdb) l 9 return head 10 11 12 filename = __file__ 13 import pdb; pdb.set_trace() 14 -> filename_path = get_path(filename) 15 print(f'path = {filename_path}')[eof](pdb) l[eof](pdb) l . 9 return head 10 11 12 filename = __file__ 13 import pdb; pdb.set_trace() 14 -> filename_path = get_path(filename) 15 print(f'path = {filename_path}')[eof](pdb) |
4.斷點使用
斷點的正確使用，在我們調試過程中可以節約大量的時間。不需要單步調試一行行代碼，而只用簡單地在我們想要查閱的地方設置一個斷點，就可以直接運行到斷點處進行調試。同樣的，我們可以添加條件，來讓pdb判斷是否需要設置斷點。通常使用命令b（break）來設置一個斷點，我們可以通過指定代碼行數，或者是想要調試的函數名稱，語法如下：
|
1
|
b(reak) [ ([filename:]lineno | function) [, condition] ] |
如果filename:沒有在代碼行數之前被指定，那么默認就是當前代碼文件中。注意第二個可選參數是b: condition，這個功能非常強大。假設在一個場景下，我們想要在某種條件成立的情況下設置斷點，如果我們傳入一個表達式座位第二個參數，pdb會在計算改表達式為true的情況下設置斷點，我們會在下面給出案例。下面案例中，使用了一個工具模塊util.py，讓我們在函數get_path()中設置一個斷點，下面是代碼codeexample4.py的內容：
|
1
2
3
4
5
6
7
8
|
#!/usr/bin/env python3import utilfilename = __file__import pdb; pdb.set_trace()filename_path = util.get_path(filename)print(f'path = {filename_path}') |
下面是工具模塊util.py文件內容：
|
1
2
3
4
5
|
def get_path(filename): """return file's path or empty string if no path.""" import os head, tail = os.path.split(filename) return head |
首先，讓我們使用源碼文件名稱和代碼行數來設置斷點：
|
1
2
3
4
5
6
7
8
9
10
11
|
$ ./example4.py > /code/example4.py(7)<module>()-> filename_path = util.get_path(filename)(pdb) b util:5breakpoint 1 at /code/util.py:5(pdb) c> /code/util.py(5)get_path()-> return head(pdb) p filename, head, tail('./example4.py', '.', 'example4.py')(pdb) |
命令c（continue）是實現被斷點停止后繼續運行的命令，下面，讓我們使用函數名來設置斷點：
|
1
2
3
4
5
6
7
8
9
10
11
|
$ ./codeexample4.py > /code/codeexample4.py(7)<module>()-> filename_path = util.get_path(filename)(pdb) b util.get_pathbreakpoint 1 at /code/util.py:1(pdb) c> /code/util.py(3)get_path()-> import os(pdb) p filename'./codeexample4.py'(pdb) |
如果輸入b，并且不帶任何參數，就可以查看到所有已經設置的斷點信息：
|
1
2
3
4
|
(pdb) bnum type disp enb where1 breakpoint keep yes at /code/util.py:1(pdb) |
你可以使用命令 disable bpnumber 和 enable bpnumber 禁用和重新啟用斷點。 bpnumber 是斷點列表第一列 num 中的斷點編號。 注意 enb 列的值變化：
|
1
2
3
4
5
6
7
8
9
10
11
|
(pdb) disable 1disabled breakpoint 1 at /code/util.py:1(pdb) bnum type disp enb where1 breakpoint keep no at /code/util.py:1(pdb) enable 1enabled breakpoint 1 at /code/util.py:1(pdb) bnum type disp enb where1 breakpoint keep yes at /code/util.py:1(pdb) |
為了刪除一個斷點，可以使用命令cl（clear）：
|
1
2
|
cl(ear) filename:linenocl(ear) [bpnumber [bpnumber...]] |
現在，讓我們嘗試在設置斷點時輸入表達式參數，在當前案例場景下，get_path()函數如果接受到一個相對路徑，即：如果路徑名稱不是以/開始的，那么就不會設置斷點，具體案例如下：
|
1
2
3
4
5
6
7
8
9
10
11
|
$ ./codeexample4.py > /code/codeexample4.py(7)<module>()-> filename_path = util.get_path(filename)(pdb) b util.get_path, not filename.startswith('/')breakpoint 1 at /code/util.py:1(pdb) c> /code/util.py(3)get_path()-> import os(pdb) afilename = './codeexample4.py'(pdb) |
如果創建一個斷點后，繼續輸入c（continue）命令來運行，pdb只會在表達式計算為true的情況下停止運行。命令a（args）會打印出當前函數的傳入參數。
上述案例中，如果你通過函數名稱而不是代碼行數來設置斷點，注意表達式只會使用當前函數的參數或者全局變量，不然的話，斷點就會不去計算表達式，而直接停止函數運行。如果，我們還是想用不是當前的函數變量來計算表達式，也就是使用的變量不在當前函數參數列表中，那么就要指定代碼行數，案例如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
$ ./codeexample4.py > /code/codeexample4.py(7)<module>()-> filename_path = util.get_path(filename)(pdb) b util:5, not head.startswith('/')breakpoint 1 at /code/util.py:5(pdb) c> /code/util.py(5)get_path()-> return head(pdb) p head'.'(pdb) afilename = './codeexample4.py'(pdb) |
5.繼續執行代碼
目前，我們可以使用n（next）和s（step）命令來調試查看代碼，然后使用命令b（break）和c（continue）來停止或繼續代碼的運行，這里還有一個相關的命令：unt（until）。使用unt命令類似于c命令，但是它的運行結果是，下一行比當前代碼行數大的位置。有時，unt更加方便和便捷使用，讓我們在下面案例中展示，首先給出使用語法：
取決于我們是否輸入代碼行數參數lineno，unt命令可以按照下面兩種方式運行：
- 沒有lineno，代碼可以繼續執行到，下一次行數比當前行數大的位置，這就相似于n（next），也就是類似于執行“step over”的另一種形式。但是，命令n和unt的不同點是，unt只會在下一次行數比當前行數大的位置停止，而n命令會停在下一個邏輯執行行。
- 具有lineno，代碼會運行到下一次行數比當前行數大或者相等的位置，這就類似于c（continue）后面帶有一個代碼函數參數。
上面兩種情況下，unt命令類似于n（next）和s（step）都只會停止在當前幀（或函數）。
當你想繼續執行并在當前源文件中更遠的地方停止時，請使用 unt。 你可以將其視為 n (next) 和 b (break) 的混合體，具體取決于是否傳遞行號參數。
在下面的示例中，有一個帶有循環的函數。 在這里，我們希望繼續執行代碼并在循環后停止，而不是單步執行循環的每次迭代或設置斷點，下面是文件codeexample4unt.py文件的內容：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
#!/usr/bin/env python3import osdef get_path(fname): """return file's path or empty string if no path.""" import pdb; pdb.set_trace() head, tail = os.path.split(fname) for char in tail: pass # check filename char return headfilename = __file__filename_path = get_path(filename)print(f'path = {filename_path}') |
以及命令下使用unt輸出如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
$ ./codeexample4unt.py > /code/codeexample4unt.py(9)get_path()-> head, tail = os.path.split(fname)(pdb) ll 6 def get_path(fname): 7 """return file's path or empty string if no path.""" 8 import pdb; pdb.set_trace() 9 -> head, tail = os.path.split(fname) 10 for char in tail: 11 pass # check filename char 12 return head(pdb) unt> /code/codeexample4unt.py(10)get_path()-> for char in tail:(pdb) > /code/codeexample4unt.py(11)get_path()-> pass # check filename char(pdb) > /code/codeexample4unt.py(12)get_path()-> return head(pdb) p char, tail('y', 'codeexample4unt.py') |
ll命令首先用于打印函數的源代碼，然后是 unt。 pdb 記得上次輸入的命令，所以我只是按 enter 重復 unt 命令。 這將繼續執行代碼，直到到達比當前行大的源代碼行。
請注意，在上面的控制臺輸出中，pdb 僅在第 10 行和第 11 行停止了一次。由于使用了 unt，因此僅在循環的第一次迭代中停止執行。 但是，循環的每次迭代都被執行。 這可以在輸出的最后一行進行驗證。 char 變量的值 'y' 等于 tail 值 'codeexample4unt.py' 中的最后一個字符。
6.顯示表達式
類似于打印表達式p和pp的功能，我們可以使用dispaly [expression]來告訴pdb來顯示一個表達的值，同樣適用undisplay [expression]來清楚一個表達式顯示，下面使用一些使用語法解釋：
下面是一個案例，代碼文件為codeexample4display.py，展示了一個循環的使用：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
|
$ ./codeexample4display.py > /code/codeexample4display.py(9)get_path()-> head, tail = os.path.split(fname)(pdb) ll 6 def get_path(fname): 7 """return file's path or empty string if no path.""" 8 import pdb; pdb.set_trace() 9 -> head, tail = os.path.split(fname) 10 for char in tail: 11 pass # check filename char 12 return head(pdb) b 11breakpoint 1 at /code/codeexample4display.py:11(pdb) c> /code/codeexample4display.py(11)get_path()-> pass # check filename char(pdb) display chardisplay char: 'e'(pdb) c> /code/codeexample4display.py(11)get_path()-> pass # check filename chardisplay char: 'x' [old: 'e'](pdb) > /code/codeexample4display.py(11)get_path()-> pass # check filename chardisplay char: 'a' [old: 'x'](pdb) > /code/codeexample4display.py(11)get_path()-> pass # check filename chardisplay char: 'm' [old: 'a'] |
在上面的輸出中，pdb 自動顯示了 char 變量的值，因為每次遇到斷點時，它的值都會發生變化。 有時這很有幫助并且正是你想要的，但還有另一種使用顯示的方法。
你可以多次輸入 display 以構建表達式監視列表。 這比 p 更容易使用。 添加你感興趣的所有表達式后，只需輸入 display 即可查看當前值：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
|
$ ./codeexample4display.py > /code/codeexample4display.py(9)get_path()-> head, tail = os.path.split(fname)(pdb) ll 6 def get_path(fname): 7 """return file's path or empty string if no path.""" 8 import pdb; pdb.set_trace() 9 -> head, tail = os.path.split(fname) 10 for char in tail: 11 pass # check filename char 12 return head(pdb) b 11breakpoint 1 at /code/codeexample4display.py:11(pdb) c> /code/codeexample4display.py(11)get_path()-> pass # check filename char(pdb) display chardisplay char: 'e'(pdb) display fnamedisplay fname: './codeexample4display.py'(pdb) display headdisplay head: '.'(pdb) display taildisplay tail: 'codeexample4display.py'(pdb) c> /code/codeexample4display.py(11)get_path()-> pass # check filename chardisplay char: 'x' [old: 'e'](pdb) displaycurrently displaying:char: 'x'fname: './codeexample4display.py'head: '.'tail: 'codeexample4display.py' |
7.python調用者id
在最后一節，我們會基于上述學習到的內容，來演示“call id”的功能使用。下面是案例代碼codeexample5.py的內容：
|
1
2
3
4
5
6
7
8
|
#!/usr/bin/env python3import fileutildef get_file_info(full_fname): file_path = fileutil.get_path(full_fname) return file_pathfilename = __file__filename_path = get_file_info(filename)print(f'path = {filename_path}') |
以及工具模塊fileutil.py文件內容：
|
1
2
3
4
5
6
|
def get_path(fname): """return file's path or empty string if no path.""" import os import pdb; pdb.set_trace() head, tail = os.path.split(fname) return head |
在這種情況下，假設有一個大型代碼庫，其中包含一個實用程序模塊 get_path() 中的函數，該函數使用無效輸入進行調用。 但是，它是從不同包中的許多地方調用的。
如何查看調用程序是誰？
使用命令w（where）來打印一個代碼棧序列，就是從低到上顯示所有堆棧：
|
1
2
3
4
5
6
7
8
9
10
11
|
$ ./codeexample5.py > /code/fileutil.py(5)get_path()-> head, tail = os.path.split(fname)(pdb) w /code/codeexample5.py(12)<module>()-> filename_path = get_file_info(filename) /code/codeexample5.py(7)get_file_info()-> file_path = fileutil.get_path(full_fname)> /code/fileutil.py(5)get_path()-> head, tail = os.path.split(fname)(pdb) |
如果這看起來令人困惑，或者你不確定堆棧跟蹤或幀是什么，請不要擔心。 我將在下面解釋這些術語。 這并不像聽起來那么困難。
由于最近的幀在底部，從那里開始并從下往上閱讀。 查看以 -> 開頭的行，但跳過第一個實例，因為 pdb.set_trace() 用于在函數 get_path() 中輸入 pdb。 在此示例中，調用函數 get_path() 的源代碼行是：
|
1
|
-> file_path = fileutil.get_path(full_fname) |
在每個 -> 上面的行包含文件名和代碼行數（在括號中），以及函數名稱，所以調用者就是：
|
1
2
|
/code/example5.py(7)get_file_info()-> file_path = fileutil.get_path(full_fname) |
顯然在這個簡單的樣例中，我們展示了如何查找函數調用者，但是想象一個大型應用程序，您在其中設置了一個帶有條件的斷點，以確定錯誤輸入值的來源，下面讓我們進一步深入。
什么是堆棧追蹤和棧幀內容？
堆棧跟蹤只是 python 為跟蹤函數調用而創建的所有幀的列表。 框架是 python 在調用函數時創建并在函數返回時刪除的數據結構。 堆棧只是在任何時間點的幀或函數調用的有序列表。 （函數調用）堆棧在應用程序的整個生命周期中隨著函數被調用然后返回而增長和縮小。打印時，這個有序的幀列表，即堆棧，稱為堆棧跟蹤。 你可以隨時通過輸入命令 w 來查看它，就像我們在上面找到調用者一樣。
當前棧幀什么意思？
將當前幀視為 pdb 已停止執行的當前函數。 換句話說，當前幀是你的應用程序當前暫停的位置，并用作 pdb 命令（如 p（打印））的“參考幀”。p 和其他命令將在需要時使用當前幀作為上下文。 在 p 的情況下，當前幀將用于查找和打印變量引用。當 pdb 打印堆棧跟蹤時，箭頭 > 表示當前幀。
怎么使用和切換棧幀？
你可以使用兩個命令 u（向上）和 d（向下）來更改當前幀。 與 p 結合使用，這允許你在任何幀中調用堆棧的任何點檢查應用程序中的變量和狀態。使用語法如下：
讓我們看一個使用 u 和 d 命令的例子。 在這種情況下，我們要檢查codeexample5.py 中函數 get_file_info() 的局部變量 full_fname。 為此，我們必須使用命令 u 將當前幀向上更改一級：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
$ ./codeexample5.py > /code/fileutil.py(5)get_path()-> head, tail = os.path.split(fname)(pdb) w /code/codeexample5.py(12)<module>()-> filename_path = get_file_info(filename) /code/codeexample5.py(7)get_file_info()-> file_path = fileutil.get_path(full_fname)> /code/fileutil.py(5)get_path()-> head, tail = os.path.split(fname)(pdb) u> /code/codeexample5.py(7)get_file_info()-> file_path = fileutil.get_path(full_fname)(pdb) p full_fname'./codeexample5.py'(pdb) d> /code/fileutil.py(5)get_path()-> head, tail = os.path.split(fname)(pdb) p fname'./codeexample5.py'(pdb) |
因為是在fileutil.py文件函數get_path()中設置的斷點程序pdb.set_trace()，所以當前幀被設置在此處，如下面所示：
|
1
|
> /code/fileutil.py(5)get_path() |
為了訪問和打印在codeexample5.py文件函數get_file_info()里的變量full_fname，命令u實現移動到前一個棧幀：
|
1
2
3
|
(pdb) u> /code/codeexample5.py(7)get_file_info()-> file_path = fileutil.get_path(full_fname) |
請注意，在上面 u 的輸出中，pdb 在第一行的開頭打印了箭頭 >。 這是 pdb，讓你知道幀已更改，并且此源位置現在是當前幀。 現在可以訪問變量 full_fname。 另外，重要的是要意識到第 2 行以 -> 開頭的源代碼行已被執行。 由于幀被移到堆棧上，fileutil.get_path() 已被調用。 使用 u，我們將堆棧向上移動（從某種意義上說，回到過去）到調用 fileutil.get_path() 的函數 codeexample5.get_file_info()。
繼續這個例子，在打印 full_fname 之后，使用 d 將當前幀移動到其原始位置，并打印 get_path() 中的局部變量 fname。如果我們愿意，我們可以通過將 count 參數傳遞給 u 或 d 來一次移動多個幀。 例如，我們可以通過輸入 u 2 移動到 codeexample5.py 中的模塊級別：
|
1
2
3
4
5
6
7
8
9
|
$ ./codeexample5.py > /code/fileutil.py(5)get_path()-> head, tail = os.path.split(fname)(pdb) u 2> /code/codeexample5.py(12)<module>()-> filename_path = get_file_info(filename)(pdb) p filename'./codeexample5.py'(pdb) |
當你調試和思考許多不同的事情時，很容易忘記你在哪里。 請記住，你始終可以使用恰當命名的命令 w (where) 來查看執行暫停的位置以及當前幀是什么。
8.總結
本篇教程中，我們主要講解了pdb中一些基本常用的內容：
打印表達式使用n（next）和s（step）命令調試代碼斷點使用使用unt（until）來繼續執行代碼顯示表達式查找一個函數的調用者
最后，希望這篇教程對你帶來幫助，本篇教程中對應的代碼可以在代碼倉庫中下載：https://github.com/1311440131/pdb_basic_tutorial
到此這篇關于如何使用pdb進行python調試的文章就介紹到這了,更多相關pdb python調試內容請搜索服務器之家以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持服務器之家！
原文鏈接：https://www.cnblogs.com/zjz-819823900/p/14954694.html
