使用ruamel.yaml更新多文档YAML时的格式与修改失效问题

针对你遇到的三个问题，直接给出对应的修复方案和正确代码示例：

1. 修复第一个文档起始---缺失问题 #

ruamel.yaml 用 dump_all 输出多文档时，默认不会自动为第一个文档添加---，如果原文档第一个文档带---，需要在dump_all时指定explicit_start=True，强制输出每个文档的起始分隔符。

2. 修复字符串类型被转换问题 #

必须使用RoundTrip模式加载YAML（即typ='rt'），这个模式会精准保留原文档的标量类型、格式和顺序，避免字符串被自动转为数字/布尔值等类型。

3. 修复第三个文档修改未生效问题 #

• 加载多文档时要用load_all方法，把所有文档读取为一个列表；
• 列表索引从0开始，第三个文档对应索引2，直接修改列表中该位置的对象；
• 写入时用dump_all把修改后的文档列表完整输出。

正确代码示例 #

假设你的原YAML文件名为multi_doc.yaml，以下是完整的处理代码：

from ruamel.yaml import YAML

# 初始化RoundTrip模式的YAML对象
yaml = YAML(typ='rt')
yaml.preserve_quotes = True  # 保留原字符串的引号格式（可选）

# 读取所有文档到列表
with open('multi_doc.yaml', 'r', encoding='utf-8') as f:
    docs = list(yaml.load_all(f))

# 修改第三个文档（索引为2）
if len(docs) >= 3:
    # 示例：修改某个键值对，根据你的实际需求调整
    docs[2]['target_key'] = 'new_value'

# 写入修改后的所有文档
with open('modified_multi_doc.yaml', 'w', encoding='utf-8') as f:
    yaml.dump_all(docs, f, explicit_start=True)

关键注意事项 #

• 不要用yaml.load()（单文档加载）替代yaml.load_all()，否则只会读取第一个文档；
• 确保修改的是docs列表中索引为2的元素，不要误操作其他文档；
• yaml.preserve_quotes = True可以保留原字符串的引号（比如单引号、双引号），如果不需要可以去掉；
• RoundTrip模式默认会保留原文档的注释，无需额外设置。

内容的提问来源于stack exchange，提问作者HOSSAM