還在用print()語句來調試Python代碼？快停止吧
用print()的缺點
我就是使用print()語句調試代碼的人之一。有些時候，如果代碼很長，那么就會有更多的打印，需要使用多個符號來相互區分。
看看下面的代碼片段。(本博客中的代碼片段，遵循Python 3.7的語法)
- print(style_dict,"{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{}}}}}}}}}}}}}}}}}}}}}}}}}}]]]]]]]]]]]]]]]]]]]")
- # Adding into a dictionary
- res_dct = {style_dict[i]: style_dict[i + 1] for i in range(0, len(style_dict), 2)}
- res_dist={res_dct['Email Address']:{style_dict[i]: style_dict[i + 1] for i in range(0, len(style_dict), 2)}}
- print(res_dist,"+++++++++++++++++++++++++++++++++++++++++++++++++++++")
- recon_dict = res_dct
- print(recon_dict,"---------------------------------------------------")
- # Removing space so that data can be transferred to HTML fields
- recon_dict = {x.translate({32: None}): y
- for x, y in list(recon_dict.items())}
- print("##################################################")
- print(recon_dict)
- print("################################################")
- # Converting to JSON
- r = json.dumps(recon_dict)
- print("$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$")
- print(r)
- loaded_json = json.loads(r)
- print("WWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWwwwwww")
- print("******************************************************")
- print(loaded_json)
在這里，我試圖將一個字典添加到一個JSON文件。由于一些錯誤，我不得不使用那么多帶有不同符號的打印語句進行調試。
但是隨著代碼變得越來越大，不同的模塊和不同的類調用其他模塊或類中的不同定義，這不是一個好的選擇。
讓我們看看這種方法的一些缺點:
- 隨著代碼的增加，很難在代碼遍歷的每個模塊、類或定義中使用print語句。
- 甚至在我們注意到錯誤之前，代碼就已經執行并進入下一步。
- 等到一個漫長的執行完成后再查找并修復。
- 回到大量的日志中去搜索我們在print語句中給出的正確符號并匹配它們是很乏味的。
一個簡單的轉變
除了使用Python提供給我們的強大武器“pdb模塊”，我們不需要做任何事情。這個模塊幫助我們有效地調試。
什么是pdb(python調試器)?
pdb是一個交互式shell，有助于調試python代碼。它幫助我們一步一步地進入代碼、暫停、檢查狀態并繼續下一行代碼或繼續執行。
調用pdb的一些方法：
在這里，我們將介紹三種調用pdb的方法。
- Postmortem：如果您想在程序級別進行調試，請使用此功能。
- Inline pdb：適用比3.7版本更早的版本
- breakpoint()：對于版本3.7或更高的版本
postmortem
讓我們用一個簡單的程序來理解。
- def add_num(listA,num):
- sum=[]
- for i in listA:
- sum.append(i*num)
- return sum
- listA = [2, 4, 6, 8]
- num=10
- result=add_num(listA,num)
- print(result)
在這里，def add_num應該將num變量的值添加到名為listA的列表中的每個元素中，在列表sum中存儲新值，并返回列表sum。
通過執行下面所示的python文件，將調用pdb，
- python -m pdb debug_add.py
這將進入pdb模式，并在第一行代碼處停止。
- (venv) C:\Users\PycharmProjects\>python -m pdb debug_add.py
- > c:\users\pycharmprojects\debug_add.py(2)<module>()
- -> def add_num(listA,num):
- (Pdb)
任何時候，如果您需要調試器的幫助，請使用' h '(幫助)，它列出了所有的選項。
- (Pdb) hDocumented commands (type help <topic>):
- ========================================
- EOF c d h list q rv undisplay
- a cl debug help ll quit s unt
- alias clear disable ignore longlist r source until
- args commands display interact n restart step up
- b condition down j next return tbreak w
- break cont enable jump p retval u whatis
- bt continue exit l pp run unalias whereMiscellaneous help topics:
- ==========================
- exec pdb
對特定選項的幫助，
- (Pdb) h debug
- debug code
- Enter a recursive debugger that steps through the code
- argument (which is an arbitrary expression or statement to
- be executed in the current environment).
返回程序，使用選項' n ' (next)進入執行的下一個步驟。
- > c:\users\pycharmprojects\debug_add.py(2)<module>()
- -> def add_num(listA,num):
- (Pdb) n
- > c:\users\prade\pycharmprojects\jobportal\debug_add.py(8)<module>()
- -> listA = [2, 4, 6, 8]
在這里，我們可以通過給出如下變量名稱來檢查變量的值，
- (Pdb) listA
- *** NameError: name 'listA' is not defined
- (Pdb)
- *** NameError: name 'listA' is not defined
我們到達listA =[2,4,6,8]這一行，但我們仍然沒有執行，所以它說listA未定義。如果您觀察到我們在任何時候按enter鍵，前面的選項就會像上面那樣執行。
現在按' n '向前移動并檢查listA變量。
- (Pdb) n
- > c:\users\pycharmprojects\debug_add.py(9)<module>()
- -> num=10
- (Pdb) listA
- [2, 4, 6, 8]
- (Pdb)
要檢查我們所在的代碼行，請使用選項' l ' (line)。箭頭標記指向我們所在的行，EOF表示文件結束。
- (Pdb) l
- 4 for i in listA:
- 5 sum.append(i*num)
- 6 return sum
- 7
- 8 listA = [2, 4, 6, 8]
- 9 -> num=10
- 10 result=add_num(listA,num)
- 11 print(result)
- [EOF]
- (Pdb)
要退出調試器，我們使用選項' q ' (quit)。
- (Pdb) q
- (venv) C:\Users\PycharmProjects\>
使用postmortem方法的另一種方法是僅在遇到異常時停止執行，因為使用-c繼續使用-m pdb
- python -m pdb -c continue debug_add.py
Breakpoint()
從Python 3.7開始，引入了breakpoint()，這有助于調試Python代碼，而不必顯式地導入模塊pdb并調用pdb.set_trace()。breakpoint()為我們完成所有這些工作，并在控制臺中打開PDB調試器。
現在，讓我們在沒有任何斷點的情況下執行上述代碼，并在遇到任何錯誤時進行調試。
- def add_num(listA,num):
- sum=[]
- for i in listA:
- sum.append(i*num)
- return sum
- listA = [2, 4, 6, 8]
- num=10
- result=add_num(listA,num)
- print(result)
輸出：
- C:\Users\PycharmProjects\venv\Scripts\python.exe C:/Users/PycharmProjects/debug_add.py
- [20, 40, 60, 80]Process finished with exit code 0
代碼塊的任務是將num(10)添加到列表中的每個元素中，并返回新的列表。
- 預期結果為[12,14,16,18]
- 實際結果為[20,40,60,80]
現在讓我們使用breakpoint()武器來調試和修復代碼。
放置斷點()的位置取決于懷疑錯誤的位置。在本例中，我們在它進入add_num()定義之前放置它。
- def add_num(listA,num):
- sum=[]
- for i in listA:
- sum.append(i*num)
- return sum
- listA = [2, 4, 6, 8]
- num=10
- breakpoint()
- result=add_num(listA,num)
- print(result)
輸出：
- > c:\users\pycharmprojects\debug_add.py(11)<module>()
- -> result=add_num(listA,num)
- (Pdb) n
- > c:\users\pycharmprojects\debug_add.py(12)<module>()
- -> print(result)
- (Pdb) n
- [20, 40, 60, 80]
- — Return —
- > c:\users\prade\pycharmprojects\jobportal\debug_add.py(12)<module>()->None
- -> print(result)
- (Pdb)
選項' n ' (next)用于在任何定義上移動到下一行或步驟。但在本例中，我們需要進入定義，為此我們將使用選項' s ' (step)。
在粗體文本下面是用來突出顯示所使用的選項及其解釋。
- > c:\users\prade\pycharmprojects\jobportal\debug_add.py(11)<module>()
- -> result=add_num(listA,num)
- (Pdb) s <----- Step into def add_num
- --Call--
- > c:\users\prade\pycharmprojects\jobportal\debug_add.py(2)add_num()
- -> def add_num(listA,num):
- (Pdb) s <---- stepped inside def add_num
- > c:\users\prade\pycharmprojects\jobportal\debug_add.py(3)add_num()
- -> sum=[]
- (Pdb) n <--- inside a def feel free to use 'n'
- > c:\users\prade\pycharmprojects\jobportal\debug_add.py(4)add_num()
- -> for i in listA:
- (Pdb) n
- > c:\users\prade\pycharmprojects\jobportal\debug_add.py(5)add_num()
- -> sum.append(i*num)
- (Pdb) n
- > c:\users\prade\pycharmprojects\jobportal\debug_add.py(4)add_num()
- -> for i in listA:
- (Pdb) sum <-- examine sum value
- [20] <--- 2+10 =12 not 20,oops we used '*'instead of '+' in
- appending to list sum,CAUGHT IT!
- (Pdb) i <-- so, examine i
- 2
- (Pdb) sum.append(i+num) <-- try adding + in the expression
- (Pdb) sum
- [20, 12] <-- PERFECT, FIXED IT!
- (Pdb) u <-- used to skip other iterations of for loop.
- > c:\users\prade\pycharmprojects\jobportal\debug_add.py(11)<module>()
- -> result=add_num(listA,num)
- (Pdb) c <-- used to continue with execution
- [20, 12, 40, 60, 80] <--not a right answer but found a fix.Process finished with exit code 0
上面，在for循環的第一次迭代之后，我們檢查了sum值，結果顯示為20，而不是12。我們差點在這里發現我們用*(乘法)代替了+(加法)因此，我們向前邁出一步，檢查' i '在那一點上是2，并嘗試了sum.append(i+num)。然后檢驗和，得到12是最近添加的元素。因此我們得到了修復，因此我們使用選項' u ' (until)跳過了for循環的剩余迭代。然后它移動到循環后的下一步。這里我們使用' c ' (continue)來繼續執行，結果就結束了。
現在修復,
- def add_num(listA,num):
- sum=[]
- for i in listA:
- sum.append(i+num)
- return sum
- listA = [2, 4, 6, 8]
- num=10
- result=add_num(listA,num)
- print(result)
輸出：
- C:\Users\PycharmProjects\venv\Scripts\python.exe C:/Users/PycharmProjects/debug_add.py
- [12, 14, 16, 18]Process finished with exit code 0
沒有亂七八糟的print()語句，這看起來很簡單。
