Python写入YAML文件执行dump时如何保留原有注释

原生PyYAML库的解析逻辑默认不会将注释纳入语法树，加载阶段就会把所有注释直接丢弃，内存中存储的解析结果完全不包含注释相关信息，后续dump写入时自然无法还原原有注释，这个问题无法通过调整PyYAML的dump参数解决。

优先使用ruamel.yaml替代原生PyYAML，这个库专门提供了往返（round-trip）解析模式，加载时会完整保留文件中的注释、原有缩进、引号风格、键顺序等格式信息，修改数据后写入可以1:1还原原有注释，不需要自己写额外的注释处理逻辑。

• 第一步安装依赖：
  执行命令安装：pip install ruamel.yaml
• 代码实现示例：

from ruamel.yaml import YAML

# 初始化实例，默认开启往返模式，自动保留格式与注释
yaml = YAML()
config_path = "你的配置文件路径.yaml"

# 加载原有YAML文件
with open(config_path, "r", encoding="utf-8") as f:
    config = yaml.load(f)

# 直接在加载得到的config对象上增删改数据即可，不要转成原生dict
config["NEW_CONFIG_KEY"] = "你的新增配置值"

# 写回文件，原有#hello这类注释会完整保留
with open(config_path, "w", encoding="utf-8") as f:
    yaml.dump(config, f)

注意：加载得到的config是库自定义的类字典结构，不要手动转成Python原生dict，转换操作会丢失所有绑定的注释和格式信息。

如果项目强制要求使用原生PyYAML不能替换依赖，只能自行实现注释保留逻辑：在PyYAML加载文件前，先逐行扫描原文件，记录所有注释的行位置、内容以及注释关联的YAML节点，等PyYAML完成dump生成新内容后，再按照记录的位置把注释插回新文件中。这个方案适配成本很高，面对复杂嵌套结构、行尾注释等场景很容易出现位置错位，非必要不推荐使用。

另外你示例中写的KB_PROJECT = MHV不属于标准YAML语法（标准YAML键值对用:分隔，即KB_PROJECT: MHV），无论用哪个库处理，都需要先把这类非标准写法修正为合规YAML格式才能正常解析。

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