使用 Pdb 调试 Python

目录

调试应用程序有时可能是一项不受欢迎的活动。您在时间紧迫的情况下忙于工作，而您只想让它发挥作用。然而，在其他时候，您可能正在学习一种新的语言功能或尝试一种新的方法，并希望更深入地了解某些东西是如何工作的。

不管情况如何，调试代码都是必要的，因此在调试器中工作起来很舒服是个好主意。在本教程中，我将向您展示使用 pdb（Python 的交互式源代码调试器）的基础知识。

我将带您了解 pdb 的一些常见用法。您可能希望将本教程添加为书签，以便稍后在您真正需要时快速参考。pdb 和其他调试器是必不可少的工具。当您需要调试器时，没有替代品。你真的需要它。

在本教程结束时，您将了解如何使用调试器查看应用程序中任何变量的状态。您还可以随时停止和恢复应用程序的执行流程，因此您可以准确了解每行代码如何影响其内部状态。

这对于追踪难以发现的错误非常有用，并允许您更快、更可靠地修复错误代码。有时，单步执行 pdb 中的代码并查看值如何变化会让人大开眼界，并导致“啊哈”时刻，以及偶尔的“手掌”。

pdb 是 Python 标准库的一部分，因此它始终存在并可供使用。如果您需要在无法访问您熟悉的 GUI 调试器的环境中调试代码，这可以成为救命稻草。

本教程中的示例代码使用 Python 3.6。您可以在GitHub上找到这些示例的源代码。

在本教程的末尾，有一个基本 pdb 命令的快速参考。

还有一个可打印的 pdb 命令参考，您可以在调试时用作备忘单：

入门：打印变量的值

在第一个示例中，我们将看看以最简单的形式使用 pdb：检查变量的值。

在要中断调试器的位置插入以下代码：

import pdb; pdb.set_trace()

当上面的行被执行时，Python 停止并等待你告诉它下一步做什么。你会看到一个(Pdb)提示。这意味着您现在在交互式调试器中暂停并且可以输入命令。

从 Python 3.7 开始，还有另一种进入 debugger 的方法。PEP 553描述了内置函数breakpoint()，这使得进入调试器变得容易且一致：

breakpoint()

默认情况下，breakpoint()将导入 pdb和调用pdb.set_trace()，如上所示。但是， usingbreakpoint()更灵活，允许您通过其 API 和环境变量的使用来控制调试行为PYTHONBREAKPOINT。例如，PYTHONBREAKPOINT=0在您的环境中设置将完全禁用breakpoint()，从而禁用调试。如果你正在使用Python 3.7或更高版本，我鼓励你使用breakpoint()的不是pdb.set_trace()。

您还可以通过直接从命令行运行 Python 并传递选项来闯入调试器，而无需修改源代码和使用pdb.set_trace()或。如果您的应用程序接受命令行参数，请像往常一样在文件名之后传递它们。例如：breakpoint()-m pdb

$ python3 -m pdb app.py arg1 arg2

有很多 pdb 命令可用。在本教程的末尾，有一个基本 pdb 命令列表。现在，让我们使用该p命令来打印变量的值。p variable_name在(Pdb)提示符下输入以打印其值。

让我们看一下这个例子。这是example1.py来源：

#!/usr/bin/env python3

filename = __file__
import pdb; pdb.set_trace()
print(f'path = {filename}')

如果你从你的 shell 运行它，你应该得到以下输出：

$ ./example1.py 
> /code/example1.py(5)<module>()
-> print(f'path = {filename}')
(Pdb) 

如果您在从命令行获取示例或您自己的代码时遇到问题，请阅读如何使用 Python 创建自己的命令行命令？如果您使用的是 Windows，请查看Python Windows 常见问题解答。

现在输入p filename。你应该看到：

(Pdb) p filename
'./example1.py'
(Pdb)

由于您在 shell 中并使用 CLI（命令行界面），因此请注意字符和格式。他们会给你你需要的上下文：

• >从第一行开始，告诉您您所在的源文件。在文件名之后，括号中是当前行号。接下来是函数的名称。在这个例子中，由于我们没有在函数内部和模块级别暂停，我们看到<module>().
• ->开始第二行，是 Python 暂停的当前源代码行。该行尚未执行。在本例中，这是来自上一行的line 5in 。example1.py>
• (Pdb)是 pdb 的提示。它在等待命令。

使用该命令q退出调试并退出。

#!/usr/bin/env python3

import os


def get_path(filename):
    """Return file's path or empty string if no path."""
    head, tail = os.path.split(filename)
    import pdb; pdb.set_trace()
    return head


filename = __file__
print(f'path = {get_path(filename)}')

$ ./example2.py 
> /code/example2.py(10)get_path()
-> return head
(Pdb) 

(Pdb) ll
  6     def get_path(filename):
  7         """Return file's path or empty string if no path."""
  8         head, tail = os.path.split(filename)
  9         import pdb; pdb.set_trace()
 10  ->     return head
(Pdb) p filename
'./example2.py'
(Pdb) p head, tail
('.', 'example2.py')
(Pdb) p 'filename: ' + filename
'filename: ./example2.py'
(Pdb) p get_path
<function get_path at 0x100760e18>
(Pdb) p getattr(get_path, '__doc__')
"Return file's path or empty string if no path."
(Pdb) p [os.path.split(p)[1] for p in os.path.sys.path]
['pdb-basics', 'python36.zip', 'python3.6', 'lib-dynload', 'site-packages']
(Pdb) 

#!/usr/bin/env python3

import os


def get_path(filename):
    """Return file's path or empty string if no path."""
    head, tail = os.path.split(filename)
    return head


filename = __file__
import pdb; pdb.set_trace()
filename_path = get_path(filename)
print(f'path = {filename_path}')

$ ./example3.py 
> /code/example3.py(14)<module>()
-> filename_path = get_path(filename)
(Pdb) n
> /code/example3.py(15)<module>()
-> print(f'path = {filename_path}')
(Pdb) 

$ ./example3.py 
> /code/example3.py(14)<module>()
-> filename_path = get_path(filename)
(Pdb) s
--Call--
> /code/example3.py(6)get_path()
-> def get_path(filename):
(Pdb) 

$ ./example3.py 
> /code/example3.py(14)<module>()
-> filename_path = get_path(filename)
(Pdb) s
--Call--
> /code/example3.py(6)get_path()
-> def get_path(filename):
(Pdb) n
> /code/example3.py(8)get_path()
-> head, tail = os.path.split(filename)
(Pdb) 
> /code/example3.py(9)get_path()
-> return head
(Pdb) 
--Return--
> /code/example3.py(9)get_path()->'.'
-> return head
(Pdb) 
> /code/example3.py(15)<module>()
-> print(f'path = {filename_path}')
(Pdb) 
path = .
--Return--
> /code/example3.py(15)<module>()->None
-> print(f'path = {filename_path}')
(Pdb) 

--Return--
> /code/example3.py(9)get_path()->'.'
-> return head
(Pdb) 

$ ./example3.py 
> /code/example3.py(14)<module>()
-> filename_path = get_path(filename)
(Pdb) s
--Call--
> /code/example3.py(6)get_path()
-> def get_path(filename):
(Pdb) ll
  6  -> def get_path(filename):
  7         """Return file's path or empty string if no path."""
  8         head, tail = os.path.split(filename)
  9         return head
(Pdb) 

$ ./example3.py 
> /code/example3.py(14)<module>()
-> filename_path = get_path(filename)
(Pdb) l
  9         return head
 10     
 11     
 12     filename = __file__
 13     import pdb; pdb.set_trace()
 14  -> filename_path = get_path(filename)
 15     print(f'path = {filename_path}')
[EOF]
(Pdb) l
[EOF]
(Pdb) l .
  9         return head
 10     
 11     
 12     filename = __file__
 13     import pdb; pdb.set_trace()
 14  -> filename_path = get_path(filename)
 15     print(f'path = {filename_path}')
[EOF]
(Pdb) 

b(reak) [ ([filename:]lineno | function) [, condition] ]

#!/usr/bin/env python3

import util

filename = __file__
import pdb; pdb.set_trace()
filename_path = util.get_path(filename)
print(f'path = {filename_path}')

def get_path(filename):
    """Return file's path or empty string if no path."""
    import os
    head, tail = os.path.split(filename)
    return head

$ ./example4.py 
> /code/example4.py(7)<module>()
-> filename_path = util.get_path(filename)
(Pdb) b util:5
Breakpoint 1 at /code/util.py:5
(Pdb) c
> /code/util.py(5)get_path()
-> return head
(Pdb) p filename, head, tail
('./example4.py', '.', 'example4.py')
(Pdb) 

$ ./example4.py 
> /code/example4.py(7)<module>()
-> filename_path = util.get_path(filename)
(Pdb) b util.get_path
Breakpoint 1 at /code/util.py:1
(Pdb) c
> /code/util.py(3)get_path()
-> import os
(Pdb) p filename
'./example4.py'
(Pdb) 

(Pdb) b
Num Type         Disp Enb   Where
1   breakpoint   keep yes   at /code/util.py:1
(Pdb) 

(Pdb) disable 1
Disabled breakpoint 1 at /code/util.py:1
(Pdb) b
Num Type         Disp Enb   Where
1   breakpoint   keep no    at /code/util.py:1
(Pdb) enable 1
Enabled breakpoint 1 at /code/util.py:1
(Pdb) b
Num Type         Disp Enb   Where
1   breakpoint   keep yes   at /code/util.py:1
(Pdb) 

cl(ear) filename:lineno
cl(ear) [bpnumber [bpnumber...]]

$ ./example4.py 
> /code/example4.py(7)<module>()
-> filename_path = util.get_path(filename)
(Pdb) b util.get_path, not filename.startswith('/')
Breakpoint 1 at /code/util.py:1
(Pdb) c
> /code/util.py(3)get_path()
-> import os
(Pdb) a
filename = './example4.py'
(Pdb) 

$ ./example4.py 
> /code/example4.py(7)<module>()
-> filename_path = util.get_path(filename)
(Pdb) b util:5, not head.startswith('/')
Breakpoint 1 at /code/util.py:5
(Pdb) c
> /code/util.py(5)get_path()
-> return head
(Pdb) p head
'.'
(Pdb) a
filename = './example4.py'
(Pdb) 

#!/usr/bin/env python3

import os


def get_path(fname):
    """Return file's path or empty string if no path."""
    import pdb; pdb.set_trace()
    head, tail = os.path.split(fname)
    for char in tail:
        pass  # Check filename char
    return head


filename = __file__
filename_path = get_path(filename)
print(f'path = {filename_path}')

$ ./example4unt.py 
> /code/example4unt.py(9)get_path()
-> head, tail = os.path.split(fname)
(Pdb) ll
  6     def get_path(fname):
  7         """Return file's path or empty string if no path."""
  8         import pdb; pdb.set_trace()
  9  ->     head, tail = os.path.split(fname)
 10         for char in tail:
 11             pass  # Check filename char
 12         return head
(Pdb) unt
> /code/example4unt.py(10)get_path()
-> for char in tail:
(Pdb) 
> /code/example4unt.py(11)get_path()
-> pass  # Check filename char
(Pdb) 
> /code/example4unt.py(12)get_path()
-> return head
(Pdb) p char, tail
('y', 'example4unt.py')

$ ./example4display.py 
> /code/example4display.py(9)get_path()
-> head, tail = os.path.split(fname)
(Pdb) ll
  6     def get_path(fname):
  7         """Return file's path or empty string if no path."""
  8         import pdb; pdb.set_trace()
  9  ->     head, tail = os.path.split(fname)
 10         for char in tail:
 11             pass  # Check filename char
 12         return head
(Pdb) b 11
Breakpoint 1 at /code/example4display.py:11
(Pdb) c
> /code/example4display.py(11)get_path()
-> pass  # Check filename char
(Pdb) display char
display char: 'e'
(Pdb) c
> /code/example4display.py(11)get_path()
-> pass  # Check filename char
display char: 'x'  [old: 'e']
(Pdb) 
> /code/example4display.py(11)get_path()
-> pass  # Check filename char
display char: 'a'  [old: 'x']
(Pdb) 
> /code/example4display.py(11)get_path()
-> pass  # Check filename char
display char: 'm'  [old: 'a']

$ ./example4display.py 
> /code/example4display.py(9)get_path()
-> head, tail = os.path.split(fname)
(Pdb) ll
  6     def get_path(fname):
  7         """Return file's path or empty string if no path."""
  8         import pdb; pdb.set_trace()
  9  ->     head, tail = os.path.split(fname)
 10         for char in tail:
 11             pass  # Check filename char
 12         return head
(Pdb) b 11
Breakpoint 1 at /code/example4display.py:11
(Pdb) c
> /code/example4display.py(11)get_path()
-> pass  # Check filename char
(Pdb) display char
display char: 'e'
(Pdb) display fname
display fname: './example4display.py'
(Pdb) display head
display head: '.'
(Pdb) display tail
display tail: 'example4display.py'
(Pdb) c
> /code/example4display.py(11)get_path()
-> pass  # Check filename char
display char: 'x'  [old: 'e']
(Pdb) display
Currently displaying:
char: 'x'
fname: './example4display.py'
head: '.'
tail: 'example4display.py'

Python Caller ID

在最后一节中，我们将建立在我们迄今为止所学的基础上，并以不错的回报结束。我使用名称“来电显示”来指代电话系统的来电显示功能。这正是本示例演示的内容，只是它应用于 Python。

这是主脚本的来源example5.py：

#!/usr/bin/env python3

import fileutil


def get_file_info(full_fname):
    file_path = fileutil.get_path(full_fname)
    return file_path


filename = __file__
filename_path = get_file_info(filename)
print(f'path = {filename_path}')

这是实用程序模块fileutil.py：

def get_path(fname):
    """Return file's path or empty string if no path."""
    import os
    import pdb; pdb.set_trace()
    head, tail = os.path.split(fname)
    return head

在这种情况下，假设有一个大型代码库，其中包含一个实用程序模块中的函数，get_path()使用无效输入调用该函数。但是，它是从不同包中的许多地方调用的。

How do you find who the caller is?

使用命令w(where) 打印堆栈跟踪，最新的帧位于底部：

$ ./example5.py 
> /code/fileutil.py(5)get_path()
-> head, tail = os.path.split(fname)
(Pdb) w
  /code/example5.py(12)<module>()
-> filename_path = get_file_info(filename)
  /code/example5.py(7)get_file_info()
-> file_path = fileutil.get_path(full_fname)
> /code/fileutil.py(5)get_path()
-> head, tail = os.path.split(fname)
(Pdb) 

如果这看起来令人困惑，或者您不确定堆栈跟踪或框架是什么，请不要担心。我将在下面解释这些术语。这并不像听起来那么困难。

由于最近的帧在底部，从那里开始并从下往上阅读。查看以 开头的行->，但跳过第一个实例，因为它pdb.set_trace()是用于在函数中输入 pdb 的位置get_path()。在此示例中，调用该函数的源代码行get_path()是：

-> file_path = fileutil.get_path(full_fname)

每个上面的行->包含文件名、行号（在括号中）和源行所在的函数名。所以调用者是：

  /code/example5.py(7)get_file_info()
-> file_path = fileutil.get_path(full_fname)

在这个用于演示目的的小示例中，这并不奇怪，但想象一下一个大型应用程序，您在其中设置了一个带有条件的断点，以确定错误输入值的来源。

现在我们知道如何找到调用者了。

但是这个堆栈跟踪和框架的东西呢？

一个堆栈跟踪只是所有的Python已经创建的跟踪函数调用的帧列表。框架是 Python 在调用函数时创建并在函数返回时删除的数据结构。堆栈只是在任何时间点的帧或函数调用的有序列表。（函数调用）堆栈在应用程序的整个生命周期中随着函数被调用然后返回而增长和缩小。

打印时，这个有序的帧列表，即堆栈，称为堆栈跟踪。您可以随时通过输入命令来查看它w，就像我们在上面找到调用者一样。

有关详细信息，请参阅维基百科上的此调用堆栈文章。

为了更好地理解并充分利用 pdb，让我们更仔细地查看以下帮助w：

(Pdb) h w
w(here)
        Print a stack trace, with the most recent frame at the bottom.
        An arrow indicates the "current frame", which determines the
        context of most commands. 'bt' is an alias for this command.

pdb 的“当前帧”是什么意思？

将当前帧视为 pdb 已停止执行的当前函数。换句话说，当前帧是您的应用程序当前暂停的位置，并用作 pdb 命令p（如(print)）的“参考帧” 。

p和其他命令将在需要时使用当前帧作为上下文。在 的情况下p，当前帧将用于查找和打印变量引用。

当 pdb 打印堆栈跟踪时，箭头>指示当前帧。

这有什么用？

您可以使用u（向上）和d（向下）两个命令来更改当前帧。结合p，这允许您在任何帧中调用堆栈的任何点检查应用程序中的变量和状态。

以下是这两个命令的语法和说明：

让我们看一个使用uandd命令的例子。在这种情况下，我们要检查变量full_fname局部于功能get_file_info()在example5.py。为此，我们必须使用以下命令将当前帧向上更改一级u：

$ ./example5.py 
> /code/fileutil.py(5)get_path()
-> head, tail = os.path.split(fname)
(Pdb) w
  /code/example5.py(12)<module>()
-> filename_path = get_file_info(filename)
  /code/example5.py(7)get_file_info()
-> file_path = fileutil.get_path(full_fname)
> /code/fileutil.py(5)get_path()
-> head, tail = os.path.split(fname)
(Pdb) u
> /code/example5.py(7)get_file_info()
-> file_path = fileutil.get_path(full_fname)
(Pdb) p full_fname
'./example5.py'
(Pdb) d
> /code/fileutil.py(5)get_path()
-> head, tail = os.path.split(fname)
(Pdb) p fname
'./example5.py'
(Pdb) 

该呼叫pdb.set_trace()是在fileutil.py该函数get_path()，因此当前帧的初始设置那里。您可以在上面的第一行输出中看到它：

> /code/fileutil.py(5)get_path()

为了访问和打印full_fname函数get_file_info()中的局部变量example5.py，该命令u用于向上移动一级：

(Pdb) u
> /code/example5.py(7)get_file_info()
-> file_path = fileutil.get_path(full_fname)

请注意，在u上面的输出中，pdb>在第一行的开头打印了箭头。这是 pdb，让您知道框架已更改，并且此源位置现在是当前框架。full_fname现在可以访问该变量。此外，重要的是要意识到从->第 2 行开始的源代码行已被执行。由于帧被向上移动到堆栈中，fileutil.get_path()因此被调用。使用u，我们搬到了堆栈（从某种意义上说，早在时间）的功能example5.get_file_info()在那里fileutil.get_path()被调用。

继续这个例子，在full_fname被打印之后，当前帧使用 移动到它的原始位置d，并且局部变量fnameinget_path()被打印。

如果我们愿意，我们可以通过将count参数传递给uor来一次移动多个帧d。例如，我们可以example5.py通过输入u 2以下内容进入模块级别：

$ ./example5.py 
> /code/fileutil.py(5)get_path()
-> head, tail = os.path.split(fname)
(Pdb) u 2
> /code/example5.py(12)<module>()
-> filename_path = get_file_info(filename)
(Pdb) p filename
'./example5.py'
(Pdb) 

当您进行调试和思考许多不同的事情时，很容易忘记您身在何处。请记住，您始终可以使用恰当命名的命令w(where) 来查看执行暂停的位置以及当前帧是什么。

此外，如果您想尝试基于 GUI 的 Python 调试器，请阅读我们的Python IDE 和编辑器指南，了解哪些选项最适合您。