點擊藍色「Python空間」關注我丫python
加個「星標」，天天一塊兒快樂的學習web
對於每一個程序開發者來講，調試幾乎是必備技能。編程
代碼寫到一半卡住了，不知道這個函數執行完的返回結果是怎樣的？調試一下看看服務器
代碼運行到一半報錯了，什麼狀況？怎麼跟預期的不同？調試一下看看微信
調試的方法多種多樣，不一樣的調試方法適合不一樣的場景和人羣。多線程
若是你是剛接觸編程的小萌新，對不少工具的使用還不是很熟練，那麼 print 和 log 大法好app
若是你在本地（Win或者Mac）電腦上開發，那麼 IDE 的圖形化界面調試無疑是最適合的；編輯器
若是你在服務器上排查BUG，那麼使用 PDB 進行無圖形界面的調試應該是首選，詳情請戳明哥以前的文章：讓代碼調試再也不難 - pdb函數
若是你要在本地進行開發，可是項目的進行須要依賴複雜的服務器環境，那麼能夠了解下 PyCharm 的遠程調試，詳情請戳明哥以前的文章：不能不會的遠程調試技巧工具
除了以上，今天明哥再給你介紹一款很是好用的調試工具，它能在一些場景下，大幅度提升調試的效率， 那就是 PySnooper，它在 Github 上已經收到了 13k 的 star，得到你們的一致好評。
有了這個工具後，就算是小萌新也能夠直接無門檻上手，今後與 print 說再見~
1. 快速安裝
執行下面這些命令進行安裝 PySnooper
$ python3 -m pip install pysnooper
# 或者
$ conda install -c conda-forge pysnooper
# 或者
$ yay -S python-pysnooper
2. 簡單案例
下面這段代碼，定義了一個 demo_func 的函數，在裏面生成一個 profile 的字典變量，而後去更新它，最後返回。
代碼自己沒有什麼實際意義，可是用來演示 PySnooper 已經足夠。
import pysnooper
@pysnooper.snoop()
def demo_func():
profile = {}
profile["name"] = "寫代碼的明哥"
profile["age"] = 27
profile["gender"] = "male"
return profile
def main():
profile = demo_func()
main()
如今我使用終端命令行的方式來運行它
[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 把函數運行的過程所有記錄了下來，包括：
代碼的片斷、行號等信息，以及每一行代碼是什麼時候調用的？
函數內局部變量的值如何變化的？什麼時候新增了變量，什麼時候修改了變量。
函數的返回值是什麼？
運行函數消耗了多少時間？
而做爲開發者，要獲得這些如此詳細的調試信息，你須要作的很是簡單，只要給你想要調試的函數上帶上一頂帽子（裝飾器） -- @pysnooper.snoop() 便可。
3. 詳細使用
2.1 重定向到日誌文件
@pysnooper.snoop() 不加任何參數時，會默認將調試的信息輸出到標準輸出。
對於單次調試就能解決的 BUG ，這樣沒有什麼問題，可是有一些 BUG 只有在特定的場景下才會出現，須要你把程序放在後面跑個一段時間才能復現。
這種狀況下，你能夠將調試信息重定向輸出到某一日誌文件中，方便追溯排查。
@pysnooper.snoop(output='/var/log/debug.log')
def demo_func():
...
2.2 跟蹤非局部變量值
PySnooper 是以函數爲單位進行調試的，它默認只會跟蹤函數體內的局部變量，若想跟蹤全局變量，能夠給 pysnooper.snoop() 加上 watch 參數
out = {"foo": "bar"}
@pysnooper.snoop(watch=('out["foo"]'))
def demo_func():
...
如此一來，PySnooper 會在 out["foo"] 值有變化時，也將其打印出來
watch 參數，接收一個可迭代對象（能夠是list 或者 tuple），裏面的元素爲字符串表達式，什麼意思呢？看下面例子就知道了
@pysnooper.snoop(watch=('out["foo"]', 'foo.bar', 'self.foo["bar"]'))
def demo_func():
...
和 watch 相對的，pysnooper.snoop() 還能夠接收一個函數 watch_explode，表示除了這幾個參數外的其餘全部全局變量都監控。
@pysnooper.snoop(watch_explode=('foo', 'bar'))
def demo_func():
...
2.3 設置跟蹤函數的深度
當你使用 PySnooper 調試某個函數時，若該函數中還調用了其餘函數，PySnooper 是不會傻傻的跟蹤進去的。
若是你想繼續跟蹤該函數中調用的其餘函數，能夠經過指定 depth 參數來設置跟蹤深度（不指定的話默認爲 1）。
@pysnooper.snoop(depth=2)
def demo_func():
...
2.4 設置調試日誌的前綴
當你在使用 PySnooper 跟蹤多個函數時，調試的日誌會顯得雜亂無章，不方便查看。
在這種狀況下，PySnooper 提供了一個參數，方便你爲不一樣的函數設置不一樣的標誌，方便你在查看日誌時進行區分。
@pysnooper.snoop(output="/var/log/debug.log", prefix="demo_func: ")
def demo_func():
...
效果以下
2.5 設置最大的輸出長度
默認狀況下，PySnooper 輸出的變量和異常信息，若是超過 100 個字符，被會截斷爲 100 個字符。
固然你也能夠經過指定參數 進行修改
@pysnooper.snoop(max_variable_length=200）
def demo_func():
...
您也可使用max_variable_length=None它從不截斷它們。
@pysnooper.snoop(max_variable_length=None）
def demo_func():
...
2.6 支持多線程調試模式
PySnooper 一樣支持多線程的調試，經過設置參數 thread_info=True，它就會在日誌中打印出是在哪一個線程對變量進行的修改。
@pysnooper.snoop(thread_info=True)
def demo_func():
...
效果以下
2.7 自定義對象的格式輸出
pysnooper.snoop() 函數有一個參數是 custom_repr，它接收一個元組對象。
在這個元組裏，你能夠指定特定類型的對象以特定格式進行輸出。
這邊我舉個例子。
假如我要跟蹤 person 這個 Person 類型的對象，因爲它不是常規的 Python 基礎類型，PySnooper 是沒法正常輸出它的信息的。
所以我在 pysnooper.snoop() 函數中設置了 custom_repr 參數，該參數的第一個元素爲 Person，第二個元素爲 print_persion_obj 函數。
PySnooper 在打印對象的調試信息時，會逐個判斷它是不是 Person 類型的對象，如果，就將該對象傳入 print_persion_obj 函數中，由該函數來決定如何顯示這個對象的信息。
class Person:pass
def 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 pysnooper
class Person:pass
def 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 = 27
person.gender = "male"
return person
def main():
profile = demo_func()
main()
運行一下，觀察一下效果。
若是你要自定義格式輸出的有不少個類型，那麼 custom_repr 參數的值能夠這麼寫
@pysnooper.snoop(custom_repr=((Person, print_person_obj), (numpy.ndarray, print_ndarray)))
def demo_func():
...
還有一點我提醒一下，元組的第一個元素能夠是類型（如類名Person 或者其餘基礎類型 list等），也能夠是一個判斷對象類型的函數。
也就是說，下面三種寫法是等價的。
# 【第一種寫法】
@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():
...
以上就是明哥今天給你們介紹的一款調試神器（PySnooper） 的詳細使用手冊，是否是以爲還不錯？
若是你還有其餘關於調試的技巧，能夠留言區分享出來，一塊兒學習一下~
我將本身的原創文章整理成了一本電子書，取名《Python修煉之道》，一共 400 頁，17w+ 字，目錄以下：
如今免費送給你們，在個人公衆號後臺回覆 修煉之道 便可獲取。
最後我最近建了一個讀者交流羣，想加入的能夠在公衆號後臺回覆「加羣」便可～
👆掃描上方二維碼便可關注
本文分享自微信公衆號 - Python空間（Devtogether）。
若有侵權，請聯繫 support@oschina.cn 刪除。
本文參與「OSC源創計劃」，歡迎正在閱讀的你也加入，一塊兒分享。