PySnooper ：一個(gè)非常方便的調(diào)試器

PySnooper 是一個(gè)非常方便的調(diào)試器。如果您正在試圖弄清楚為什么您的Python代碼沒有按照您的預(yù)期去做，您會(huì)希望使用具有斷點(diǎn)和監(jiān)視功能的成熟Debug工具，但是許多Debug工具配置起來非常麻煩。

現(xiàn)在，有了PySnooper，您并不需要配置那么復(fù)雜的Debug工具，就能夠完成對(duì)整個(gè)代碼的分析。它能告訴您哪些代碼正在運(yùn)行，以及局部變量的值是什么。

其實(shí)，PySnooper 就是替代了一行一行print的重復(fù)性工作，給你的代碼一個(gè)pysnooper裝飾器，它能自動(dòng)識(shí)別到語句和變量并將其值print出來：

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)

效果如下：

可以看到，它將每一行變量的值都輸出到屏幕上，方便你調(diào)試代碼。

僅僅需要寫一行代碼—使用裝飾器就可以實(shí)現(xiàn)這個(gè)方便的調(diào)試功能，比起一行行寫print，這可方便多了。

1.準(zhǔn)備

開始之前，你要確保Python和pip已經(jīng)成功安裝在電腦上，如果沒有，可以訪問這篇文章：超詳細(xì)Python安裝指南 進(jìn)行安裝。

**(可選1) **如果你用Python的目的是數(shù)據(jù)分析，可以直接安裝Anaconda：Python數(shù)據(jù)分析與挖掘好幫手—Anaconda，它內(nèi)置了Python和pip.

**(可選2) **此外，推薦大家用VSCode編輯器，它有許多的優(yōu)點(diǎn)：Python 編程的最好搭檔—VSCode 詳細(xì)指南。

請(qǐng)選擇以下任一種方式輸入命令安裝依賴 ：

1. Windows 環(huán)境 打開 Cmd (開始-運(yùn)行-CMD)。
2. MacOS 環(huán)境 打開 Terminal (command+空格輸入Terminal)。
3. 如果你用的是 VSCode編輯器 或 Pycharm，可以直接使用界面下方的Terminal.

pip install pysnooper

除了文章開頭提到的基本使用方法，這個(gè)模塊還有其他好用的功能。

2.功能

基本使用方法，在你的函數(shù)上加一個(gè) 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)

效果如下：

2.1 支持日志文件

如果你覺得print到屏幕上不方便，還可以將其輸出到log文件中，你只需要將裝飾器那一行改為：

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

2.2 讀取局外變量或其他表達(dá)式

如果你想讀取在裝飾器作用范圍以外的變量或者表達(dá)式的值，還可以使用watch參數(shù)：

@pysnooper.snoop(watch=('foo.bar', 'self.x["whatever"]'))

2.3 如果你不想用裝飾器，也可以用上下文的形式調(diào)試

沒錯(cuò)，裝飾器有限定的使用條件，使用起來比較局限，因此pysnooper還支持使用 with 的上下文形式：

import pysnooper
import random

def foo():
    lst = []
    for i in range(10):
        lst.append(random.randrange(1, 1000))

    with pysnooper.snoop():
        lower = min(lst)
        upper = max(lst)
        mid = (lower + upper) / 2
        print(lower, mid, upper)

foo()

效果如下，只有上下文里的代碼才會(huì)被調(diào)試出來：

當(dāng)我們只需要調(diào)試部分代碼的時(shí)候，這個(gè)上下文形式的調(diào)試方法非常方便。