對于每個程序開發者來說，調試幾乎是必備技能。

代碼寫到一半卡住了，不知道這個函數執行完的返回結果是怎樣的？調試一下看看

代碼運行到一半報錯了，什么情況？怎么跟預期的不一樣？調試一下看看

調試的方法多種多樣，不同的調試方法適合不同的場景和人群。

•  如果你是剛接觸編程的小萌新，對很多工具的使用還不是很熟練，那么 print 和 log 大法好
•  如果你在本地（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） 的詳細使用手冊，是不是覺得還不錯？

如果你還有其他關于調試的技巧，可以留言區分享出來，一起學習一下~