Python 3.11处理Kubernetes ConfigMap往返序列化保留格式问题

核心原因 #

原生PyYAML在序列化多行字符串时，默认会将其转换为带转义字符的双引号字符串，无法保留ConfigMap中data字段原本的块折叠标量（|-）格式。

推荐解决方案：使用ruamel.yaml #

ruamel.yaml专为YAML往返处理设计，能精准保留原始YAML的格式、引号和块结构，是处理Kubernetes资源的更优选择。

步骤1：安装依赖 #

pip install ruamel.yaml

步骤2：示例代码 #

from ruamel.yaml import YAML

# 初始化YAML对象，启用往返模式并保留原格式
yaml = YAML(typ='rt')
yaml.preserve_quotes = True

# 加载原始ConfigMap文件
with open('configmap.yaml', 'r') as f:
    config_map = yaml.load(f)

# 执行你的修改操作（示例：添加标签）
config_map['metadata']['labels'] = {'app': 'demo'}

# 转储回文件，保留块标量格式
with open('modified_configmap.yaml', 'w') as f:
    yaml.dump(config_map, f)

备选方案：自定义PyYAML表示器（不推荐） #

如果必须使用原生PyYAML，可以通过自定义字符串表示器强制将多行序列化为块标量，但此方法无法区分原生块标量和普通多行字符串，兼容性较差：

import yaml

def multi_line_str_presenter(dumper, data):
    # 对包含换行符的字符串使用块标量格式
    if '\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.add_representer(str, multi_line_str_presenter)

# 加载并修改ConfigMap
with open('configmap.yaml', 'r') as f:
    config_map = yaml.load(f, Loader=yaml.FullLoader)

# 执行修改操作...

# 转储文件
with open('modified_configmap.yaml', 'w') as f:
    yaml.dump(config_map, f, default_flow_style=False)

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