PySnooper – 永遠(yuǎn)不要使用print進(jìn)行調(diào)試

PySnooper?是一個(gè)非常方便的調(diào)試器。如果您正在試圖弄清楚為什么您的Python代碼沒有按照您的預(yù)期去做,您會(huì)希望使用具有斷點(diǎn)和監(jiān)視功能的成熟Debug工具,但是許多Debug工具配置起來非常麻煩。
現(xiàn)在,有了PySnooper,您并不需要配置那么復(fù)雜的Debug工具,就能夠完成對(duì)整個(gè)代碼的分析。它能告訴您哪些代碼正在運(yùn)行,以及局部變量的值是什么。
其實(shí),PySnooper 就是替代了一行一行print的重復(fù)性工作,給你的代碼一個(gè)pysnooper裝飾器,它能自動(dòng)識(shí)別到語(yǔ)句和變量并將其值print出來:
import?pysnooper
@pysnooper.snoop()
def number_to_bits(number):
????if?number:
????????bits = []
????????while?number:
????????????number, remainder = divmod(number, 2)
????????????bits.insert(0, remainder)
????????return?bits
????else:
????????return?[0]
number_to_bits(6)效果如下:
Source path:... 1.py
Starting var:.. number = 6
23:03:35.990701 call?????????4?def?number_to_bits(number):
23:03:35.991699?line 5?????if?number:
23:03:35.991699?line 6?????????bits = []
New?var:....... bits = []
23:03:35.991699?line 7?????????while?number:
23:03:35.991699?line 8?????????????number, remainder?= divmod(number, 2)
Modified var:.. number?= 3
New?var:....... remainder?= 0
23:03:35.991699?line 9?????????????bits.insert(0, remainder)
Modified var:.. bits = [0]
23:03:36.004664?line 7?????????while?number:
23:03:36.005661?line 8?????????????number, remainder?= divmod(number, 2)
Modified var:.. number?= 1
Modified var:.. remainder?= 1
23:03:36.005661?line 9?????????????bits.insert(0, remainder)
Modified var:.. bits = [1, 0]
23:03:36.007657?line 7?????????while?number:
23:03:36.007657?line 8?????????????number, remainder?= divmod(number, 2)
Modified var:.. number?= 0
23:03:36.008655?line 9?????????????bits.insert(0, remainder)
Modified var:.. bits = [1, 1, 0]
23:03:36.008655?line 7?????????while?number:
23:03:36.009651?line 10?????????return?bits
23:03:36.009651?return??????10?????????return?bits
Return?value:.. [1, 1, 0]
Elapsed time: 00:00:00.020945可以看到,它將每一行變量的值都輸出到屏幕上,方便你調(diào)試代碼。
僅僅需要寫一行代碼—使用裝飾器就可以實(shí)現(xiàn)這個(gè)方便的調(diào)試功能,比起一行行寫print,這可方便多了。
0.安裝模塊
使用這個(gè)模塊,你只需要使用Pip安裝PySnooper:
pip install?pysnooper接下來講講這個(gè)模塊其他好用的功能:
1.支持日志文件
如果你覺得print到屏幕上不方便,還可以將其輸出到log文件中,你只需要將裝飾器那一行改為:
@pysnooper.snoop('/my/log/file.log')2.讀取局外變量或其他表達(dá)式
如果你想讀取在裝飾器作用范圍以外的變量或者表達(dá)式的值,還可以使用watch參數(shù):
@pysnooper.snoop(watch=('foo.bar', 'self.x["whatever"]'))3.上下文形式的調(diào)試
沒錯(cuò),裝飾器有限定的使用條件,使用起來比較局限,因此pysnooper還支持使用 with 的上下文形式:
import?pysnooper
import?random
def?foo():
????lst = []
????for?i in?range(10):
????????lst.append(random.randrange(1, 1000))
????with?pysnooper.snoop():
????????lower = min(lst)
????????upper = max(lst)
????????mid = (lower + upper) / 2
????????print(lower, mid, upper)
foo()效果如下,只有上下文里的代碼才會(huì)被調(diào)試出來:
New?var:....... i = 9
New?var:....... lst = [681, 267, 74, 832, 284, 678, ...]
09:37:35.881721?line 10?????????lower = min(lst)
New?var:....... lower = 74
09:37:35.882137?line 11?????????upper = max(lst)
New?var:....... upper = 832
09:37:35.882304?line 12?????????mid = (lower + upper) / 2
74?453.0?832
New?var:....... mid = 453.0
09:37:35.882486?line 13?????????print(lower, mid, upper)
Elapsed time: 00:00:00.000344當(dāng)我們只需要調(diào)試部分代碼的時(shí)候,這個(gè)上下文形式的調(diào)試方法非常方便。
此外,PySnooper還有許多更強(qiáng)大的用法,大家可以看他們的高級(jí)使用文檔:
https://github.com/cool-RR/PySnooper/blob/master/ADVANCED_USAGE.md


