PySnooper | Python调试神器

后台回复1024，解锁无限快乐！

传统的Python调试方式

1、打断点

2、Print函数

3、raise for

...

什么是PySnooper

一般情况下，想要知道哪一行代码在运行、哪一行不运行、本地变量的值是多少时，大部分人会使用print函数，在关键部分打印某个或某组变量的值、形状、类型等信息。

而PySnooper让你能快速地获得这些信息，且相比之下它不需要细致地写print函数，只需要向感兴趣的函数增加一个装饰器就行了。我们会得到该函数的详细log，包含哪行代码能运行、什么时候运行以及本地变量变化的确切时间。

相比于其他代码智能工具，PySnooper为何如此优秀？因为不需要任何设置，你就可以在劣等、不规则的企业代码库上使用PySnooper。

怎么安装PySnooper

pip install pysnooper

怎么用PySnooper

只需要加个装饰器，并为日志输出地址指定路径就行了。

超简单的例子：

import pysnooper

@pysnooper.snoop()
def echo_item(home_info:list):
    for i in home_info:
        print(i)

if __name__ == "__main__":
    echo_item(['xian','chengdu','beijing','shanghai'])

对于以上代码的执行，PySnooper将给出以下DEBUG信息：

python pysnp.py
Source path:... pysnp.py
Starting var:.. home_info = ['xian', 'chengdu', 'beijing', 'shanghai']
21:56:20.349444 call         4 def echo_item(home_info:list):
21:56:20.349444 line         5     for i in home_info:
New var:....... i = 'xian'
21:56:20.349444 line         6         print(i)
xian
21:56:20.349444 line         5     for i in home_info:
Modified var:.. i = 'chengdu'
21:56:20.349444 line         6         print(i)
chengdu
21:56:20.349444 line         5     for i in home_info:
Modified var:.. i = 'beijing'
21:56:20.349444 line         6         print(i)
beijing
21:56:20.349444 line         5     for i in home_info:
Modified var:.. i = 'shanghai'
21:56:20.349444 line         6         print(i)
shanghai
21:56:20.349444 line         5     for i in home_info:
21:56:20.349444 return       5     for i in home_info:
Return value:.. None
Elapsed time: 00:00:00.000000

通过PySnooper的DEBUG信息，我们可以清楚的知道代码的运行过程，当代码发生异常的时候，我们可以快速的定位问题的原因，在我们调试代码的时候有非常有用的帮助。

发生异常的例子：

import pysnooper

@pysnooper.snoop()
def echo_item(home_info:list):
    length = len(home_info)+1
    for i in range(length):
        print(home_info[i])

if __name__ == "__main__":
    echo_item(['xian','chengdu','beijing','shanghai'])

对于以上代码的执行，PySnooper将给出以下DEBUG信息：

python pysnp.py
Source path:... pysnp.py
Starting var:.. home_info = ['xian', 'chengdu', 'beijing', 'shanghai']
22:02:11.673646 call         4 def echo_item(home_info:list):
22:02:11.675646 line 5     length = len(home_info)+1
New var:....... length = 5
22:02:11.675646 line 6     for i in range(length):
New var:....... i = 0
22:02:11.676646 line 7         print(home_info[i])
xian
22:02:11.678647 line 6     for i in range(length):
Modified var:.. i = 1
22:02:11.678647 line 7         print(home_info[i])
chengdu
22:02:11.680647 line 6     for i in range(length):
Modified var:.. i = 2
22:02:11.680647 line 7         print(home_info[i])
beijing
22:02:11.682647 line 6     for i in range(length):
Modified var:.. i = 3
22:02:11.683647 line 7         print(home_info[i])
shanghai
22:02:11.685647 line 6     for i in range(length):
Modified var:.. i = 4
22:02:11.685647 line 7         print(home_info[i])
22:02:11.687647 exception    7         print(home_info[i])
Exception:..... IndexError: list index out of range
Call ended by exception
Elapsed time: 00:00:00.018001
Traceback (most recent call last):
  File "pysnp.py", line 10, in <module>
    echo_item(['xian','chengdu','beijing','shanghai'])
  File "D:\Python37\lib\site-packages\pysnooper\tracer.py", line 263, in simple_wrapper
    return function(*args, **kwargs)
  File "pysnp.py", line 7, in echo_item
    print(home_info[i])
IndexError: list index out of range

通常，列表越界的时候我们只知道结果，而不知道当时的变量值是多少或者代码运行在什么位置，但是通过PySnooper我们就可以清楚的定位越界的位置以及当时变量的值。更加快速准确的定位问题的根因。

将PySnooper的DEBUG信息输出到文件

只需要给PySnooper的装饰器增加DEBUG信息重定向的文件参数即可。

输出的DEBUG信息：

@Python测试和开发 | Source path:... pysnp.py
@Python测试和开发 | Starting var:.. home_info = ['xian', 'chengdu', 'beijing', 'shanghai']
@Python测试和开发 | 22:10:14.537824 call 4 def echo_item(home_info:list):
@Python测试和开发 | 22:10:14.553424 line 5     length = len(home_info)+1
@Python测试和开发 | New var:....... length = 5
@Python测试和开发 | 22:10:14.553424 line 6     for i in range(length):
@Python测试和开发 | New var:....... i = 0
@Python测试和开发 | 22:10:14.553424 line 7         print(home_info[i])
@Python测试和开发 | 22:10:14.553424 line 6     for i in range(length):
@Python测试和开发 | Modified var:.. i = 1
@Python测试和开发 | 22:10:14.553424 line 7         print(home_info[i])
@Python测试和开发 | 22:10:14.553424 line 6     for i in range(length):
@Python测试和开发 | Modified var:.. i = 2
@Python测试和开发 | 22:10:14.553424 line 7         print(home_info[i])
@Python测试和开发 | 22:10:14.572024 line 6     for i in range(length):
@Python测试和开发 | Modified var:.. i = 3
@Python测试和开发 | 22:10:14.574024 line 7         print(home_info[i])
@Python测试和开发 | 22:10:14.577024 line 6     for i in range(length):
@Python测试和开发 | Modified var:.. i = 4
@Python测试和开发 | 22:10:14.579024 line 7         print(home_info[i])
@Python测试和开发 | 22:10:14.583024 exception 7         print(home_info[i])
@Python测试和开发 | Exception:..... IndexError: list index out of range
@Python测试和开发 | Call ended by exception
@Python测试和开发 | Elapsed time: 00:00:00.050201

PySnooper装饰器的全部参数

‍

更多高级用法，可以阅读PySnooper源码学习！

完

往期推荐

超实用的 Python 库推荐！

还有什么是Python不能干的？

经典 | 32个常用 Python 实现

点亮在看！