如何通过自定义Representer为Ruamel.yaml中指定键的列表值设置流式样式

我懂你想要的效果——不用加载后再手动递归修改样式，而是通过自定义Representer让指定键的列表值自动以流式（[item1, item2]）输出，其他内容保持默认的块式风格。其实我们可以通过扩展ruamel.yaml的Representer来实现这个需求，让序列化过程自动帮我们处理样式设置。

实现思路 #

Ruamel.yaml的Representer负责将Python对象（比如CommentedMap、CommentedSeq）转换为YAML格式。我们可以自定义一个针对CommentedMap的representer函数：在处理每个键值对时，先检查键是否在我们指定的列表中，如果对应的值是CommentedSeq，就先开启它的流式样式，再调用原本的representer逻辑完成序列化。这样就不需要额外的后处理步骤，加载后直接dump就能得到想要的格式。

完整代码示例 #

from ruamel.yaml import YAML
from ruamel.yaml.comments import CommentedMap, CommentedSeq
import sys

# 要设置为流式样式的目标键
keys_with_flow_style = ["categories", "classification"]

def custom_map_representer(dumper, data):
    # 先处理指定键的列表值
    for k, v in data.items():
        if k in keys_with_flow_style and isinstance(v, CommentedSeq):
            v.fa.set_flow_style()
            # 如果列表里还有嵌套的结构，递归处理（按需启用）
            for item in v:
                if isinstance(item, CommentedMap):
                    custom_map_representer(dumper, item)
    # 调用默认的CommentedMap representer完成序列化
    return dumper.represent_mapping('tag:yaml.org,2002:map', data.items())

# 初始化YAML实例并注册自定义representer
yaml = YAML()
yaml.Representer.add_representer(CommentedMap, custom_map_representer)

# 测试用的YAML数据
yaml_data = """
data:
  categories: 
    - CLNT
    - TXN
    - MKDT
    - REFD
    - PERS
    - CODE
  classification: 
    - RES
  description: This application processes data
"""

# 加载后直接dump，自动应用样式
loaded_data = yaml.load(yaml_data)
yaml.dump(loaded_data, sys.stdout)

代码说明 #

1. 自定义Representer函数：custom_map_representer会先遍历CommentedMap的所有键值对，找到目标键对应的CommentedSeq后，调用v.fa.set_flow_style()开启流式样式。如果你的列表里还有嵌套的CommentedMap，代码里的递归逻辑会自动处理这部分。
2. 注册Representer：通过yaml.Representer.add_representer把自定义函数绑定到CommentedMap类型上，这样序列化时会自动触发我们的样式设置逻辑。
3. 输出效果：运行代码后，你会得到预期的YAML格式：

data:
  categories: [CLNT, TXN, MKDT, REFD, PERS, CODE]
  classification: [RES]
  description: This application processes data

额外提示 #

如果你的YAML结构有更深的嵌套（比如目标键在多层字典里），这个自定义Representer也能自动处理——因为每次序列化CommentedMap时都会触发我们的逻辑，递归遍历所有层级的键值对。

备注：内容来源于stack exchange，提问作者pinkfloydfan