詳解DeBug Python神級工具PySnooper

PySnooper 在 GitHub 上自嘲是一個“乞丐版”調試工具（poor man's debugger）。

一般情況下，在編寫 Python 代碼時，如果想弄清楚為什么 Python 代碼沒有按照預期執行、哪些代碼在運行哪些沒在運行、局部變量又是什么，我們會使用包含斷點和觀察模式等功能的調試器，或者直接使用 print 語句打印出來。

但上面的方法都比較麻煩，例如使用調試器需要進行繁瑣的設置，使用 print 打印也要很仔細。與它們相比，使用 PySnooper 只需為要調試的函數添加一個裝飾器即可，這樣就能獲得運行函數詳細的 log，包括執行的代碼行和執行時間，以及局部變量發生變化的確切時間。

之所以稱為“乞丐版”，相信是因為 PySnooper 使用起來十分簡單，開發者可以在任何龐大的代碼庫中使用它，而無需進行任何設置。只需添加裝飾器，并為日志輸出地址指定路徑。

GitHub項目地址

安裝

pip3 install pysnooper

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)

返回日志如下

Starting var:.. number = 6
21:14:32.099769 call         3 @pysnooper.snoop()
21:14:32.099769 line         5     if number:
21:14:32.099769 line         6         bits = []
New var:....... bits = []
21:14:32.099769 line         7         while number:
21:14:32.099769 line         8             number, remainder = divmod(number, 2)
New var:....... remainder = 0
Modified var:.. number = 3
21:14:32.099769 line         9             bits.insert(0, remainder)
Modified var:.. bits = [0]
21:14:32.099769 line         7         while number:
21:14:32.099769 line         8             number, remainder = divmod(number, 2)
Modified var:.. number = 1
Modified var:.. remainder = 1
21:14:32.099769 line         9             bits.insert(0, remainder)
Modified var:.. bits = [1, 0]
21:14:32.099769 line         7         while number:
21:14:32.099769 line         8             number, remainder = divmod(number, 2)
Modified var:.. number = 0
21:14:32.099769 line         9             bits.insert(0, remainder)
Modified var:.. bits = [1, 1, 0]
21:14:32.099769 line         7         while number:
21:14:32.099769 line        10         return bits
21:14:32.099769 return      10         return bits

PySnooper特征

如果標準錯誤輸出難以獲得，或者太長了，那么可以將輸出定位到本地文件：

@pysnooper.snoop('/my/log/file.log')

查看一些非本地變量的值：

@pysnooper.snoop(variables=('foo.bar', 'self.whatever'))

展示我們函數中調用函數的 snoop 行：

@pysnooper.snoop(depth=2)

將所有 snoop 行以某個前綴開始，更容易定位和找到：

@pysnooper.snoop(prefix='ZZZ ')

更可以用來獲取TensorFlow 的各種張量信息，十分強大。媽媽再也不用擔心我找不到bug啦！
（2019.5.7更新：有時會不起作用，不知是自己姿勢不對還是其他原因。）

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持億速云。