一般情況下，在編寫 Python 代碼時(shí)，如果想弄清楚為什么 Python 代碼沒有按照預(yù)期執(zhí)行的原因，比如你想知道哪些是正在運(yùn)行，哪些沒有運(yùn)行，以及局部變量的值是什么...通常我們會(huì)使用包含斷點(diǎn)和觀察模式等功能成熟的調(diào)試器，或者直接使用 print 語(yǔ)句打印出來(lái)。

今天，猿妹和大家分享一個(gè)“貧民版”調(diào)試工具——PySnooper

PySnooper允許你執(zhí)行以上相同的操作，只需為要調(diào)試的函數(shù)添加一個(gè)裝飾器即可，而不需要構(gòu)建正確的 print 打印。你還將得到函數(shù)的詳細(xì)日志，包括運(yùn)行了哪些代碼行、何時(shí)運(yùn)行以及何時(shí)更改了局部變量。

PySnooper 使用起來(lái)十分簡(jiǎn)單，開發(fā)者可以在任何龐大的代碼庫(kù)中使用它，而無(wú)需進(jìn)行任何設(shè)置。你只需添加裝飾器，并為日志輸出地址指定路徑，方法是將其路徑指定為***個(gè)參數(shù)。

目前，PySnooper在GitHub上已經(jīng)獲得 7047 個(gè)Star，371 個(gè)Fork（GitHub地址：https://github.com/cool-RR/PySnooper）

示例

以下編寫了一個(gè)函數(shù)，通過(guò)返回一個(gè)二進(jìn)制列表。我們只需要通過(guò)添加@pysnooper.snoop()裝飾器就可以了： 

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  
15:29:11.327032 call         4 def number_to_bits(number):  
15:29:11.327032 line         5     if number:  
15:29:11.327032 line         6         bits = []  
New var:....... bits = []  
15:29:11.327032 line         7         while number:  
15:29:11.327032 line         8             number, remainder = divmod(number, 2)  
New var:....... remainder = 0  
Modified var:.. number = 3  
15:29:11.327032 line         9             bits.insert(0, remainder)  
Modified var:.. bits = [0]  
15:29:11.327032 line         7         while number:  
15:29:11.327032 line         8             number, remainder = divmod(number, 2)  
Modified var:.. number = 1  
Modified var:.. remainder = 1  
15:29:11.327032 line         9             bits.insert(0, remainder)  
Modified var:.. bits = [1, 0]  
15:29:11.327032 line         7         while number:  
15:29:11.327032 line         8             number, remainder = divmod(number, 2)  
Modified var:.. number = 0  
15:29:11.327032 line         9             bits.insert(0, remainder)  
Modified var:.. bits = [1, 1, 0]  
15:29:11.327032 line         7         while number:  
15:29:11.327032 line        10         return bits  
15:29:11.327032 return      10         return bits  
Return value:.. [1, 1, 0] 

特性

stderr，則可以將選擇輸出到指定文件： 

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

查看一些非局部變量的變量值： 

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

顯示函數(shù)調(diào)用的函數(shù)的snoop行： 

@pysnooper.snoop(depth=2)