python debug

python debug

在 Python 中，查看程序的调用栈（call stack）可以帮助你调试代码，了解函数调用的顺序和上下文。以下是查看 Python 调用栈的常用方法。

1. 使用 traceback 模块

traceback 是 Python 标准库模块，可用于打印异常发生时的调用栈或程序的当前调用栈。

示例：打印当前调用栈

import traceback

def func_a():
    func_b()

def func_b():
    func_c()

def func_c():
    print("Current Call Stack:")
    traceback.print_stack()  # 打印当前调用栈

func_a()

============================================
输出示例：

Current Call Stack:
  File "example.py", line 11, in <module>
    func_a()
  File "example.py", line 4, in func_a
    func_b()
  File "example.py", line 7, in func_b
    func_c()
  File "example.py", line 10, in func_c
    traceback.print_stack()

常用的函数：
traceback.print_stack(): 打印当前调用栈。
traceback.format_stack(): 返回调用栈的字符串列表，可以在日志中记录。

2. 使用 inspect 模块

inspect 模块可以提供对调用栈的详细信息，包括函数名、文件名、行号等。

示例：获取并打印当前调用栈

import inspect

def func_a():
    func_b()

def func_b():
    func_c()

def func_c():
    stack = inspect.stack()
    print("Current Call Stack:")
    for frame in stack:
        print(f"Function: {frame.function}, Line: {frame.lineno}, File: {frame.filename}")

func_a()

=====================================================
输出示例：

Current Call Stack:
Function: func_c, Line: 10, File: example.py
Function: func_b, Line: 7, File: example.py
Function: func_a, Line: 4, File: example.py
Function: <module>, Line: 13, File: example.py

常用的函数：
inspect.stack(): 获取调用栈，返回一个 FrameInfo 对象列表。
inspect.currentframe(): 获取当前帧对象，配合 .f_back 可以遍历调用栈。

3. 在异常处理时查看调用栈

当程序抛出异常时，可以通过 traceback 查看异常发生时的调用栈。

示例：捕获异常并打印调用栈

import traceback

def func_a():
    func_b()

def func_b():
    func_c()

def func_c():
    raise ValueError("An error occurred!")

try:
    func_a()
except Exception as e:
    print("Exception Call Stack:")
    traceback.print_exc()  # 打印异常的调用栈

========================================
输出示例：

Exception Call Stack:
Traceback (most recent call last):
  File "example.py", line 13, in <module>
    func_a()
  File "example.py", line 4, in func_a
    func_b()
  File "example.py", line 7, in func_b
    func_c()
  File "example.py", line 10, in func_c
    raise ValueError("An error occurred!")
ValueError: An error occurred!

4. 使用 sys 模块获取调用栈

sys 模块也可用于直接访问调用栈的帧对象。

示例：获取调用栈帧

import sys

def func_a():
    func_b()

def func_b():
    func_c()

def func_c():
    print("Current Call Stack:")
    frame = sys._getframe()
    while frame:
        print(f"Function: {frame.f_code.co_name}, Line: {frame.f_lineno}, File: {frame.f_code.co_filename}")
        frame = frame.f_back  # 回溯到上一帧

func_a()
============================================
输出示例：
Current Call Stack:
Function: func_c, Line: 10, File: example.py
Function: func_b, Line: 7, File: example.py
Function: func_a, Line: 4, File: example.py
Function: <module>, Line: 13, File: example.py

注意：
sys._getframe() 是一个内部方法，官方建议仅在调试或工具开发时使用。

5. 使用调试器查看调用栈

调试器工具（如 pdb 或 ipdb）可以暂停程序执行并允许你交互式查看调用栈。

示例：使用 pdb

import pdb

def func_a():
    func_b()

def func_b():
    func_c()

def func_c():
    pdb.set_trace()  # 设置断点

func_a()

=================================================
示例输出：
-> func_c()
(Pdb) where
  /path/to/example.py(13)<module>()
  /path/to/example.py(4)func_a()
  /path/to/example.py(7)func_b()
  /path/to/example.py(10)func_c()

运行程序后，调试器会暂停在 pdb.set_trace() 位置，你可以使用以下命令查看调用栈：

输入 where 或 w：显示调用栈。
输入 up：向上移动一帧。
输入 down：向下移动一帧。

总结

• traceback 模块：快速打印当前或异常时的调用栈。
• inspect 模块：获取调用栈的详细信息，适合调试和分析。
• sys 模块：直接访问帧对象，适合低级调用栈操作。
• 调试工具（如 pdb）：交互式查看调用栈，适合实时调试。