Python调试利器PySnooper：无需Print即可追踪函数执行与变量变化

Python调试痛点与PySnooper简介

在Python开发过程中，调试程序是常见需求。当代码运行异常或逻辑不符合预期时，开发者往往需要深入函数内部查看执行路径。传统做法是在怀疑点插入print语句打印参数，但若问题涉及多个位置，频繁添加和删除print代码不仅繁琐，还容易遗漏关键信息。

GitHub上开源了一个名为PySnooper的工具，它能清晰展示函数内部的运行轨迹及参数值的变化过程。项目官方地址为：https://github.com/cool-RR/PySnooper

该工具具备使用简单、功能强大的特点，一经使用便知其优势。以下简要介绍其具体用法。

PySnooper安装与基础用法

安装该工具非常便捷，直接通过pip命令即可：pip install pysnooper。使用时，只需在目标函数定义前添加相应的装饰器即可启用监控功能。

import pysnooper
@pysnooper.snoop()
def removeDuplicates(nums):
  """
  :type nums: List[int]
  :rtype: int
  """
  flag = 0
  i=1
  while i<len(nums):
    if nums[i]==nums[i-1]:
      flag+=1
      i+=1
      if flag>=2:
        del nums[i-1]
        i-=1
    else:
      i+=1
      flag=0
  return len(nums)

nums = [1,1,1,2]
print(removeDuplicates(nums))

执行数据输出示例

添加装饰器并运行代码后，控制台将自动输出该函数的详细执行数据。

Starting var:.. nums = [1, 1, 1, 2] 13:03:44.990194 call 11 def removeDuplicates(nums): 13:03:44.990695 line 16 flag = 0 New var:....... flag = 0 13:03:44.990695 line 17 i=1 New var:....... i = 1 13:03:44.990695 line 18 while i<len(nums): 13:03:44.990695 line 19 if nums[i]==nums[i-1]: 13:03:44.990695 line 20 flag+=1 Modified var:.. flag = 1 13:03:44.990695 line 21 i+=1 Modified var:.. i = 2 13:03:44.991193 line 22 if flag>=2: 13:03:44.991193 line 18 while i<len(nums): 13:03:44.991193 line 19 if nums[i]==nums[i-1]: 13:03:44.991193 line 20 flag+=1 Modified var:.. flag = 2 13:03:44.991193 line 21 i+=1 Modified var:.. i = 3 13:03:44.991193 line 22 if flag>=2: 13:03:44.991193 line 23 del nums[i-1] Modified var:.. nums = [1, 1, 2] 13:03:44.991193 line 24 i-=1 Modified var:.. i = 2 13:03:44.991193 line 18 while i<len(nums): 13:03:44.991193 line 19 if nums[i]==nums[i-1]: 13:03:44.991193 line 26 i+=1 Modified var:.. i = 3 13:03:44.991693 line 27 flag=0 Modified var:.. flag = 0 13:03:44.991693 line 18 while i<len(nums): 13:03:44.991693 line 28 return len(nums) 13:03:44.991693 return 28 return len(nums) Return value:.. 3

高级功能：日志保存与前缀标记

如果希望将调试信息保存为日志文件而非直接输出到控制台，装饰器提供了可选参数来实现这一功能。

@pysnooper.snoop('log/file.log')

首先需预先创建好log目录，随后通过指定文件路径将日志输出到file文件中。

@pysnooper.snoop(prefix='removeDuplicates: ')

若需同时调试多个函数，可通过添加前缀参数来区分和定位日志来源。例如，在示例中使用函数名称作为前缀，部分日志记录如下所示：

removeDuplicates: Starting var:.. nums = [1, 1, 1, 2]
removeDuplicates: 13:53:14.322036 call    11 def removeDuplicates(nums):
removeDuplicates: 13:53:14.323037 line    16   flag = 0

@pysnooper.snoop(variables=('foo.bar', 'self.whatever'))

非本地变量监控与嵌套调用深度

此外，该工具还支持查看非本地变量。

@pysnooper.snoop(depth=2)

通过设置depth参数，可以显示函数内部调用的其他函数的Snoop行信息。该参数的取值范围必须是大于或等于1的正整数，源码中存在判断逻辑：assert self.depth >= 1，若传入小于1的值将抛出异常。

以上即为PySnooper的核心功能介绍，希望能为您的Python学习与实践提供帮助，欢迎继续支持本站内容。