PySnooper python调试必备
巢承安
Github:
https://github.com/cool-RR/PySnooper
安装
$ pip install pysnooper
带有 conda-forge 通道的 Conda：
$ conda install -c conda-forge pysnooper
Arch Linux：
$ yay -S python-pysnooper
Fedora Linux：
$ dnf install python3-pysnooper
自述文件
PySnooper是一个简单的调试器。如果您使用过 Bash，它就像set -xPython 一样，只是它更高级。
你的故事：你试图弄清楚为什么你的 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)
高级用法：
link: https://github.com/cool-RR/PySnooper/blob/master/ADVANCED_USAGE.md
类似资料：