Python调试工具

Python调试工具

目录

• Python调试工具
  • 一、pysnooper装饰器
    • 1. 安装
    • 2. 使用
    • 3. 其它使用
  • 二、pdb
    • 1. 单步调试
    • 2. 断点调试

一、pysnooper装饰器

参考博文：https://blog.csdn.net/chinesehuazhou2/article/details/109759400

PySnooper 把函数运行的过程全部记录了下来，包括：

• 代码的片段、行号等信息，以及每一行代码是何时调用的
• 函数内局部变量的值如何变化的？何时新增了变量，何时修改了变量
• 函数的返回值是什么
• 运行函数消耗了多少时间

1. 安装

pip3 install pysnooper

2. 使用

只需要使用装饰器即可

import pysnooper

@pysnooper.snoop()
def number_to_bits(number):
    li = list()
    while number > 0:
        li.append(number)
        number -= 1

number_to_bits(6)

3. 其它使用

• 如果在屏幕上print不方便，指定日志文件打印输出。

  @pysnooper.snoop('/data/xx/log.log')
  

• 读取局外变量或其他表达式

  如果要读取在装饰器作用范围以外的变量或者表达式的值，还可以使用watch参数：

  @pysnooper.snoop(watch=('foo.bar', 'self.x["whatever"]'))
  

• 不用装饰器的方式

  import pysnooper
  import random
  
  def foo():
      lst = []
      for i in range(10):
          lst.append(random.randrange(1, 1000))
  
      with pysnooper.snoop():
          lower = min(lst)
          upper = max(lst)
          mid = (lower + upper) / 2
          print(lower, mid, upper)
  
  foo()
  

二、pdb

• 系统自带的debug工具（无需安装）

• 将以下代码放在需要调试的地方（类似于设置断点）

  # 通用方法
  import pdb; pdb.set_trace()
  
  # Python3.6以上版本
  breakpoint()
  

1. 单步调试

 $ python3 -m pdb <py_file>
 
 pdb命令行：
    1）进入命令行Debug模式，python -m pdb xxx.py

    2）h：（help）帮助

    3）w：（where）打印当前执行堆栈

    4）d：（down）执行跳转到在当前堆栈的深一层（个人没觉得有什么用处）

    5）u：（up）执行跳转到当前堆栈的上一层

    6）b：（break）添加断点

                 b 列出当前所有断点，和断点执行到统计次数

                 b line_no：当前脚本的line_no行添加断点

                 b filename:line_no：脚本filename的line_no行添加断点

                 b function：在函数function的第一条可执行语句处添加断点

    7）tbreak：（temporary break）临时断点

                 在第一次执行到这个断点之后，就自动删除这个断点，用法和b一样

    8）cl：（clear）清除断点

                cl 清除所有断点

                cl bpnumber1 bpnumber2... 清除断点号为bpnumber1,bpnumber2...的断点

                cl lineno 清除当前脚本lineno行的断点

                cl filename:line_no 清除脚本filename的line_no行的断点

    9）disable：停用断点，参数为bpnumber，和cl的区别是，断点依然存在，只是不启用

    10）enable：激活断点，参数为bpnumber

    11）s：（step）执行下一条命令

                如果本句是函数调用，则s会执行到函数的第一句

    12）n：（next）执行下一条语句

                如果本句是函数调用，则执行函数，接着执行当前执行语句的下一条。

    13）r：（return）执行当前运行函数到结束

    14）c：（continue）继续执行，直到遇到下一条断点

    15）l：（list）列出源码

                 l 列出当前执行语句周围11条代码

                 l first 列出first行周围11条代码

                 l first second 列出first--second范围的代码，如果second<first，second将被解析为行数

    16）a：（args）列出当前执行函数的函数

    17）p expression：（print）输出expression的值

    18）pp expression：好看一点的p expression

    19）run：重新启动debug，相当于restart

    20）q：（quit）退出debug

    21）j lineno：（jump）设置下条执行的语句函数

                只能在堆栈的最底层跳转，向后重新执行，向前可直接执行到行号

    22）unt：（until）执行到下一行（跳出循环），或者当前堆栈结束

    23）condition bpnumber conditon，给断点设置条件，当参数condition返回True的时候bpnumber断点有效，否则bpnumber断点无效

import pdb


i= 0
li = list()
while i < 5:
    li.append(i)
    i += 1

2. 断点调试

单步调试只能从头到尾一句一句调试，过于麻烦。

import pdb


i= 0
li = list()
pdb.set_trace() # 运行到这里会自动暂停，相当于在这里打了断点
while i < 5:
    li.append(i)
    i += 1