Python difflib.restore 怎样从差异流恢复原始文本

如果你已经用 difflib.ndiff() 生成了逐行差异，想把它还原成修改前或修改后的文本，应该使用 difflib.restore()。它的关键不是“撤销操作”，而是从带前缀的差异流中筛出第 1 份或第 2 份序列：which=1 恢复第一份，which=2 恢复第二份。

官方地址：https://docs.python.org/3/library/difflib.html

下面的示例只围绕 Python 标准库的这一条数据关系展开：先保留换行生成差异，再把生成器物化，最后分别恢复两份文本。这样可以避免差异流被第一次读取后，第二次恢复只得到空结果。

restore 的输入和 which 参数

restore(sequence, which) 接收的是 Differ.compare() 或 ndiff() 产生的差异序列。差异行通常带有两字符前缀：- 属于第一份文本，+ 属于第二份文本， 表示两边共有，? 用来提示行内差异。

restore() 会按 which 选择对应的行，并去掉差异前缀。它不是通用补丁解析器，因此不能把任意 unified diff 文本直接交给它。

先用保留换行的文本生成差异流

恢复文本时，输入是否带换行会直接影响拼接结果。文件行通常应该使用 splitlines(keepends=True)，把每行末尾的换行符保留下来；否则恢复出来的行会黏在一起，后续写回文件时也无法保持原来的行结构。

from difflib import ndiff

before = """name = \"demo\"\nmode = \"safe\"\n"""
after = """name = \"demo\"\nmode = \"fast\"\n"""

# 保留每行结尾的换行符，便于恢复后直接拼接写回文本
before_lines = before.splitlines(keepends=True)
after_lines = after.splitlines(keepends=True)

# ndiff 返回可迭代的差异流，当前还没有把结果保存成列表
delta = ndiff(before_lines, after_lines)

这里的 delta 是一个可迭代对象，而不是可以任意回放的数组。只要把它交给一次消费逻辑，后面再次读取时就可能没有内容，因此不要在需要恢复两份文本时直接复用未保存的生成器。

物化差异流后分别恢复两份文本

最稳妥的写法是先调用 list(delta) 保存所有差异行，然后分别传给 restore()。恢复函数返回的是行迭代器，使用 ''.join() 可以保留前面输入中的换行符。

from difflib import ndiff, restore

before = """name = \"demo\"\nmode = \"safe\"\n"""
after = """name = \"demo\"\nmode = \"fast\"\n"""

# 保留换行，避免恢复后多行文本被拼成一行
before_lines = before.splitlines(keepends=True)
after_lines = after.splitlines(keepends=True)

# 物化差异流，使同一份差异可以被两次读取
delta = list(ndiff(before_lines, after_lines))

# which=1 取第一份序列，which=2 取第二份序列
restored_before = ''.join(restore(delta, 1))
restored_after = ''.join(restore(delta, 2))

# 这里可以把恢复结果交给后续的比较、展示或文件写入逻辑
print(restored_before)
print(restored_after)

如果只需要其中一份，仍然可以只调用一次 restore()；如果要同时恢复两份，list() 是关键。它把一次性生成器转换成可重复遍历的列表，但也意味着差异流会占用内存，超大文本要结合文件分块或持久化格式重新设计。

为什么不能把 unified_diff 直接交给 restore

ndiff() 和 Differ.compare() 的结果是带两字符行前缀的 ndiff 风格。unified_diff() 则使用 ---、+++、@@ 等控制行，并以加号、减号表示变更。两者都是差异表达，但输入格式和消费方式不同。

如果数据来自 Git、补丁文件或其他工具导出的统一差异，不应直接调用 restore()。应先确认生产链路需要的是“从 ndiff 恢复两份序列”，还是“应用 unified diff 补丁”；后者需要对应格式的解析或补丁工具。

文件恢复时要留意的三个边界

1. 换行边界：读取文件时优先保留行尾；如果输入来自 splitlines()，要确认是否有意丢弃换行。
2. 消费边界：生成器只能顺序消费。需要恢复两份文本、重复展示差异或多次审阅时，先物化或保存原始差异流。
3. 格式边界：只有 ndiff/Differ 风格的差异适合 restore()。统一差异、上下文差异和自定义标记不能仅靠改变 which 处理。

此外，差异流中的 ? 行只是行内差异提示，并不属于任一原始序列；恢复时应让 restore() 负责筛选，不要手工把提示行拼回文本。

一份可复用的封装

如果应用层经常需要同时拿到两份文本，可以把格式约束集中到一个小函数中，让调用方不必重复处理生成器和换行。

from difflib import ndiff, restore

def restore_pair(before: str, after: str) -> tuple[str, str]:
    # 统一保留行尾，保持恢复结果适合继续写入文本文件
    before_lines = before.splitlines(keepends=True)
    after_lines = after.splitlines(keepends=True)

    # 保存差异流，避免恢复第一份后第二份没有可读内容
    delta = list(ndiff(before_lines, after_lines))

    # 返回差异流对应的两份文本，不修改原始字符串
    return (
        ''.join(restore(delta, 1)),
        ''.join(restore(delta, 2)),
    )

这个封装适合文本规模可控、需要同时展示前后版本的场景。如果文本很大，重点就不再是 restore() 的调用方式，而是差异流的存储策略、内存上限和文件编码边界。

常见问题

which 可以传字符串吗？

按官方接口约定使用 1 或 2，分别表示差异流生成前的第一份序列和第二份序列。不要把它当成文件名或任意标签。

为什么恢复结果没有换行？

通常是输入使用了 splitlines() 而不是 splitlines(keepends=True)，或者原始序列本身没有包含行尾。恢复函数不会凭空推断缺失的换行。

可以用 restore 解析 Git diff 吗？

不能直接这样假设。Git 常见输出属于统一差异格式，而 restore() 面向的是 ndiff/Differ 风格。先确认差异格式，再选择对应解析方案。

差异流很大时还要 list 吗？

如果只恢复一份，可以直接消费生成器；如果需要两份或多次读取，就必须保存可重复读取的数据。超大文本要评估内存和持久化成本，不能机械套用 list()。

记住三点即可：which=1/2 选择两份序列，保留换行决定恢复文本的形状，list(delta) 决定差异流能否被重复读取。只要输入确实来自 ndiff() 或 Differ.compare()，difflib.restore() 就能承担清晰而有限的恢复职责。