ruamel.yaml导出时能否强制在块之间添加空行？

你遇到的空行丢失问题，核心原因是代码把ruamel.yaml加载的CommentedMap（保留格式信息的特殊字典类型）转换成了普通Python字典，导致原本存储的空行、注释等格式元数据全部丢失。

ruamel.yaml加载YAML文件时，默认会用CommentedMap替代普通dict，用CommentedList替代普通list，这些类型内部保存了键的顺序、块间空行、注释等格式信息。你的rename_key方法通过字典推导式或生成新字典返回，直接丢弃了这些元数据，所以dump时自然无法保留原有的空行。

解决方案：直接操作原格式数据结构 #

修改代码，确保在CommentedMap/CommentedList上直接修改键名，不转换为普通dict/list，完整保留格式元数据。

修改后的完整代码

from pathlib import Path
from typing import Any
from ruamel.yaml import YAML
from ruamel.yaml.comments import CommentedMap, CommentedList

class YAMLKeyRenamer:
    @staticmethod
    def rename_key(data: Any, keys: list[str], new_key: str) -> Any:
        """
        递归重命名嵌套字典/列表中的指定层级键，保留原有顺序和格式元数据
        """
        if len(keys) == 1:
            target_key = keys[0]
            if isinstance(data, CommentedMap):
                # 直接在CommentedMap上修改键名，保留顺序和格式
                if target_key in data:
                    # 弹出原键值，插入新键到原位置
                    value = data.pop(target_key)
                    # 获取原键的位置索引
                    idx = list(data.keys()).index(target_key)
                    data.insert(idx, new_key, value)
                return data
            elif isinstance(data, CommentedList) or isinstance(data, list):
                for item in data:
                    YAMLKeyRenamer.rename_key(item, keys, new_key)
                return data
            else:
                return data

        current_key = keys[0]
        if isinstance(data, CommentedMap):
            if current_key in data:
                # 递归处理子节点，不替换整个字典
                YAMLKeyRenamer.rename_key(data[current_key], keys[1:], new_key)
            return data
        elif isinstance(data, CommentedList) or isinstance(data, list):
            for item in data:
                YAMLKeyRenamer.rename_key(item, keys, new_key)
            return data
        else:
            return data


    @staticmethod
    def update_yaml_file(input_file: str, output_file: str, keys_to_update: list[str], new_key: str) -> None:
        """
        修改YAML文件中的指定键，保留原有顺序、注释和空行格式
        """
        yaml = YAML()
        yaml.preserve_quotes = True
        yaml.default_flow_style = False  # 确保输出为块式YAML，而非流格式

        # 加载YAML文件，保留所有格式元数据
        with open(input_file, 'r') as file:
            yaml_data = yaml.load(file)

        # 直接在原数据结构上修改键名
        YAMLKeyRenamer.rename_key(yaml_data, keys_to_update, new_key)

        # 保存时保留原格式
        with open(output_file, 'w') as file:
            yaml.dump(yaml_data, file)

关键修改说明 #

1. 引入并判断CommentedMap/CommentedList：直接操作ruamel.yaml的原生格式类型，避免转换为普通dict/list
2. 用pop+insert修改键名：在CommentedMap中，先弹出原键值，再插入新键到原位置，既保留了键的顺序，又不会丢失该键关联的格式元数据（比如前后空行）
3. 递归修改而非生成新数据：不再返回新的字典/列表，而是直接修改传入的原数据结构，确保所有格式信息被保留

额外注意事项 #

• 不要使用字典推导式（{...}）或列表推导式生成新结构，这会丢失CommentedMap/CommentedList的元数据
• 如果你的YAML文件包含注释，这种方式也能一并保留，因为CommentedMap内部存储了注释信息
• 确保使用最新版ruamel.yaml，旧版本可能在格式保留上存在bug

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