如何使用ruamel.yaml为字典键添加自定义锚点后再序列化？

我有一个包含未定义别名的YAML配置文件：

base:
  foo: *args_foo
  bar: *args_bar
  fuz: fuz_val
  buz: buz_val

同时，通过CLI接收--foo（可多次指定）和--bar参数后，得到如下Python字典：

args = {}
args["foo"] = ["foo_val_1", "foo_val_2", "foo_val_3"]
args["bar"] = "bar_val"

我希望用ruamel.yaml将这个字典序列化为带自定义锚点的YAML，输出格式如下：

args:
  foo: &args_foo
  - foo_val_1
  - foo_val_2
  - foo_val_3
  bar: &args_bar "bar_val"

最终要将两个文件合并成如下内容，加载后提取base作为最终配置：

args:
  foo: &args_foo
  - foo_val_1
  - foo_val_2
  - foo_val_3
  bar: &args_bar "bar_val"
base:
  foo: *args_foo
  bar: *args_bar
  fuz: fuz_val
  buz: buz_val

想确认是否可以通过ruamel.yaml在序列化前添加锚点，若可行该如何操作？

完全可以通过ruamel.yaml实现这个需求，核心是利用ruamel.yaml的CommentedMap结构和节点锚点属性来配置，具体步骤如下：

1. 导入依赖模块 #

from ruamel.yaml import YAML
from ruamel.yaml.comments import CommentedMap

2. 处理CLI参数字典，添加自定义锚点 #

ruamel.yaml的锚点信息存储在节点对象的anchor属性中，需要先将普通字典转为CommentedMap（支持保留YAML结构元数据的有序映射），再为目标键对应的节点设置锚点名称：

yaml = YAML()
yaml.preserve_quotes = True  # 确保字符串输出保留引号格式

# CLI生成的参数字典
args_dict = {
    "foo": ["foo_val_1", "foo_val_2", "foo_val_3"],
    "bar": "bar_val"
}

# 转换为CommentedMap以支持锚点设置
args_cmap = CommentedMap(args_dict)

# 为foo和bar节点设置自定义锚点
args_cmap["foo"].anchor.value = "args_foo"
args_cmap["bar"].anchor.value = "args_bar"

3. 合并配置文档 #

加载原配置文件的base部分，和带锚点的args部分合并为一个完整文档：

# 加载原base配置文件
with open("base_config.yaml", "r") as f:
    base_doc = yaml.load(f)

# 构建合并后的文档
merged_doc = CommentedMap()
merged_doc["args"] = args_cmap
merged_doc["base"] = base_doc["base"]

4. 序列化输出合并后的YAML #

直接dump即可生成符合要求的带锚点YAML：

with open("merged_config.yaml", "w") as f:
    yaml.dump(merged_doc, f)

5. 加载合并文档并提取最终配置 #

with open("merged_config.yaml", "r") as f:
    final_doc = yaml.load(f)

# 提取base作为最终配置
final_base_config = final_doc["base"]

关键注意事项 #

• 必须使用CommentedMap而非普通字典，因为普通字典无法存储ruamel.yaml需要的锚点等元数据。
• yaml.preserve_quotes = True是为了让字符串bar_val输出时保留引号，和需求格式一致。
• 锚点设置直接操作节点的anchor.value属性，序列化时ruamel.yaml会自动生成&锚点名的格式。

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