有了PySnooper，再也不用靠一堆print来调试代码了
共 5093字，需浏览 11分钟
·
2021-05-11 07:29
大家好，欢迎来到 Crossin的编程教室 ！
当我们的Python代码出现报错或者没有得到预期的执行效果时，通常会使用具有断点功能的Debug工具，或者借助“print 大法”输出调试。但是，Debug工具有时不那么好使，print太多又很麻烦。
今天，我们就给大家分享另一个不错的调试选择：PySnooper
PySnooper 是一个非常方便的调试器。有了它之后，就能轻松完成对整个代码的调试分析。它能告诉你哪些代码正在运行，以及局部变量的值是什么。
PySnooper 的实现原理其实挺简单，就是替代了一行一行print的重复性工作，给你的代码一个pysnooper装饰器，它能自动识别到语句和变量并将其值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)效果如下：
Source path:... 1.py
Starting var:.. number = 6
23:03:35.990701 call 4 def number_to_bits(number):
23:03:35.991699 line 5 if number:
23:03:35.991699 line 6 bits = []
New var:....... bits = []
23:03:35.991699 line 7 while number:
23:03:35.991699 line 8 number, remainder = divmod(number, 2)
Modified var:.. number = 3
New var:....... remainder = 0
23:03:35.991699 line 9 bits.insert(0, remainder)
Modified var:.. bits = [0]
23:03:36.004664 line 7 while number:
23:03:36.005661 line 8 number, remainder = divmod(number, 2)
Modified var:.. number = 1
Modified var:.. remainder = 1
23:03:36.005661 line 9 bits.insert(0, remainder)
Modified var:.. bits = [1, 0]
23:03:36.007657 line 7 while number:
23:03:36.007657 line 8 number, remainder = divmod(number, 2)
Modified var:.. number = 0
23:03:36.008655 line 9 bits.insert(0, remainder)
Modified var:.. bits = [1, 1, 0]
23:03:36.008655 line 7 while number:
23:03:36.009651 line 10 return bits
23:03:36.009651 return 10 return bits
Return value:.. [1, 1, 0]
Elapsed time: 00:00:00.020945可以看到，它将每一行变量的值都输出到屏幕上，方便你调试代码。
仅仅需要写一行代码—使用装饰器就可以实现这个方便的调试功能，比起一行行写print，这可方便多了。
0.安装模块
使用这个模块，你只需要使用Pip安装PySnooper：
pip install pysnooper接下来讲讲这个模块其他好用的功能：
1. 支持日志文件
如果你觉得print到屏幕上不方便，还可以将其输出到log文件中，你只需要将装饰器那一行改为：
@pysnooper.snoop('/my/log/file.log')2. 读取局外变量或其他表达式
如果你想读取在装饰器作用范围以外的变量或者表达式的值，还可以使用watch参数：
@pysnooper.snoop(watch=('foo.bar', 'self.x["whatever"]'))3. 如果你不想用装饰器，也可以用上下文的形式调试
没错，装饰器有限定的使用条件，使用起来比较局限，因此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()效果如下，只有上下文里的代码才会被调试出来：
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当我们只需要调试部分代码的时候，这个上下文形式的调试方法非常方便。
此外，PySnooper还有许多更强大的用法，大家可以看他们的高级使用文档：
https://github.com/cool-RR/PySnooper/blob/master/ADVANCED_USAGE.md
关于 PySnooper 今天就介绍到这里。
如果文章对你有帮助，欢迎转发/点赞/收藏~
作者：Ckend
_往期文章推荐_