本文介绍如何使用 PyYAML 自定义字符串表示器，确保含换行符的 JSON 内容（如 Kubernetes ConfigMap 中的 data 字段）在 YAML dump 时保留 |- 多行字面量风格，避免被转义为带 \n 的单行字符串。
本文介绍如何使用 pyyaml 自定义字符串表示器，确保含换行符的 json 内容（如 kubernetes configmap 中的 `data` 字段）在 yaml dump 时保留 `|-` 多行字面量风格，避免被转义为带 `\n` 的单行字符串。
在处理 Kubernetes 资源（如 ConfigMap）时，常需用 Python 加载 YAML、修改其中嵌套的 JSON 内容（例如 data["sample.json"]），再安全地写回原格式。但默认情况下，PyYAML 会将含换行符的字符串序列化为带转义字符的双引号字符串（如 "[\n {\n \"name\": ...}"），这不仅破坏可读性，更可能导致 kubectl apply 解析失败或触发不必要的资源变更。
根本原因在于：PyYAML 默认对所有字符串统一使用 " 风格表示，而 Kubernetes YAML 模板通常依赖 |- 块字面量（literal block scalar）来保持 JSON 的原始缩进与结构。解决方法是注册自定义 representer，显式告诉 PyYAML：当字符串含换行符时，强制以 style='|' 输出为多行块格式。
以下是一个完整、可直接复用的解决方案：
import yaml
def str_presenter(dumper, data):
"""为 PyYAML 注册字符串表示器：含换行符时使用 |- 块格式"""
if isinstance(data, str) and '\n' in data:
return dumper.represent_scalar('tag:yaml.org,2002:str', data, style='|')
return dumper.represent_scalar('tag:yaml.org,2002:str', data)
# 注册到所有 YAML dumper 实例（SafeDumper、FullDumper 等均生效）
yaml.add_representer(str, str_presenter)
# 示例：模拟加载并修改后的 ConfigMap 数据
configmap = {
'apiVersion': 'v1',
'kind': 'ConfigMap',
'metadata': {'name': 'sample-map'},
'data': {
'sample.json': '[\n {\n "name": "foo",\n "description": "bar"\n }\n]'
}
}
# 安全输出 —— JSON 内容将以 |- 保持多行
print(yaml.dump(configmap, default_flow_style=False, sort_keys=False))✅ 关键要点说明：
- style='|' 启用字面量块（literal block），保留换行与空格；|-（末尾短横）自动去除末尾空白行，更符合 Kubernetes 实践。
- default_flow_style=False 禁用内联格式（如 {key: value}），确保嵌套结构清晰可读。
- sort_keys=False 防止字段顺序被重排（Kubernetes 对 apiVersion/kind 等字段顺序虽无硬性要求，但保持原始顺序利于 diff 和审查）。
- ⚠️ 注意：此方案不保证字典键的绝对插入顺序（Python 3.7+ dict 本身有序，但 PyYAML dump 仍可能重排）。若需严格保序，建议使用 collections.OrderedDict 或升级至 PyYAML >= 5.4 并配合 yaml.CSafeDumper（部分环境需额外配置）。
运行后输出将严格匹配原始风格：
apiVersion: v1
kind: ConfigMap
metadata:
name: sample-map
data:
sample.json: |-
[
{
"name": "foo",
"description": "bar"
}
]该方法已验证兼容 Python 3.11 及 PyYAML 6.x，是 Kubernetes YAML 操作场景下的稳定实践。
