Ruamel yaml转Jinja2模板如何去除多余引号及修复序列类型异常

适用场景说明 #

本方案完全符合你的两个使用限制：

• 无需修改输入的原始YAML文件，所有处理逻辑均在内存中执行
• 完整保留Jinja嵌套引入子模板的语法，不会破坏include语句结构

各问题针对性解决方法 #

问题1：{{ name }}表达式被自动添加外层单引号 #

该问题由Ruamel YAML默认将含{等特殊字符的字符串判定为需转义字面量导致，通过自定义字符串标记规则解决：

1. 引入Ruamel内置的PlainScalarString类型，标记所有Jinja表达式为无需转义的纯文本
2. 全局配置关闭自动加引号逻辑

from ruamel.yaml import YAML
from ruamel.yaml.scalarstring import PlainScalarString

yaml = YAML()
yaml.preserve_quotes = True
yaml.quoting_style = None  # 禁用自动添加引号逻辑

def wrap_jinja_expr(val):
    # 仅处理Jinja语法开头的字符串，不影响其他内容
    if isinstance(val, str) and val.strip().startswith(('{{', '{%', '{#')):
        return PlainScalarString(val)
    return val

问题2：include语句内的单引号被转义为两个连续单引号 #

该问题由Ruamel默认对单引号字符串内部的单引号做自动转义导致，通过关闭单引号转义规则解决：

# 全局禁用单引号自动转义
yaml.escape_single_quotes = False

配合上一步的PlainScalarString标记，include语句的原始单引号会被完整保留。

问题3：CommentedSequence类型的hobbies字段导出后变为字符串 #

该问题通常由预处理逻辑误将序列类型转为字符串、或全局流式输出配置错误导致，通过保留原生序列类型解决：

1. 预处理时跳过CommentedSequence等序列类型的额外转换，保留其原生结构
2. 关闭全局流式输出配置，避免序列被压缩为单行字符串

yaml.default_flow_style = False  # 禁用全局流式输出，保留序列的多行列表格式

def preprocess_data(data):
    if isinstance(data, dict):
        return {k: preprocess_data(v) for k, v in data.items()}
    # 识别普通列表和CommentedSequence类型，保留原生结构
    elif isinstance(data, (list, tuple)) or (hasattr(data, 'yaml_tag') and data.yaml_tag == 'tag:yaml.org,2002:seq'):
        return [preprocess_data(item) for item in data]
    else:
        return wrap_jinja_expr(data)

完整使用流程 #

# 读取原始YAML文件（仅读取不修改）
with open('原始文件路径.yaml', 'r', encoding='utf-8') as f:
    raw_yaml_data = yaml.load(f)

# 内存中预处理数据
processed_data = preprocess_data(raw_yaml_data)

# 导出为Jinja2模板文件
with open('输出模板路径.j2', 'w', encoding='utf-8') as f:
    yaml.dump(processed_data, f)

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