Python之PySnooper程式碼除錯

PySnooper是一款非常好用的Python程式碼除錯工具，它能在一些場景下，大幅度提高除錯的效率。它在 Github 上已經收到了 13k 的 star，獲得大家的一致好評。今天小編就帶領大家一起來看看這個工具的使用。

對於每個程式開發者來說，除錯幾乎是必備技能。程式碼寫到一半卡住了，不知道這個函式執行完的返回結果是怎樣的？除錯一下看看。程式碼執行到一半報錯了，什麼情況？怎麼跟預期的不一樣？除錯一下看看。

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

1. 如果你是剛接觸程式設計的小萌新，對很多工具的使用還不是很熟練，那麼就使用 print 和 log 
2. 如果你在本地（Win或者Mac）電腦上開發，那麼 IDE 的圖形化介面除錯無疑是最適合的；
3. 如果你在伺服器上排查BUG，那麼使用 PDB 進行無圖形介面的除錯應該是首選，詳情請戳明哥之前的文章：讓程式碼除錯不再難 - pdb
4. 如果你要在本地進行開發，但是專案的進行需要依賴複雜的伺服器環境，那麼可以瞭解下 PyCharm 的遠端除錯，詳情請戳明哥之前的文章：不能不會的遠端除錯技巧

今天小編就帶領大家一起來看看PySnooper的使用。有了這個工具後，就算是小萌新也可以直接無門檻上手，從此與print說再見~

執行下面這些 進行安裝 PySnooper

$ python3 -m pip install pysnooper  
# 或者  
$ conda install -c conda-forge pysnooper  
# 或者  
$ yay -S python-pysnooper

下面這段程式碼，定義了一個 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 把函式執行的過程全部記錄了下來，包括：

1. 程式碼的片段、行號等資訊，以及每一行程式碼是何時呼叫的？

1. 函式內區域性變數的值如何變化的？何時新增了變數，何時修改了變數。

1. 函式的返回值是什麼？

1. 執行函式消耗了多少時間？

而作為開發者，要得到這些如此詳細的除錯資訊，你需要做的非常簡單，只要給你想要除錯的函式上帶上一頂帽子（裝飾器） -- @pysnooper.snoop() 即可。

@pysnooper.snoop() 不加任何引數時，會預設將除錯的資訊輸出到標準輸出。

對於單次除錯就能解決的 BUG ，這樣沒有什麼問題，但是有一些 BUG 只有在特定的場景下才會出現，需要你把程式放在後面跑個一段時間才能復現。

這種情況下，你可以將除錯資訊重定向輸出到某一日誌檔案中，方便追溯排查。

@pysnooper.snoop(output='/var/log/debug.log')  
def demo_func():  
    ...

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():  
    ...

當你使用 PySnooper 除錯某個函式時，若該函式中還呼叫了其他函式，PySnooper 是不會傻傻的跟蹤進去的。

如果你想繼續跟蹤該函式中呼叫的其他函式，可以透過指定 depth 引數來設定跟蹤深度（不指定的話預設為 1）。

@pysnooper.snoop(depth=2)  
def demo_func():  
 ...

當你在使用 PySnooper 跟蹤多個函式時，除錯的日誌會顯得雜亂無章，不方便檢視。

在這種情況下，PySnooper 提供了一個引數，方便你為不同的函式設定不同的標誌，方便你在檢視日誌時進行區分。

@pysnooper.snoop(output="/var/log/debug.log", prefix="demo_func: ")  
def demo_func():  
    ...

效果如下

預設情況下，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():  
    ...

PySnooper 同樣支援多執行緒的除錯，透過設定引數 thread_info=True，它就會在日誌中列印出是在哪個執行緒對變數進行的修改。

@pysnooper.snoop(thread_info=True)  
def demo_func():  
    ...

效果如下

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""  
@pysnooper.snoop(custom_repr=(Person, print_person_obj))  
def demo_func():  
    ...

完整的程式碼如下

import pysnooper  
class Person:pass  
def print_person_obj(obj):  
    return f""  
@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():  
    ...

原文地址：