在程序开发过程中,代码的运行往往会和我们预期的结果有所差别。于是,我们需要清楚代码运行过程中到底发生了什么?代码哪些模块运行了,哪些模块没有运行?输出的局部变量是什么样的。我们一般会加一些调试语句,比如加一些print或者log。代码少还好说,如果是大型项目,面对众多 print 的输出结果,可能不太好定位。下面推荐python的PySnooper包
PySnooper 是个什么东西?
PySnooper是一款成熟的调试器,与logging和iceream的作用类似,可以通过pip install PySnooper安装
因为你可以在不需要进行任何设置的情况下将其用于糟糕的、庞大的企业代码库中。
1、重定向到日志
- import pysnooper
- @pysnooper.snoop(output='../debug.log')
- def demo_func():
- dict_list = dict()
- dict_list["name"] = "dyf"
- dict_list["age"] = 18
- dict_list["gender"] = "female" return dict_list
-
- demo_func()
2、跟踪非局部变量
跟踪非局部变量值 PySnooper 是以函数为单位进行调试的,它默认只会跟踪函数体内的局部变量,若想跟踪全局变量,可以给 pysnooper.snoop() 加上 watch 参数
- import pysnooper
-
- out = {"foo": "bar"}
- @pysnooper.snoop(watch='out["foo"]')
- def demo_func():
- dict_list = dict()
- dict_list["name"] = "dyf"
- dict_list["age"] = 18
- dict_list["gender"] = "female"
- return dict_list
- demo_func()
3、设置跟踪函数的深度
#当你使用 PySnooper 调试某个函数时,若该函数中还调用了其他函数,PySnooper 是不会傻傻的跟踪进去的。如果你想继续跟踪该函数中调用的其他函数,可以通过指定 depth 参数来,设置跟踪深度(不指定的话默认为 1)
- # 跟踪函数中调用其他函数的执行过程
- @pysnooper.snoop(depth=2)
- def demo_func_new():
- return '我是一个函数'
-
- @pysnooper.snoop(depth=2)
- def demo_func():
- demo = demo_func_new()
- print(demo)
- dict_list = dict()
- dict_list["name"] = "dyf"
- dict_list["age"] = 18
- dict_list["gender"] = "female"
- return dict_list
- demo_func()
4、设置调试日志的前缀
#当你在使用 PySnooper 跟踪多个函数时,调试的日志会显得杂乱无章,不方便查看。在这种情况下,PySnooper 提供了一个参数,方便你为不同的函数设置不同的标志,方便查看日志时进行区分
- #4、设置调试日志的前缀
- @pysnooper.snoop(output="../debug.log", prefix="demo_func: ")
5、设置最大的输出长度
默认情况下,PySnooper 输出的变量和异常信息,如果超过 100 个字符,被会截断为 100 个字符。当然你也可以通过指定参数 进行修改
- @pysnooper.snoop(max_variable_length=200) # 限制长度为200
- @pysnooper.snoop(max_variable_length=None) # 不限制长度
6、支持多线程调试模式
PySnooper 同样支持多线程的调试,通过设置参数 thread_info=True,它就会在日志中打印出是在哪个线程对变量进行的修改。
如果感觉文章对你有帮助的话可以点个关注,欢迎关注公众号:橙好测试开发,可以免费获得测试开发学习资料!