一般情况下,在编写 Python 代码时,如果想弄清楚为什么 Python
代码没有按照预期执行的原因,比如你想知道哪些是正在运行,哪些没有运行,以及局部变量的值是什么…通常我们会使用包含断点和观察模式等功能成熟的调试器,或者直接使用
print 语句打印出来。
(想自学习编程的小伙伴请搜索圈T社区,更多行业相关资讯更有行业相关免费视频教程。完全免费哦!)
今天,小编和大家分享一个“贫民版”调试工具——PySnooper
PySnooper允许你执行以上相同的操作,只需为要调试的函数添加一个装饰器即可,而不需要构建正确的 print 打印。你还将得到函数的详细日志,包括运行了哪些代码行、何时运行以及何时更改了局部变量。
PySnooper 使用起来十分简单,开发者可以在任何庞大的代码库中使用它,而无需进行任何设置。你只需添加装饰器,并为日志输出地址指定路径,方法是将其路径指定为第一个参数。
目前,PySnooper在GitHub上已经获得 7047 个Star,371 个Fork(GitHub地址:https://github.com/cool-RR/PySnooper)
示例
以下编写了一个函数,通过返回一个二进制列表。我们只需要通过添加@pysnooper.snoop()装饰器就可以了:
import pysnooper
@pysnooper.snoop()
def number_to_bits(number):
if number:
bits = []
while number:
number, remainder = divmod(number, 2)
bits.insert(0, remainder)
return bits
else:
return [0]
number_to_bits(6)
输出如下:
Starting var:.. number = 6
15:29:11.327032 call 4 def number_to_bits(number):
15:29:11.327032 line 5 if number:
15:29:11.327032 line 6 bits = []
New var:....... bits = []
15:29:11.327032 line 7 while number:
15:29:11.327032 line 8 number, remainder = divmod(number, 2)
New var:....... remainder = 0
Modified var:.. number = 3
15:29:11.327032 line 9 bits.insert(0, remainder)
Modified var:.. bits = [0]
15:29:11.327032 line 7 while number:
15:29:11.327032 line 8 number, remainder = divmod(number, 2)
Modified var:.. number = 1
Modified var:.. remainder = 1
15:29:11.327032 line 9 bits.insert(0, remainder)
Modified var:.. bits = [1, 0]
15:29:11.327032 line 7 while number:
15:29:11.327032 line 8 number, remainder = divmod(number, 2)
Modified var:.. number = 0
15:29:11.327032 line 9 bits.insert(0, remainder)
Modified var:.. bits = [1, 1, 0]
15:29:11.327032 line 7 while number:
15:29:11.327032 line 10 return bits
15:29:11.327032 return 10 return bits
Return value:.. [1, 1, 0]
或者,如果您不想跟踪整个函数,可以将相关部分包装在一个with块中:
导入 pysnooper
随机导入
def foo():
lst = []
for i in range(10):
lst.append(random.randrange(1,1000))
与 pysnooper.snoop():
lower = min(lst)
upper = max(lst)
mid =(下+上)/ 2
打印(下,中,上)
FOO()
输出如下:
New var:....... i = 9
New var:....... lst = [681, 267, 74, 832, 284, 678, ...]
09:37:35.881721 line 10 lower = min(lst)
New var:....... lower = 74
09:37:35.882137 line 11 upper = max(lst)
New var:....... upper = 832
09:37:35.882304 line 12 mid = (lower + upper) / 2
74 453.0 832
New var:....... mid = 453.0
09:37:35.882486 line 13 print(lower, mid, upper)
特性
stderr,则可以将选择输出到指定文件:
@pysnooper.snoop('/my/log/file.log')
查看一些非局部变量的变量值:
@pysnooper.snoop(variables=('foo.bar', 'self.whatever'))
显示函数调用的函数的snoop行:
@pysnooper.snoop(depth=2)
安装
$ pip install pysnooper
高级用法
watch_explode将自动猜测如何扩展基于其类传递给它的表达式。您可以使用以下类之一更具体:
导入 pysnooper
@ pysnooper.snoop(watch =(
pysnooper.Attrs(' x '), # attributes
pysnooper.Keys(' y '), # mapping(例如dict)items
pysnooper.Indices(' z '), # sequence(例如list / tuple)items
))
使用exclude参数排除特定键/属性/索引,例如Attrs(‘x’, exclude=(’_foo’, ‘_bar’))。
之后添加切片Indices以仅查看该切片内的值,例如Indices(‘z’)[-3:]。
有助于
Tox自动安装所有依赖项。您只需要安装Tox本身:
$ pip install tox
列出tox将运行的所有环境:
$ tox -lv
如果要对所有目标Python版本运行测试,请使用pyenv来安装它们。否则,您只能运行您已在计算机上安装的连接器:
#只运行一些环境
$ tox -e flake8,pylint,bandit,py27,py36
或者只是在具有测试依赖性的开发人员模式下安装项目
$ pip install -e path / to / PySnooper [tests]
并运行测试:
$ pytest
在推送代码之前,测试应该通过。他们将再次在Travis CI上运行。
原文链接:https://github.com/cool-RR/PySnooper