求你了，别再用 print 调试代码了
“
閱讀本文大概需要 5 分鐘。
”大家好
對(duì)于每個(gè)程序開發(fā)者來(lái)說，調(diào)試幾乎是必備技能。
代碼寫到一半卡住了，不知道這個(gè)函數(shù)執(zhí)行完的返回結(jié)果是怎樣的？調(diào)試一下看看
代碼運(yùn)行到一半報(bào)錯(cuò)了，什么情況？怎么跟預(yù)期的不一樣？調(diào)試一下看看
調(diào)試的方法多種多樣，不同的調(diào)試方法適合不同的場(chǎng)景和人群。
如果你是剛接觸編程的小萌新，對(duì)很多工具的使用還不是很熟練，那么 print 和 log 大法好
如果你在本地（Win或者M(jìn)ac）電腦上開發(fā)，那么 IDE 的圖形化界面調(diào)試無(wú)疑是最適合的；
如果你在服務(wù)器上排查BUG，那么使用 PDB 進(jìn)行無(wú)圖形界面的調(diào)試應(yīng)該是首選。
如果你要在本地進(jìn)行開發(fā)，但是項(xiàng)目的進(jìn)行需要依賴復(fù)雜的服務(wù)器環(huán)境，那么可以了解下 PyCharm 的遠(yuǎn)程調(diào)試。
除了以上，今天再給你介紹一款非常好用的調(diào)試工具，它能在一些場(chǎng)景下，大幅度提高調(diào)試的效率， 那就是 PySnooper，它在 Github 上已經(jīng)收到了 13k 的 star，獲得大家的一致好評(píng)。
有了這個(gè)工具后，就算是小萌新也可以直接無(wú)門檻上手，從此與 print 說再見~
1. 快速安裝
執(zhí)行下面這些命令進(jìn)行安裝 PySnooper
$?python3?-m?pip?install?pysnooper#?或者 $?conda?install?-c?conda-forge?pysnooper#?或者 $?yay?-S?python-pysnooper2. 簡(jiǎn)單案例
下面這段代碼，定義了一個(gè) demo_func 的函數(shù)，在里面生成一個(gè) profile 的字典變量，然后去更新它，最后返回。
代碼本身沒有什么實(shí)際意義，但是用來(lái)演示 PySnooper 已經(jīng)足夠。
import?pysnooper@pysnooper.snoop() def?demo_func():profile?=?{}profile["name"]?=?"寫代碼的明哥"profile["age"]?=?27profile["gender"]?=?"male"return?profiledef?main():profile?=?demo_func()main()現(xiàn)在我使用終端命令行的方式來(lái)運(yùn)行它
[root@iswbm?~]#?python3?demo.py? Source?path:...?demo.py 17:52:49.624943?call?????????4?def?demo_func(): 17:52:49.625124?line?????????5?????profile?=?{} New?var:.......?profile?=?{} 17:52:49.625156?line?????????6?????profile["name"]?=?"寫代碼的明哥" Modified?var:..?profile?=?{'name':?'寫代碼的明哥'} 17:52:49.625207?line?????????7?????profile["age"]?=?27 Modified?var:..?profile?=?{'name':?'寫代碼的明哥',?'age':?27} 17:52:49.625254?line?????????8?????profile["gender"]?=?"male" Modified?var:..?profile?=?{'name':?'寫代碼的明哥',?'age':?27,?'gender':?'male'} 17:52:49.625306?line????????10?????return?profile 17:52:49.625344?return??????10?????return?profile Return?value:..?{'name':?'寫代碼的明哥',?'age':?27,?'gender':?'male'} Elapsed?time:?00:00:00.000486可以看到 PySnooper 把函數(shù)運(yùn)行的過程全部記錄了下來(lái)，包括：
代碼的片段、行號(hào)等信息，以及每一行代碼是何時(shí)調(diào)用的？
函數(shù)內(nèi)局部變量的值如何變化的？何時(shí)新增了變量，何時(shí)修改了變量。
函數(shù)的返回值是什么？
運(yùn)行函數(shù)消耗了多少時(shí)間？
而作為開發(fā)者，要得到這些如此詳細(xì)的調(diào)試信息，你需要做的非常簡(jiǎn)單，只要給你想要調(diào)試的函數(shù)上帶上一頂帽子（裝飾器） -- @pysnooper.snoop() 即可。
3. 詳細(xì)使用
2.1 重定向到日志文件
@pysnooper.snoop() 不加任何參數(shù)時(shí)，會(huì)默認(rèn)將調(diào)試的信息輸出到標(biāo)準(zhǔn)輸出。
對(duì)于單次調(diào)試就能解決的 BUG ，這樣沒有什么問題，但是有一些 BUG 只有在特定的場(chǎng)景下才會(huì)出現(xiàn)，需要你把程序放在后面跑個(gè)一段時(shí)間才能復(fù)現(xiàn)。
這種情況下，你可以將調(diào)試信息重定向輸出到某一日志文件中，方便追溯排查。
@pysnooper.snoop(output='/var/log/debug.log') def?demo_func():...2.2 跟蹤非局部變量值
PySnooper 是以函數(shù)為單位進(jìn)行調(diào)試的，它默認(rèn)只會(huì)跟蹤函數(shù)體內(nèi)的局部變量，若想跟蹤全局變量，可以給 pysnooper.snoop() 加上 watch 參數(shù)
out?=?{"foo":?"bar"}@pysnooper.snoop(watch=('out["foo"]')) def?demo_func():...如此一來(lái)，PySnooper 會(huì)在 out["foo"] 值有變化時(shí)，也將其打印出來(lái)
watch 參數(shù)，接收一個(gè)可迭代對(duì)象（可以是list 或者 tuple），里面的元素為字符串表達(dá)式，什么意思呢？看下面例子就知道了
@pysnooper.snoop(watch=('out["foo"]',?'foo.bar',?'self.foo["bar"]')) def?demo_func():...和 watch 相對(duì)的，pysnooper.snoop() 還可以接收一個(gè)函數(shù) watch_explode，表示除了這幾個(gè)參數(shù)外的其他所有全局變量都監(jiān)控。
@pysnooper.snoop(watch_explode=('foo',?'bar')) def?demo_func():...2.3 設(shè)置跟蹤函數(shù)的深度
當(dāng)你使用 PySnooper 調(diào)試某個(gè)函數(shù)時(shí)，若該函數(shù)中還調(diào)用了其他函數(shù)，PySnooper 是不會(huì)傻傻的跟蹤進(jìn)去的。
如果你想繼續(xù)跟蹤該函數(shù)中調(diào)用的其他函數(shù)，可以通過指定 depth 參數(shù)來(lái)設(shè)置跟蹤深度（不指定的話默認(rèn)為 1）。
@pysnooper.snoop(depth=2) def?demo_func():...2.4 設(shè)置調(diào)試日志的前綴
當(dāng)你在使用 PySnooper 跟蹤多個(gè)函數(shù)時(shí)，調(diào)試的日志會(huì)顯得雜亂無(wú)章，不方便查看。
在這種情況下，PySnooper 提供了一個(gè)參數(shù)，方便你為不同的函數(shù)設(shè)置不同的標(biāo)志，方便你在查看日志時(shí)進(jìn)行區(qū)分。
@pysnooper.snoop(output="/var/log/debug.log",?prefix="demo_func:?") def?demo_func():...效果如下
2.5 設(shè)置最大的輸出長(zhǎng)度
默認(rèn)情況下，PySnooper 輸出的變量和異常信息，如果超過 100 個(gè)字符，被會(huì)截?cái)酁?100 個(gè)字符。
當(dāng)然你也可以通過指定參數(shù) 進(jìn)行修改
@pysnooper.snoop(max_variable_length=200） def?demo_func():...您也可以使用max_variable_length=None它從不截?cái)嗨鼈儭?/p>@pysnooper.snoop(max_variable_length=None） def?demo_func():...
2.6 支持多線程調(diào)試模式
PySnooper 同樣支持多線程的調(diào)試，通過設(shè)置參數(shù) thread_info=True，它就會(huì)在日志中打印出是在哪個(gè)線程對(duì)變量進(jìn)行的修改。
@pysnooper.snoop(thread_info=True) def?demo_func():...效果如下
2.7 自定義對(duì)象的格式輸出
pysnooper.snoop() 函數(shù)有一個(gè)參數(shù)是 custom_repr，它接收一個(gè)元組對(duì)象。
在這個(gè)元組里，你可以指定特定類型的對(duì)象以特定格式進(jìn)行輸出。
這邊我舉個(gè)例子。
假如我要跟蹤 person 這個(gè) Person 類型的對(duì)象，由于它不是常規(guī)的 Python 基礎(chǔ)類型，PySnooper 是無(wú)法正常輸出它的信息的。
因此我在 pysnooper.snoop() 函數(shù)中設(shè)置了 custom_repr 參數(shù)，該參數(shù)的第一個(gè)元素為 Person，第二個(gè)元素為 print_persion_obj 函數(shù)。
PySnooper 在打印對(duì)象的調(diào)試信息時(shí)，會(huì)逐個(gè)判斷它是否是 Person 類型的對(duì)象，若是，就將該對(duì)象傳入 print_persion_obj 函數(shù)中，由該函數(shù)來(lái)決定如何顯示這個(gè)對(duì)象的信息。
class?Person:passdef?print_person_obj(obj):return?f"<Person?{obj.name}?{obj.age}?{obj.gender}>"@pysnooper.snoop(custom_repr=(Person,?print_person_obj)) def?demo_func():...完整的代碼如下
import?pysnooperclass?Person:passdef?print_person_obj(obj):return?f"<Person?{obj.name}?{obj.age}?{obj.gender}>"@pysnooper.snoop(custom_repr=(Person,?print_person_obj)) def?demo_func():person?=?Person()person.name?=?"寫代碼的明哥"person.age?=?27person.gender?=?"male"return?persondef?main():profile?=?demo_func()main()運(yùn)行一下，觀察一下效果。
如果你要自定義格式輸出的有很多個(gè)類型，那么 custom_repr 參數(shù)的值可以這么寫
@pysnooper.snoop(custom_repr=((Person,?print_person_obj),?(numpy.ndarray,?print_ndarray))) def?demo_func():...還有一點(diǎn)我提醒一下，元組的第一個(gè)元素可以是類型（如類名Person 或者其他基礎(chǔ)類型 list等），也可以是一個(gè)判斷對(duì)象類型的函數(shù)。
也就是說，下面三種寫法是等價(jià)的。
#?【第一種寫法】 @pysnooper.snoop(custom_repr=(Person,?print_persion_obj)) def?demo_func():...#?【第二種寫法】 def?is_persion_obj(obj):return?isinstance(obj,?Person)@pysnooper.snoop(custom_repr=(is_persion_obj,?print_persion_obj)) def?demo_func():...#?【第三種寫法】 @pysnooper.snoop(custom_repr=(lambda?obj:?isinstance(obj,?Person),?print_persion_obj)) def?demo_func():...以上就是今天給大家介紹的一款調(diào)試神器（PySnooper） 的詳細(xì)使用手冊(cè)，是不是覺得還不錯(cuò)？
如果你還有其他關(guān)于調(diào)試的技巧，可以留言區(qū)分享出來(lái)，一起學(xué)習(xí)一下~
由于微信平臺(tái)算法改版，公號(hào)內(nèi)容將不再以時(shí)間排序展示，如果大家想第一時(shí)間看到我們的推送，強(qiáng)烈建議星標(biāo)我們和給我們多點(diǎn)點(diǎn)【在看】。星標(biāo)具體步驟為：
總結(jié)
以上是生活随笔為你收集整理的求你了，别再用 print 调试代码了的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 你已经是个成熟的985大学了，请不要在大
- 下一篇： 如何高效学Python？好用的爬虫工具又