Python traceback.TracebackException 怎样保留异常链上下文

如果异常要跨出当前 except 块，交给队列、任务结果或延迟日志处理，直接保存异常对象往往会把 traceback 和帧对象一起带到更晚的生命周期。traceback.TracebackException 提供了一个更合适的中间层：在捕获边界把异常信息转换成可延迟格式化的快照，同时保留 __cause__、__context__ 等异常链关系。

官方文档：https://docs.python.org/3/library/traceback.html#traceback.TracebackException

实用写法是先调用 TracebackException.from_exception(exc, capture_locals=False)，需要输出时再用 ''.join(snapshot.format(chain=True)) 格式化。这样既能保留异常链，也不会把原始 traceback 当作长期缓存对象。

先把异常转换成可延迟格式化的快照

TracebackException 的用途不是替换 except，而是把“捕获异常”和“生成文本”拆开。官方文档说明，它保存的是稍后打印所需的信息，不必继续持有实际的异常与 traceback 对象；这对异步任务、批量处理和统一日志出口尤其有用。

from traceback import TracebackException

def capture_failure(task_name: str, action):
    # 只在捕获边界接触原始异常，保存轻量快照供后续处理。
    try:
        return action()
    except Exception as exc:
        # 默认不抓取 locals，避免把口令、令牌或大对象带入日志快照。
        snapshot = TracebackException.from_exception(exc, capture_locals=False)
        return {"task": task_name, "traceback": snapshot}

def render_failure(result: dict) -> str:
    # format 返回可迭代的文本片段，拼接后才得到完整 traceback 文本。
    snapshot = result["traceback"]
    return "".join(snapshot.format(chain=True))

这里的关键是返回快照而不是返回 exc。调用方仍然可以在当前边界记录任务名、错误码等业务字段，稍后再决定写入文件、消息或标准日志。若只需要立即显示，直接使用 traceback.format_exception() 也可以，不必为了短代码强行创建快照。

用 chain=True 保留显式和隐式异常链

Python 的异常链有两条常见来源：使用 raise ... from exc 形成显式 __cause__，以及在处理一个异常时又抛出另一个异常形成隐式 __context__。TracebackException 会把这些关系保存为快照字段，调用 format(chain=True) 时再按链关系输出。

from traceback import TracebackException

def load_profile() -> str:
    # 显式 from 保留“配置错误由文件错误引起”的因果关系。
    try:
        raise OSError("profile.json 不可读")
    except OSError as exc:
        raise ValueError("用户配置加载失败") from exc

try:
    load_profile()
except ValueError as exc:
    # from_exception 会把 __cause__ 和对应堆栈一起纳入快照。
    snapshot = TracebackException.from_exception(exc)
    text = "".join(snapshot.format(chain=True))

如果把 chain 改成 False，输出会收窄到当前异常；这适合只展示对用户有用的最后一层，但不适合排查“谁触发了谁”的根因。跨线程或跨任务传递时，建议保留快照，并在真正写日志的地方决定是否展开链。

不要把快照图理解成执行流程：图中各框表示对象和字段之间的静态关系，实际输出仍取决于异常是否设置了 __cause__、是否抑制上下文以及调用时的 chain 参数。

按敏感信息和日志体积选择捕获参数

默认配置通常已经足够。capture_locals=True 会把帧中的局部变量也纳入 traceback，排障更详细，但可能暴露个人数据、令牌或大型对象；生产日志除非有明确脱敏策略，否则应保持关闭。compact=True 只保存 format() 所需的紧凑数据，适合快照需要跨较长生命周期的场景。

from traceback import TracebackException

def snapshot_exception(exc: BaseException) -> TracebackException:
    # 不抓 locals，先把敏感数据暴露面控制在最小范围。
    return TracebackException.from_exception(
        exc,
        capture_locals=False,
        compact=True,
        # 限制异常组的单层宽度和嵌套深度，避免日志无限膨胀。
        max_group_width=8,
        max_group_depth=4,
    )

对于 ExceptionGroup，max_group_width 和 max_group_depth 控制格式化时展示的范围。它们不是异常处理策略，不能替代对并发任务的逐项分类；它们只负责让最终的诊断文本保持在可读大小。

封装延迟格式化函数，边界就清楚了

可以把快照和文本输出分别封装，让上游只负责捕获，下游只负责呈现。这样在测试、日志和任务结果中可以复用同一份结构，又能在不同出口选择是否展开异常链。

from traceback import TracebackException

def format_exception_later(exc: BaseException, *, include_chain: bool = True) -> str:
    # 快照不抓取 locals，避免延迟日志意外保存业务变量。
    snapshot = TracebackException.from_exception(exc, capture_locals=False)
    # 由调用方决定是否展开 cause/context，而不是在捕获点丢失信息。
    return "".join(snapshot.format(chain=include_chain))

最后可以按下面的边界做选择：需要跨生命周期保存时保存 TracebackException；只在当前异常处理分支立即输出时，可以直接使用 format_exception；需要根因链时使用 chain=True；日志可能包含敏感值时不要开启 capture_locals。

常见问题

TracebackException 会自动把异常打印出来吗？

不会。它先保存可格式化的信息，需要时调用 format() 或相应的打印方法才会产生输出。

为什么不用直接保存 exc？

长期保存原始异常可能间接保留 traceback 和帧对象；快照更适合跨任务或延迟日志边界，且可以在创建时控制是否抓取局部变量。

chain=False 会删除异常原因吗？

不会。它只影响这次格式化是否展开链，快照中的关系仍按异常本身的 cause、context 和 suppress 状态保存。

记住三个判断：先在捕获边界生成快照，再在输出边界决定是否展开链，最后根据敏感信息和日志大小选择 capture_locals、compact 及异常组深度限制。