详解Python调试神器之PySnooper

来给大家详细讲解一下Python调试神器之PySnooper的使用方法。

什么是PySnooper

PySnooper是一款Python调试工具，最主要的功能是记录程序的运行日志，同时让开发者在代码中任意添加断点。

PySnooper的主要特点包括：

• 以简单的方式记录程序每一行的执行过程，使得调试效果更直观
• 记录的信息包括当前时间、行号、变量、返回值等方便开发者进行分析
• 允许在代码中任意添加断点，无需重新启动调试工具
• 适用于Python 3.5及以上版本

安装PySnooper

使用pip可以很简单地安装PySnooper：

pip install pysnooper

如何使用PySnooper

下面我们来介绍一下如何使用PySnooper。

简单示例

下面是一个简单的Python脚本示例：

import random
import pysnooper

@pysnooper.snoop()
def lottery(n=6):
    s = set()
    while len(s) < n:
        s.add(random.randint(1, 49))
    return sorted(s)

if __name__ == '__main__':
    ret = lottery(n=6)
    print(ret)

我们加上了一个@pysnooper.snoop()装饰器，这样当我们运行这段代码时，PySnooper会自动记录每一行的执行过程。运行后的输出如下：

Source path:... Whatever
Starting var:.. n = 6
15:38:19.863174 call         4 @pysnooper.snoop()
15:38:19.863408 line         6 def lottery(n=6):
New var:....... s = set()
15:38:19.863674 line         7     while len(s) < n:
                   s = {1, 43, 9, 11, 23, 33}
15:38:19.863925 line         8         s.add(random.randint(1, 49))
                   s = {1, 43, 9, 11, 23, 33}
                   random.randint = <built-in method randint of module random>
                   random.randint(1, 49) = 6
15:38:19.864191 line         7     while len(s) < n:
                   s = {1, 43, 9, 11, 23, 33, 6}
15:38:19.864459 line         8         s.add(random.randint(1, 49))
                   s = {1, 43, 9, 11, 23, 33, 6}
                   random.randint = <built-in method randint of module random>
                   random.randint(1, 49) = 21
15:38:19.864712 line         7     while len(s) < n:
                   s = {1, 43, 9, 11, 21, 23, 33, 6}
15:38:19.864969 line         8         s.add(random.randint(1, 49))
                   s = {1, 43, 9, 11, 21, 23, 33, 6}
                   random.randint = <built-in method randint of module random>
                   random.randint(1, 49) = 40
15:38:19.865223 line         7     while len(s) < n:
                   s = {1, 40, 43, 9, 11, 21, 23, 33, 6}
15:38:19.865476 line         8         s.add(random.randint(1, 49))
                   s = {1, 40, 43, 9, 11, 21, 23, 33, 6}
                   random.randint = <built-in method randint of module random>
                   random.randint(1, 49) = 22
15:38:19.865730 line         7     while len(s) < n:
                   s = {1, 40, 43, 9, 11, 21, 22, 23, 33, 6}
15:38:19.865984 line         8         s.add(random.randint(1, 49))
                   s = {1, 40, 43, 9, 11, 21, 22, 23, 33, 6}
                   random.randint = <built-in method randint of module random>
                   random.randint(1, 49) = 21
15:38:19.866237 line         7     while len(s) < n:
                   s = {1, 40, 43, 9, 11, 21, 22, 23, 33, 6}
15:38:19.866489 return       6 return sorted(s)
Return value:.. [1, 6, 9, 11, 40, 43]

我们可以看到，PySnooper记录了每一行的执行过程，包括了变量变化和函数返回值等信息，非常方便调试。

指定输出信息

我们还可以指定PySnooper记录什么信息，以便更精确地调试代码。

下面是一个示例，我们指定PySnooper记录变量s和函数返回值：

import random
import pysnooper

@pysnooper.snoop(watch=('s', 'ret'))
def lottery(n=6):
    ret = set()
    while len(ret) < n:
        num = random.randint(1, 49)
        ret.add(num)
        s = list(ret)
    return sorted(ret)

if __name__ == '__main__':
    ret = lottery(n=6)
    print(ret)

运行后的输出如下：

Source path:... Whatever
Starting var:.. n = 6
15:48:34.464200 call         4 @pysnooper.snoop(watch=('s', 'ret'))
15:48:34.464508 line         6 def lottery(n=6):
New var:....... ret = set()
New var:....... s = []
15:48:34.464734 line         7     while len(ret) < n:
                   ret = {32, 3, 8, 40, 41, 44}
15:48:34.464989 line         8         num = random.randint(1, 49)
                   num = 45
15:48:34.465246 line         9         ret.add(num)
                   ret = {32, 3, 8, 40, 41, 44, 45}
15:48:34.465492 line        10         s = list(ret)
                   s = [32, 3, 8, 40, 41, 44, 45]
15:48:34.465745 line         7     while len(ret) < n:
                   ret = {32, 3, 8, 40, 41, 44, 45, 13}
15:48:34.465988 line         8         num = random.randint(1, 49)
                   num = 13
15:48:34.466242 line         9         ret.add(num)
                   ret = {32, 3, 8, 40, 41, 44, 45, 13}
15:48:34.466489 line        10         s = list(ret)
                   s = [32, 3, 8, 40, 41, 44, 45, 13]
15:48:34.466742 return       6 return sorted(ret)
Return value:.. [3, 8, 13, 32, 40, 41, 44, 45]

我们可以看到，PySnooper只输出了s和ret的变化情况，让我们更专注于关注这两个变量的变化情况。

结束语

以上就是PySnooper的使用方法，希望这篇攻略对大家有所帮助。需要注意的是，在实际开发中，我们也要结合其他调试工具和技巧来进行全面的调试。