天天看點

Python學習 - 常用子產品 - debug調試(pdb)目錄使用背景使用介紹使用示例

Python學習 - 常用子產品 - debug調試(pdb)目錄使用背景使用介紹使用示例

目錄

  • 使用背景
  • 使用介紹
  • 使用示例

使用背景

首先,介紹一下 pdb 調試,pdb 是 python 的一個内置子產品,用于指令行來調試 Python 代碼。或許你會說,現在用 Pycharm 等編輯器來調試代碼很友善,為啥要用指令行呢?這個問題,我曾經也這麼想,直到有一次,代碼必須要在 Linux 系統上跑(現在 Pycharm 也可以遠端調試代碼了,我們先不說這個)

使用介紹

如果你有C++代碼開發經驗,你一定使用過gdb進行c++代碼調試。其實pdb在使用方法上甚至常用指令上都借用了gdb。

如何添加斷點?

說到 debug,肯定是要添加斷點的,這裡有兩種方式添加斷點:

  • 在想要斷點代碼後添加 一行
pdb.set_trace()
      

若是使用這種方式,直接運作 Python 檔案即可進入斷點調試。

  • 用指令行來添加斷點
b line_number(代碼行數)
      

若是使用這種方式,需要 python -m pdb xxx.py 來啟動斷點調試。

常用指令

先簡單介紹一下使用指令,這裡不用記住,等用到的時候回來查就行。

  • 1 進入指令行Debug模式,python -m pdb xxx.py
  • 2 h:(help)幫助
  • 3 w:(where)列印目前執行堆棧
  • 4 d:(down)執行跳轉到在目前堆棧的深一層(個人沒覺得有什麼用處)
  • 5 u:(up)執行跳轉到目前堆棧的上一層
  • 6 b:(break)添加斷點
b 列出目前所有斷點,和斷點執行到統計次數
b line_no:目前腳本的line_no行添加斷點
b filename:line_no:腳本filename的line_no行添加斷點
b function:在函數function的第一條可執行語句處添加斷點
      
  • 7 tbreak:(temporary break)臨時斷點
在第一次執行到這個斷點之後,就自動删除這個斷點,用法和b一樣
      
  • 8 cl:(clear)清除斷點
cl 清除所有斷點
cl bpnumber1 bpnumber2... 清除斷點号為bpnumber1,bpnumber2...的斷點
cl lineno 清除目前腳本lineno行的斷點
cl filename:line_no 清除腳本filename的line_no行的斷點
      
  • 9 disable:停用斷點,參數為bpnumber,和cl的差別是,斷點依然存在,隻是不啟用
  • 10 enable:激活斷點,參數為bpnumber
  • 11 s:(step)執行下一條指令
如果本句是函數調用,則s會執行到函數的第一句
      
  • 12 n:(next)執行下一條語句
如果本句是函數調用,則執行函數,接着執行目前執行語句的下一條。
      
  • 13 r:(return)執行目前運作函數到結束
  • 14 c:(continue)繼續執行,直到遇到下一條斷點
  • 15 l:(list)列出源碼
l 列出目前執行語句周圍11條代碼
l first 列出first行周圍11條代碼
l first second 列出first--second範圍的代碼,如果second<first,second将被解析為行數
      
  • 16 a:(args)列出目前執行函數的函數
  • 17 p expression:(print)輸出expression的值
  • 18 pp expression:好看一點的p expression
  • 19 run:重新啟動debug,相當于restart
  • 20 q:(quit)退出debug
  • 21 j lineno:(jump)設定下條執行的語句函數
隻能在堆棧的最底層跳轉,向後重新執行,向前可直接執行到行号
      
  • 22)unt:(until)執行到下一行(跳出循環),或者目前堆棧結束
  • 23)condition bpnumber conditon,給斷點設定條件,當參數condition傳回True的時候bpnumber斷點有效,否則bpnumber斷點無效
Python學習 - 常用子產品 - debug調試(pdb)目錄使用背景使用介紹使用示例

使用示例

為了驗證一下 pdb 的用法,我寫了個簡單的 Python 代碼,如下:
__author__ = 'zone'
import pdb
class MyScrapy:
 urls = []
 def start_url(self, urls):
 pdb.set_trace()
 for url in urls:
 print(url)
 self.urls.append(url)
 def parse(self):
 pdb.set_trace()
 for url in self.urls:
 result = self.request_something(url)
 def request_something(self, url):
 print('requesting...')
 data = '''<!DOCTYPE html>
<html >
<head>
 <meta charset="UTF-8">
 <title>Title</title>
</head>
<body>
</body>
</html>'''
 return data
scrapy= MyScrapy()
scrapy.start_url(["http://www.zone7.cn", "http://www.zone7.cn", "http://www.zone7.cn", "http://www.zone7.cn", ])
scrapy.parse()
      

運作執行個體:(這裡為了友善大家閱讀,我添加了中文注釋,實際運作時不會有注釋的)

D:\work\venv\Scripts\python.exe D:/work_test/test/pdb_test/pdb_test.py
> d:\work_test\test\pdb_test\pdb_test.py(11)start_url()
-> for url in urls:
(Pdb) n 注釋:n(next)執行下一步
> d:\work_test\test\pdb_test\pdb_test.py(12)start_url()
-> print(url)
(Pdb) l 注釋: l(list)列出目前代碼
 7 urls = []
 8 
 9 def start_url(self, urls):
 10 pdb.set_trace()
 11 for url in urls:
 12 -> print(url)
 13 self.urls.append(url)
 14 
 15 def parse(self):
 16 pdb.set_trace()
 17 for url in self.urls:
(Pdb) c 注釋:c(continue),繼續執行,知道遇到下一個斷點
http://www.zone7.cn
http://www.zone7.cn
http://www.zone7.cn
http://www.zone7.cn
> d:\work_test\test\pdb_test\pdb_test.py(17)parse()
-> for url in self.urls:
(Pdb) n 注釋:n(next)執行下一步
> d:\work_test\test\pdb_test\pdb_test.py(18)parse()
-> result = self.request_something(url)
(Pdb) l 注釋: l(list)列出目前代碼
 13 self.urls.append(url)
 14 
 15 def parse(self):
 16 pdb.set_trace()
 17 for url in self.urls:
 18 -> result = self.request_something(url)
 19 
 20 def request_something(self, url):
 21 print('requesting...')
 22 data = '''<!DOCTYPE html>
 23 <html >
(Pdb) s 注釋: s(step)這裡是進入 request_something() 函數的意思
--Call--
> d:\work_test\test\pdb_test\pdb_test.py(20)request_something()
-> def request_something(self, url):
(Pdb) n 注釋:n(next)執行下一步
> d:\work_test\test\pdb_test\pdb_test.py(21)request_something()
-> print('requesting...')
(Pdb) l 注釋: l(list)列出目前代碼
 16 pdb.set_trace()
 17 for url in self.urls:
 18 result = self.request_something(url)
 19 
 20 def request_something(self, url):
 21 -> print('requesting...')
 22 data = '''<!DOCTYPE html>
 23 <html >
 24 <head>
 25 <meta charset="UTF-8">
 26 <title>Title</title>
(Pdb) p url 注釋:p(print)列印出 url 變量的資料
'http://www.zone7.cn'
(Pdb) n 注釋:n(next)執行下一步
requesting...
> d:\work_test\test\pdb_test\pdb_test.py(31)request_something()
-> </html>'''
(Pdb) p data 注釋:p(print)列印出指定變量的資料,這裡由于指派還沒完成,是以報錯
*** NameError: name 'data' is not defined
(Pdb) n 注釋:n(next)執行下一步
> d:\work_test\test\pdb_test\pdb_test.py(32)request_something()
-> return data
(Pdb) p data 注釋:p(print)列印出指定變量的資料
'<!DOCTYPE html>\n<html >\n<head>\n <meta charset="UTF-8">\n <title>Title</title>\n</head>\n<body>\n\n</body>\n</html>'
(Pdb) q 注釋:q(quit)退出
      

總結

按照上面的例子一套下來,基本的用法就可以學會了,關鍵還是得自己多實踐,今天就寫到這,還想寫一篇關于性能調試的文章,不知道這兩天有沒有時間了。