Python 调试器入门

[ad_1]

Python 生态系统拥有丰富的工具和库,可以改善开发人员的生活。 例如,该杂志之前已经介绍了如何使用交互式 shell 来增强 Python。 本文重点介绍另一个可以节省您的时间并提高您的 Python 技能的工具:Python 调试器。

Python 调试器

Python 标准库提供了一个名为 pdb 的调试器。 该调试器提供了调试所需的大部分功能,例如断点、单行步进、堆栈帧检查等。

pdb 的基本知识很有用,因为它是标准库的一部分。 您可以在无法安装其他增强型调试器的环境中使用它。

运行 pdb

运行 pdb 的最简单方法是从命令行,将要调试的程序作为参数传递。 考虑以下脚本:

# pdb_test.py
#!/usr/bin/python3

from time import sleep

def countdown(number):
    for i in range(number, 0, -1):
        print(i)
        sleep(1)


if __name__ == "__main__":
    seconds = 10
    countdown(seconds)

您可以像这样从命令行运行 pdb:

$ python3 -m pdb pdb_test.py
> /tmp/pdb_test.py(1)<module>()
-> from time import sleep
(Pdb)

使用 pdb 的另一种方法是在程序中设置断点。 为此,导入 pdb 模块并使用 set_trace 函数:

1 # pdb_test.py
2 #!/usr/bin/python3
3
4 from time import sleep
5 
6
7 def countdown(number):
8     for i in range(number, 0, -1):
9         import pdb; pdb.set_trace()
10         print(i)
11        sleep(1)
12
13
14 if __name__ == "__main__":
15     seconds = 10
16     countdown(seconds)
$ python3 pdb_test.py
> /tmp/pdb_test.py(6)countdown()
-> print(i)
(Pdb)

脚本在断点处停止,pdb 显示脚本中的下一行。 您也可以在失败后执行调试器。 这称为事后调试。

导航执行堆栈

调试中的一个常见用例是导航执行堆栈。 Python 调试器运行后,以下命令很有用:

  • w(here) :显示当前执行的行以及执行堆栈的位置。
$ python3 test_pdb.py 
> /tmp/test_pdb.py(10)countdown()
-> print(i)
(Pdb) w
/tmp/test_pdb.py(16)<module>()
-> countdown(seconds)
> /tmp/test_pdb.py(10)countdown()
-> print(i)
(Pdb)
  • l(ist) :显示当前位置周围的更多上下文(代码)。
$ python3 test_pdb.py 
> /tmp/test_pdb.py(10)countdown()
-> print(i)
(Pdb) l
5 
6 
7 def countdown(number):
8 for i in range(number, 0, -1):
9 import pdb; pdb.set_trace()
10 -> print(i)
11 sleep(1)
12 
13 
14 if __name__ == "__main__":
15 seconds = 10
(Pdb)
  • u(p)/d(own) :向上或向下导航调用堆栈。
$ py3 test_pdb.py 
> /tmp/test_pdb.py(10)countdown()
-> print(i)
(Pdb) up
> /tmp/test_pdb.py(16)<module>()
-> countdown(seconds)
(Pdb) down
> /tmp/test_pdb.py(10)countdown()
-> print(i)
(Pdb)

单步执行程序

pdb 提供以下命令来执行和逐步执行代码:

  • n(ext):继续执行,直到到达当前函数的下一行,否则返回
  • s(tep):执行当前行并在第一个可能的情况下停止(在被调用的函数中或在当前函数中)
  • c(ontinue):继续执行,只在断点处停止。
$ py3 test_pdb.py 
> /tmp/test_pdb.py(10)countdown()
-> print(i)
(Pdb) n
10
> /tmp/test_pdb.py(11)countdown()
-> sleep(1)
(Pdb) n
> /tmp/test_pdb.py(8)countdown()
-> for i in range(number, 0, -1):
(Pdb) n
> /tmp/test_pdb.py(9)countdown()
-> import pdb; pdb.set_trace()
(Pdb) s
--Call--
> /usr/lib64/python3.6/pdb.py(1584)set_trace()
-> def set_trace():
(Pdb) c
> /tmp/test_pdb.py(10)countdown()
-> print(i)
(Pdb) c
9
> /tmp/test_pdb.py(9)countdown()
-> import pdb; pdb.set_trace()
(Pdb)

该示例显示了下一步和步骤之间的区别。 实际上,当使用 step 时,调试器会进入 pdb 模块源代码,而 next 将刚刚执行 set_trace 函数。

检查变量内容

pdb 真正有用的地方是检查存储在执行堆栈中的变量的内容。 例如,a(rgs) 命令打印当前函数的变量,如下所示:

py3 test_pdb.py 
> /tmp/test_pdb.py(10)countdown()
-> print(i)
(Pdb) where
/tmp/test_pdb.py(16)<module>()
-> countdown(seconds)
> /tmp/test_pdb.py(10)countdown()
-> print(i)
(Pdb) args
number = 10
(Pdb)

pdb 打印变量 number 的值,在本例中为 10。

另一个可用于打印变量值的命令是 p(rint)。

$ py3 test_pdb.py 
> /tmp/test_pdb.py(10)countdown()
-> print(i)
(Pdb) list
5 
6 
7 def countdown(number):
8 for i in range(number, 0, -1):
9 import pdb; pdb.set_trace()
10 -> print(i)
11 sleep(1)
12 
13 
14 if __name__ == "__main__":
15 seconds = 10
(Pdb) print(seconds)
10
(Pdb) p i
10
(Pdb) p number - i
0
(Pdb)

如示例的最后一条命令所示,print 可以在显示结果之前计算表达式。

Python 文档 包含每个 pdb 命令的参考和示例。 对于开始使用 Python 调试器的人来说,这是一本有用的读物​​。

增强的调试器

一些增强的调试器提供了更好的用户体验。 大多数都为 pdb 添加了有用的额外功能,例如语法突出显示、更好的回溯和自省。 增强型调试器的流行选择包括 IPython 的 ipdb数据库++.

这些示例向您展示了如何在虚拟环境中安装这两个调试器。 这些示例使用新的虚拟环境,但在调试应用程序的情况下,应使用应用程序的虚拟环境。

安装 IPython 的 ipdb

要安装 IPython ipdb,请在虚拟环境中使用 pip:

$ python3 -m venv .test_pdb
$ source .test_pdb/bin/activate
(test_pdb)$ pip install ipdb

要在脚本中调用 ipdb,您必须使用以下命令。 请注意,该模块称为 ipdb 而不是 pdb:

import ipdb; ipdb.set_trace()

IPython 的 ipdb 也可以在 Fedora 包,所以你可以使用安装它 Fedora的包管理器 dnf:

$ sudo dnf install python3-ipdb

安装 pdb++

您可以类似地安装 pdb++:

$ python3 -m venv .test_pdb
$ source .test_pdb/bin/activate
(test_pdb)$ pip install pdbp

pdb++ 覆盖 pdb 模块,因此您可以使用相同的语法在程序中添加断点:

import pdb; pdb.set_trace()

结论

学习如何使用 Python 调试器可以节省您调查应用程序问题的时间。 了解应用程序的复杂部分或某些库的工作方式也很有用,从而提高您的 Python 开发人员技能。

[ad_2]

Related Posts