PySnooper 是一个非常方便的调试器。如果您正在试图弄清楚
为什么您的Python代码没有按照您的预期去做,您会希望使用具有断点和监视功能的成熟Debug工具,但是许多Debug工具配置起来非常麻烦。
现在,有了PySnooper,您并不需要配置那么复杂的Debug工具,就能够完成对整个代码的分析。它能告诉您哪些代码正在运行,以及局部变量的值是什么。
其实,PySnooper 就是替代了一行一行print的重复性工作,给你的代码一个pysnooper装饰器,它能自动识别到语句和变量并将其值print出来:
一.安装模块
使用这个模块,你只需要使用Pip安装PySnoope
pip install pysnooper
0.基础的使用方法
import pysnooper
@pysnooper.snoop()
def demo_func():
profile = {}
profile["name"] = "写代码的明哥"
profile["age"] = 27
profile["gender"] = "male"
return profile
def main():
profile = demo_func()
main()
可以看到 PySnooper 把函数运行的过程全部记录了下来,包括:
-
代码的片段、行号等信息,以及每一行代码是何时调用的?
-
函数内局部变量的值如何变化的?何时新增了变量,何时修改了变量。
-
函数的返回值是什么?
-
运行函数消耗了多少时间?
1.支持日志文件
如果你觉得print到屏幕上不方便,还可以将其输出到log文件中,你只需要将装饰器那一行改为:
@pysnooper.snoop('/my/log/file.log')
#例如:
@pysnooper.snoop(output='/var/log/debug.log')
def demo_func():
2.1 读取局外变量或其他表达式
如果你想读取在装饰器作用范围以外的变量或者表达式的值,还可以使用watch参数:
@pysnooper.snoop(watch=('foo.bar', 'self.x["whatever"]'))
2.2 读取局外变量或其他表达式
out = {"foo": "bar"}
@pysnooper.snoop(watch=('out["foo"]'))
def demo_func():
...
2.3 设置调试日志的前缀
@pysnooper.snoop(output="/var/log/debug.log", prefix="demo_func: ")
def demo_func():
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()
效果如下,只有上下文里的代码才会被调试出来:
当我们只需要调试部分代码的时候,这个上下文形式的调试方法非常方便。
此外,PySnooper还有许多更强大的用法,大家可以看他们的高级使用文档:https://github.com/cool-RR/PySnooper/blob/master/ADVANCED_USAGE.md