PAYATHON 2026

如何在 GDB 中浅层打印变量,避免递归调用 pretty printer 的 children?

数据阿明

可以。在 GDB 的 Python 环境中取得变量对应的 pretty printer 后,直接调用 to_string(),可以避免代码显式调用 children()。如果只需限制输出的展开深度,可以使用 print -max-depth 0 -- myvar,但这不能保证 children() 不执行。

只调用 to_string()

在支持 Python 的 GDB 中,可以用 gdb.default_visualizer() 查找变量对应的 pretty printer;找不到时返回 None。接口说明见 Pretty Printing API。

在 GDB console 中输入以下命令。示例只输出 to_string() 返回的 Python 字符串,其他类型的返回值不会再次交给 GDB 格式化:

(gdb) python
import gdb

value = gdb.parse_and_eval("myvar")
printer = gdb.default_visualizer(value)

if printer is None:
    gdb.write("No pretty printer found.\n")
elif not callable(getattr(printer, "to_string", None)):
    gdb.write("The pretty printer has no to_string() method.\n")
else:
    result = printer.to_string()
    if isinstance(result, str):
        gdb.write(result + "\n")
    elif result is None:
        gdb.write("to_string() returned None.\n")
    else:
        gdb.write("to_string() returned a non-string value.\n")
end

这段代码没有调用 children(),也没有让 GDB 递归打印返回结果,适合单独检查摘要生成逻辑。前提是 pretty printer 的查找函数、构造过程和 to_string() 自身没有主动遍历子项或触发递归格式化。

to_string() 也可以返回 gdb.Value 等受支持的值。GDB 正常打印这类结果时,可能继续调用另一个 pretty printer。因此,不能把所有返回值都直接交给 print() 或 str(),再假定它们不会递归。直接输出字符串也不会完整复现 display_hint() 带来的引号、转义等格式。返回值规则

使用 max-depth 限制展开深度

如果想保留普通 print 的显示方式,同时隐藏子项,可以执行:

print -max-depth 0 -- myvar

-max-depth 只覆盖本次命令的打印深度。这里的 0 表示不展开顶层结构的内容;1 则允许多展开一层。使用命令选项时,需要用 -- 分隔选项和表达式。print 命令选项

也可以修改后续打印所用的设置:

show print max-depth
set print max-depth 0
print myvar

调试结束后,按 show print max-depth 显示的原值恢复。只有原值为 unlimited 时,才用 set print max-depth unlimited 恢复。打印深度设置

GDB 的 print_children 实现会先调用 children(),取得迭代器并读取子项,然后才检查深度限制。因此,设置 -max-depth 0 也不能保证 children() 不执行。如果创建迭代器或生成第一个子项时就陷入循环,深度限制可能来不及生效。GDB 实现源码

需要绕过整个 pretty printer 时

如果想检查原始字段,可以禁用本次打印使用的 pretty printers,并限制原始结构的展开深度:

print -raw-values on -max-depth 1 -- myvar

-raw-values on 会绕过 pretty printers,适合检查底层数据,但也看不到其 to_string() 摘要。raw-values 选项

调试时的注意事项

  • set print pretty off 只改变结构的排版方式,不能关闭 Python pretty printers,也不能阻止递归展开。排版设置
  • children() 应按需生成子项,避免在返回迭代器之前遍历完整数据结构。GDB 文档也建议采用惰性计算,以便打印限制减少实际工作量。children 接口说明
  • 对循环数据结构,仍应在 pretty printer 自身的遍历逻辑中处理循环。显示深度限制无法中断 Python 方法内部已经开始的无限循环。
  • 如果当前 GDB 不识别上述选项,可以用 help print 和 help set print max-depth 检查本机支持情况;直接调用 Python API 的方法要求该 GDB 构建支持 Python。

备注:内容仅供参考。