飞道的博客

PySnooper – 永远不要使用print进行调试

438人阅读  评论(0)

PySnooper 是一个非常方便的调试器。如果您正在试图弄清楚为什么您的Python代码没有按照您的预期去做,您会希望使用具有断点和监视功能的成熟Debug工具,但是许多Debug工具配置起来非常麻烦。

现在,有了PySnooper,您并不需要配置那么复杂的Debug工具,就能够完成对整个代码的分析。它能告诉您哪些代码正在运行,以及局部变量的值是什么。

其实,PySnooper 就是替代了一行一行print的重复性工作,给你的代码一个pysnooper装饰器,它能自动识别到语句和变量并将其值print出来:


   
  1. import pysnooper
  2. @pysnooper.snoop()
  3. def number_to_bits(number):
  4.      if number:
  5.         bits = []
  6.         while number:
  7.             number, remainder = divmod(number, 2)
  8.             bits.insert( 0, remainder)
  9.          return bits
  10.      else:
  11.          return [ 0]
  12. number_to_bits( 6)

效果如下:


   
  1. Source path:... 1.py
  2. Starting var:.. number = 6
  3. 23: 03: 35.990701 call          4 def number_to_bits(number):
  4. 23: 03: 35.991699 line 5      if number:
  5. 23: 03: 35.991699 line 6         bits = []
  6. New  var:....... bits = []
  7. 23: 03: 35.991699 line 7         while number:
  8. 23: 03: 35.991699 line 8             number, remainder = divmod(number, 2)
  9. Modified var:.. number = 3
  10. New  var:....... remainder = 0
  11. 23: 03: 35.991699 line 9             bits.insert( 0, remainder)
  12. Modified var:.. bits = [ 0]
  13. 23: 03: 36.004664 line 7         while number:
  14. 23: 03: 36.005661 line 8             number, remainder = divmod(number, 2)
  15. Modified var:.. number = 1
  16. Modified var:.. remainder = 1
  17. 23: 03: 36.005661 line 9             bits.insert( 0, remainder)
  18. Modified var:.. bits = [ 1, 0]
  19. 23: 03: 36.007657 line 7         while number:
  20. 23: 03: 36.007657 line 8             number, remainder = divmod(number, 2)
  21. Modified var:.. number = 0
  22. 23: 03: 36.008655 line 9             bits.insert( 0, remainder)
  23. Modified var:.. bits = [ 1, 1, 0]
  24. 23: 03: 36.008655 line 7         while number:
  25. 23: 03: 36.009651 line 10          return bits
  26. 23: 03: 36.009651  return       10          return bits
  27. Return value:.. [ 1, 1, 0]
  28. 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 的上下文形式:


   
  1. import pysnooper
  2. import random
  3. def foo():
  4.     lst = []
  5.      for i in  range( 10):
  6.         lst. append(random.randrange( 1, 1000))
  7.     with pysnooper.snoop():
  8.         lower = min(lst)
  9.         upper = max(lst)
  10.         mid = (lower + upper) / 2
  11.          print(lower, mid, upper)
  12. foo()

效果如下,只有上下文里的代码才会被调试出来:


   
  1. New  var:....... i = 9
  2. New  var:....... lst = [ 681, 267, 74, 832, 284, 678, ...]
  3. 09: 37: 35.881721 line 10         lower = min(lst)
  4. New  var:....... lower = 74
  5. 09: 37: 35.882137 line 11         upper = max(lst)
  6. New  var:....... upper = 832
  7. 09: 37: 35.882304 line 12         mid = (lower + upper) / 2
  8. 74  453.0  832
  9. New  var:....... mid = 453.0
  10. 09: 37: 35.882486 line 13          print(lower, mid, upper)
  11. Elapsed time: 00: 00: 00.000344

当我们只需要调试部分代码的时候,这个上下文形式的调试方法非常方便。

此外,PySnooper还有许多更强大的用法,大家可以看他们的高级使用文档:

https://github.com/cool-RR/PySnooper/blob/master/ADVANCED_USAGE.md

我们的文章到此就结束啦,如果你喜欢今天的Python 实战教程,请持续关注Python实用宝典。

有任何问题,可以在公众号后台回复:加群,回答相应红字验证信息,进入互助群询问。

原创不易,希望你能在下面点个赞和在看支持我继续创作,谢谢!

点击下方阅读原文可获得更好的阅读体验

Python实用宝典 (pythondict.com)
不只是一个宝典
欢迎关注公众号:Python实用宝典


转载:https://blog.csdn.net/u010751000/article/details/113904901
查看评论
* 以上用户言论只代表其个人观点,不代表本网站的观点或立场