ruamel.yaml输出格式配置及多文档解析报错咨询

一、修复层级格式错误（避免生成列表符号） #

ruamel.yaml的默认缩进配置可能导致字典嵌套被误识别为列表，需显式配置缩进参数来匹配预期格式：

from ruamel.yaml import YAML

# 初始化YAML实例并配置缩进规则
yaml = YAML()
# mapping：字典键值对的缩进；sequence：列表项的缩进；offset：列表符号"-"的偏移
yaml.indent(mapping=2, sequence=2, offset=0)
# 强制使用块格式输出，禁用流格式
yaml.default_flow_style = False

# 示例字典数据
data = {
    "app_config": {
        "database": {
            "host": "127.0.0.1",
            "port": 3306
        },
        "plugins": ["log", "monitor"]
    }
}

# 导出到YAML文件
with open("correct_output.yaml", "w") as f:
    yaml.dump(data, f)

通过调整mapping和sequence的缩进值，可确保字典层级不会被错误解析为列表结构。

二、解决多结构字符串触发的ParserError #

当字符串包含换行、YAML特殊符号（如:, -开头）时，需强制按纯字符串解析，避免触发语法错误：

方法1：显式标记字符串类型 #

使用ruamel.yaml.scalarstring中的类包裹特殊字符串，强制YAML按字符串处理：

from ruamel.yaml import YAML
from ruamel.yaml.scalarstring import SingleQuotedScalarString

yaml = YAML()
yaml.indent(mapping=2, sequence=2, offset=0)

# 包含特殊语法的字符串用SingleQuotedScalarString包裹
data = {
    "note": SingleQuotedScalarString("- 这是带列表符号的字符串\n: 包含冒号的内容")
}

with open("safe_output.yaml", "w") as f:
    yaml.dump(data, f)

方法2：保留原始引号格式 #

开启preserve_quotes参数，让ruamel.yaml保留你定义字符串时的引号，避免自动解析内部语法：

yaml.preserve_quotes = True
# 此时直接写入带引号的字符串即可
data = {"note": "'- 带列表符号的字符串'"}

注意事项 #

• 单文档YAML无需添加---标记，多余的标记反而会触发解析错误；
• 若为多文档场景，---必须作为单独一行，前后不能有多余空格或字符。

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