一、简介

通常我们会使用print语句或者第三方工具的debug模式进行调试，PySnooper使用起来十分简单，使用者可以在任何代码库中使用它，而无需进行任何设置。你只需添加装饰器，并为日志输出地址指定路径，方法是将其路径指定为第一个参数。

1.1 传统调试模式

断点+单步调试

断点+单步调试估计是用的最多的了，对于较大型项目来说，其流程大致为：先在关键的代码位置加上print语句，通过分析print的值将范围缩小，这个过程可能需要重复多次，使用print的方法，一般可以将范围缩小到一个比较完整的功能模块中；然后在可能出现bug的模块中的关键部分打上断点，进入到断点后使用单步调试，查看各变量的值是否正确，最后根据错误的变量值定位到具体的代码行，最后进行修改

缺点

需要在代码中添加print语句，这就改变了原有的代码;

在断点调试和单步调试过程中，需要保持持续的专注，一旦跳过了关键点就要从头开始。

1.2 PySnooper调试模式

该工具使用采用装饰器的形式，将函数的运行过程以日志的形式打印到文件中，其记录了运行了哪些代码行，运行的时间及运行到当前代码时各变量的值。根据变量的变化就可以定位问题了。

优点：

无需为了查看变量的值，使用print打印变量的值，从而修改了原有的代码。

接口的运行过程以日志的形式保存，方便随时查看。

可以根据需要，设置函数调用的函数的层数，方便将注意力集中在需要重点关注的代码段。

多个函数的日志，可以设置日志前缀表示进行标识，方便查看时过滤。

二、PySnooper安装

pip install pysnooper

三、PySnooper简单使用

对需要调试的函数添加@pysnooper.snoop()装饰器

import pysnooper

@pysnooper.snoop()

def set_num2(a,b):

if a == 1:

c = a-b

else:

c = b/a

return c

a = set_num2(1,2)

print(a)

# 执行结果

-1

Source path:... E:/learn/lhytest/testpak/test1.py

Starting var:.. a = 1

Starting var:.. b = 2

15:02:13.679451 call 13 def set_num2(a,b):

15:02:13.679451 line 14 if a == 1:

15:02:13.679451 line 15 c = a-b

New var:....... c = -1

15:02:13.679451 line 18 return c

15:02:13.679451 return 18 return c

Return value:.. -1

四、PySnooper参数说明

PySnooper以装饰器的形式使用，常用的五个参数为：output,overwrite, watch, depth, prefix。

# 部分源码

def __init__(self, output=None, watch=(), watch_explode=(), depth=1,

prefix='', overwrite=False, thread_info=False, custom_repr=(),

max_variable_length=100):

pass

参用参数

说明

output

该参数指定函数运行过程中产生的中间结果的保存位置，若该值为空，则将中间结果输出到控制台。

overwrite

与output配合使用，默认值=False，向记录文件中添加记录， 当设置为True时，将记录文件的历史记录删除，然后添加新的记录

watch

该参数是vector类型, 因为在默认情况下，装饰器只跟踪局部变量，要跟踪非局部变量，则可以通过该字段来指定。默认值为空vector。

depth

该参数表示需要追踪的函数调用的深度。在很多时候，我们在函数中会调用其他函数，通过该参数就可以指定跟踪调用函数的深度。默认值为1。

prefix

该参数用于指定该函数接口的中间结果前缀。当多个函数都使用的该装饰器后，会将这些函数调用的中间结果保存到一个文件中，此时就可以通过前缀过滤不同函数调用的中间结果。默认值为空字符串。

4.1 output参数使用

若使用默认参数，则将中间结果输出到控制台；

若填写该参数，则将中间结果写入到该参数指定的目录下。

注意这里不会自动创建目录，所以需要事先创建目录

文件中记录了各行代码的执行过程及局部变量的变化。在debug时，通过分析该文件，就可以跟踪每一步的执行过程及局部变量的变化，这样就能快速的定位问题所在；由于运行的中间结果保存在文件中，方便随时分析其运行的中间结果，也便于共享。

import pysnooper

@pysnooper.snoop(output='file.log')

def set_num(a,b):

if a == 1:

c = a-b

else:

c = b/a

return c

a = set_num(1,2)

print(a)

# 生成的file.log文件内容

Source path:... E:/learn/lhytest/testpak/test1.py

Starting var:.. a = 1

Starting var:.. b = 2

15:25:22.475969 call 4 def set_num(a,b):

15:25:22.477937 line 5 if a == 1:

15:25:22.477937 line 6 c = a-b

New var:....... c = -1

15:25:22.478934 line 9 return c

15:25:22.478934 return 9 return c

Return value:.. -1

4.2 overwrite参数使用

overwrite参数与output参数配合使用，默认值=False，直接向记录文件中添加记录；当设置为True时，将记录文件的历史记录删除，然后再添加新的记录。

4.3 watch参数使用

在默认参数的情况下，使用该工具只能查看局变量的变化过程，当需要查看局部变量以外变量时，则可以通过watch参数进行设置

若变量不是局部变量，哪怕在函数中使用了该变量，如果不显示设置打印该变量的中间结果，则不会将该变量的中间结果打印到文件中。

4.3.1 不设置参数的情况

import pysnooper

class test:

def __init__(self):

self.num1 = 1

self.num2 = 1

@pysnooper.snoop(output='file.log',overwrite=True)

def get_num(self):

a = self.num1

b = self.num2

return a+b

aa = test()

aa.get_num()

# 生成的file.log文件内容

Source path:... E:/learn/lhytest/testpak/test1.py

Starting var:.. self = <__main__.test object at>

17:12:10.895000 call 8 def get_num(self):

17:12:10.895997 line 9 a = self.num1

New var:....... a = 1

17:12:10.896995 line 10 b = self.num2

New var:....... b = 1

17:12:10.896995 line 11 return a+b

17:12:10.897992 return 11 return a+b

Return value:.. 2

4.3.2 设置参数的情况(记录中多了self.num1和self.num2变量值的显示)

import pysnooper

class test:

def __init__(self):

self.num1 = 1

self.num2 = 1

@pysnooper.snoop(output='file.log',overwrite=True,watch=("self.num1", "self.num2"))

def get_num(self):

a = self.num1

b = self.num2

return a+b

aa = test()

aa.get_num()

# 生成的file.log文件内容

Source path:... E:/learn/lhytest/testpak/test1.py

Starting var:.. self = <__main__.test object at>

Starting var:.. self.num1 = 1

Starting var:.. self.num2 = 1

17:12:49.330764 call 8 def get_num(self):

17:12:49.331762 line 9 a = self.num1

New var:....... a = 1

17:12:49.331762 line 10 b = self.num2

New var:....... b = 1

17:12:49.332760 line 11 return a+b

17:12:49.332760 return 11 return a+b

Return value:.. 2

4.4 depth参数使用

该参数用来指定记录函数调用层数的结果，默认值为1；

若要查看多层函数调用的中间结果，则可将该参数设置为>=2。

4.4.1 depth=1时，仅显示了第一层函数的记录(set_all_num())

import pysnooper

def set_num(a,b):

if a == 1:

c = a-b

else:

c = b/a

return c

@pysnooper.snoop(output='file.log',depth=1)

def set_all_num(a,b):

c = set_num(a,b)

return a+b+c

a = set_all_num(1,2)

print(a)

# 生成的file.log文件内容

Source path:... E:/learn/lhytest/testpak/test1.py

Starting var:.. a = 1

Starting var:.. b = 2

16:27:19.610148 call 11 def set_all_num(a,b):

16:27:19.612144 line 12 c = set_num(a,b)

New var:....... c = -1

16:27:19.612144 line 13 return a+b+c

16:27:19.612144 return 13 return a+b+c

Return value:.. 2

4.4.2 depth=2时，包含了第一层函数(set_all_num())和第二层函数(set_num())的记录。

import pysnooper

def set_num(a,b):

if a == 1:

c = a-b

else:

c = b/a

return c

@pysnooper.snoop(output='file.log',depth=2)

def set_all_num(a,b):

c = set_num(a,b)

return a+b+c

a = set_all_num(1,2)

print(a)

# 生成的file.log文件内容

Source path:... E:/learn/lhytest/testpak/test1.py

Starting var:.. a = 1

Starting var:.. b = 2

16:27:42.344631 call 11 def set_all_num(a,b):

16:27:42.345628 line 12 c = set_num(a,b)

Starting var:.. a = 1

Starting var:.. b = 2

16:27:42.346626 call 3 def set_num(a,b):

16:27:42.346626 line 4 if a == 1:

16:27:42.347624 line 5 c = a-b

New var:....... c = -1

16:27:42.347624 line 8 return c

16:27:42.348621 return 8 return c

Return value:.. -1

New var:....... c = -1

16:27:42.348621 line 13 return a+b+c

16:27:42.349618 return 13 return a+b+c

Return value:.. 2

4.5 prefix参数使用

该参数主要用于设置中间结果的前缀，这样就可以区分不同的函数调用的中间结果，默认参数为空""。

import pysnooper

@pysnooper.snoop(output='file.log',prefix='--test--')

def set_num(a,b):

if a == 1:

c = a-b

else:

c = b/a

return c

a = set_num(1,2)

print(a)

# 生成的file.log文件内容

--test--Source path:... E:/learn/lhytest/testpak/test1.py

--test--Starting var:.. a = 1

--test--Starting var:.. b = 2

--test--16:38:14.123509 call 4 def set_num(a,b):

--test--16:38:14.124506 line 5 if a == 1:

--test--16:38:14.124506 line 6 c = a-b

--test--New var:....... c = -1

--test--16:38:14.124506 line 9 return c

--test--16:38:14.125503 return 9 return c

--test--Return value:.. -1

五、参考资料