PySnooper-绝不再使用打印进行调试
PySnooper是穷人的调试器。如果你用过Bash,它就像set -x
对于Python来说,只是它更华丽
您的故事:您正在试图弄清楚为什么Python代码没有执行您认为它应该执行的操作。您可能希望使用具有断点和监视的功能齐全的调试器,但是您现在不需要费心设置一个调试器
您想知道哪些行正在运行,哪些没有运行,以及局部变量的值是什么
大多数人都会用print
战略位置的线条,其中一些线条显示变量的值
PySnooper让您做同样的事情,只是不需要仔细设计正确的print
行,您只需向您感兴趣的函数添加一个修饰符行。您将获得函数的逐个播放日志,包括运行哪些行、运行时间以及更改局部变量的确切时间
是什么让PySnooper从所有其他代码智能工具中脱颖而出?您可以在您糟糕的、杂乱无章的企业代码库中使用它,而不必进行任何设置。只需启动修饰符,如下所示,并通过将其路径指定为第一个参数将输出重定向到专用日志文件
示例
我们正在编写一个函数,通过返回位列表将数字转换为二进制。让我们通过添加@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)
stderr的输出为:
Source path:... /my_code/foo.py
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]
Elapsed time: 00:00:00.000001
或者,如果您不想跟踪整个函数,可以将相关部分包装在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()
它输出类似于以下内容的内容:
New var:....... i = 9
New var:....... lst = [681, 267, 74, 832, 284, 678, ...]
09:37:35.881721 line 10 lower = min(lst)
New var:....... lower = 74
09:37:35.882137 line 11 upper = max(lst)
New var:....... upper = 832
09:37:35.882304 line 12 mid = (lower + upper) / 2
74 453.0 832
New var:....... mid = 453.0
09:37:35.882486 line 13 print(lower, mid, upper)
Elapsed time: 00:00:00.000344
功能
如果您不容易访问stderr,您可以将输出重定向到文件:
@pysnooper.snoop('/my/log/file.log')
您也可以改为传递一个流或一个可调用的,它们将被使用
请查看一些不是局部变量的表达式的值:
@pysnooper.snoop(watch=('foo.bar', 'self.x["whatever"]'))
显示函数调用的函数的监听行:
@pysnooper.snoop(depth=2)
看见Advanced Usage了解更多选项<
使用管道安装
安装的最佳方式是PySnooper是和皮普在一起:
$ pip install pysnooper
其他安装选项
带Conda-Forge通道的Conda:
$ conda install -c conda-forge pysnooper
Arch Linux:
$ yay -S python-pysnooper
Feddora Linux:
$ dnf install python3-pysnooper
许可证
版权所有(C)2019 Ram Rachum and Collaborators,根据麻省理工学院许可发布
媒体报道
Hacker News thread和/r/Python Reddit thread(2019年4月22日)