有了PySnooper，不用print、不用debug轻松查找问题所在！

news2024/11/28 4:26:38

PySnooper是一个非常方便的调试器，它是通过python注解的方式来对函数的执行过程进行监督的。

应用起来比较简单，不用一步一步的去走debug来查找问题所在，并且将运行过程中函数的变量值打印出来结果一目了然，相当于替代了print函数的打印过程。

可以直接在定义的函数上面加一个pysnooper装饰器，它能自动识别到语句和变量并将其值print出来，并且可以将运行过程中打印的数据直接保存到自定义的日志文件中。

由于PySnooper是python的非标准库，因此需要使用pip的方式安装一下，安装方式可以根据自己喜好选择。

pip install pysnooper -i https://pypi.tuna.tsinghua.edu.cn/simple/

接下来开发商一个number_sum，简单的计算一个int类型值的累加计算，并在函数头部添加@pysnooper.snoop()的注解。

import pysnooper

@pysnooper.snoop()
def number_sum(number):
    if number :
        for n in range(2):
            number = number + n
    return number

number_sum(20)

从下面的结果来看总共发生了两次循环，n的值变化了两次分别是0、1，第一次由于n是0所以number的值时20，第二次循环时number的值就是21，结果一目了然。

# Source path:... C:/the-public/the-public/test014/test8.py
# Starting var:.. number = 20
# 14:47:27.122488 call        22 def number_sum(number):
# 14:47:27.123488 line        23     if number :
# 14:47:27.123488 line        24         for n in range(2):
# New var:....... n = 0
# 14:47:27.123488 line        25             number = number + n
# 14:47:27.123488 line        24         for n in range(2):
# Modified var:.. n = 1
# 14:47:27.123488 line        25             number = number + n
# Modified var:.. number = 21
# 14:47:27.123488 line        24         for n in range(2):
# 14:47:27.123488 line        26     return number
# 14:47:27.123488 return      26     return number
# Return value:.. 21
# Elapsed time: 00:00:00.001000

特别是在开发一个算法类型的代码块时很有用直接将整个的执行过程中的变量值展示出来，然后通过分析来调整我们的函数。

除此之外，还可以在运行过程中将执行过程直接写入到日志文件中，要是做历史分析的话就派上用场了，使用时只需要将日志的路径配置上即可。

@pysnooper.snoop('./snoop.log')
def number_sum(number):
    if number :
        for n in range(2):
            number = number + n
    return number

number_sum(10)

# C:\software\python\python.exe C:/the-public/the-public/test014/test8.py
#
# Process finished with exit code 0