Python如何利用模板变量自动生成YAML配置文件

温以宁

发布时间：2026-10-11 | 2人浏览过

原创

在自动化运维或容器编排场景中，常需基于统一标准批量生成YAML配置文件。本文介绍如何使用Python内置的string.Template结合PyYAML库，快速定义占位符模板、安全替换变量，并按原结构顺序输出新文件，有效避免手动修改易出错的问题。

核心思路与运行环境

该方法的核心流程是将静态配置抽象为含占位符的文本，利用字符串模板引擎进行安全替换，再通过YAML解析器还原为字典对象，最后序列化写入磁盘。整个过程依赖Python基础环境与以下依赖：

string.Template：Python标准库，提供安全的占位符替换功能。
PyYAML：第三方库，用于YAML格式的读写与结构化处理。

确保已执行pip install pyyaml，即可运行完整脚本。

第1步：编写带占位符的YAML模板文件

目的：将需要动态变化的参数提取为标准化变量。
入口：新建后缀为.yaml的文本文件。
动作：使用${variable}格式标记待替换字段。该写法能明确界定变量边界，避免因相邻字符导致解析歧义。
状态判断：模板文件保存后，所有可变项均被唯一占位符覆盖，不可变项保持原样。

# yaml_template.yaml
version: ${version}
services:
    ${mysql_sever_name}:
        container_name: ${mysql_container_name}
        image: mysql:8.0
        volumes:
            - ./database/oai_db2.sql:/docker-entrypoint-initdb.d/oai_db.sql
        environment:
            - MYSQL_DATABASE=oai_db
            - MYSQL_ROOT_PASSWORD=test
        healthcheck:
            test: /bin/bash -c "/tmp/mysql-healthcheck.sh"
            interval: 10s
            retries: 30
        networks:
            public_net:
                ipv4_address: ${mysql_ip}
networks:
    public_net:
        driver: bridge
        name: ${network1_name}
        ipam:
            config:
                - subnet: ${network1_subnet}
        driver_opts:
            com.docker.network.bridge.name: ${network1_driver}

第2步：调用Template读取并替换变量

目的：将内存中的模板字符串转化为实际业务参数。
入口：打开任意Python脚本文件。
动作：使用with open()读取模板内容，传入Template()实例后调用safe_substitute()方法传参替换。相比直接格式化，此方法可安全忽略未提供的占位符而不抛出异常。

from string import Template

template_path = './yaml_template.yaml'
with open(template_path, encoding='utf-8') as fp:
    read_yaml = fp.read()

tempTemplate1 = Template(read_yaml)

sub_values = {
    "mysql_container_name": "mysql1",
    "mysql_ip": "192.168.10.1",
    "mysql_sever_name": "mysql1",
    "network1_name": "demo-oai-public-net-slice4",
    "network1_subnet": "192.168.10.0/24",
    "network1_driver": '"oai-slice4"'
}

result_str = tempTemplate1.safe_substitute(sub_values)
print("替换后的原始文本：\n", result_str)

Python控制台输出的变量替换结果示意图 — 控制台打印显示指定参数已生效，未传递的参数保持占位符不变

第3步：解析字典结构并生成目标YAML文件

目的：恢复YAML原生语法层级，持久化保存到新文件。
入口：上一步替换完成后的字符串变量。
动作：先通过yaml.safe_load()将字符串重新转为Python字典，校验数据合法性；随后使用yaml.dump()导出。务必传入sort_keys=False参数，否则字典会按字母键名自动排序，打乱原有配置逻辑。
状态判断：生成目录下出现同名但值已更新的新.yaml文件，且缩进与原版一致。

import yaml

yaml_date = yaml.safe_load(result_str)
print("转换为字典对象：\n", yaml_date)

output_file = './docker-compose-basic-vpp-nrf4.yaml'
with open(output_file, 'w', encoding='utf-8') as out_fp:
    yaml.dump(yaml_date, out_fp, sort_keys=False, default_flow_style=False, allow_unicode=True)

注意事项与常见问题排查

路径兼容性：示例代码使用普通字符串路径便于演示，实际部署建议改用pathlib.Path构建跨平台兼容的路径拼接逻辑。
引号与类型：当替换值为包含空格或特殊符号的字符串时，建议在参数映射表中添加引号包裹（如'"oai-slice4"'），防止PyYAML自动转义。若字段预期为整数，请确保传入int类型而非字符串，以免服务启动时解析失败。
变量作用域：若模板中存在多层级嵌套但未全部声明占位符，直接使用substitute()可能引发KeyError，推荐始终使用safe_substitute()保留未替换项的原貌。

简要总结

通过将静态YAML配置抽离为模板，结合Python标准库与PyYAML模块，能够以极少的代码量实现配置文件的批量化、差异化生成。掌握此流程可大幅降低人工维护复杂环境清单的成本。以上就是通过Python代码根据模板修改变量生成新YAML文件的详细内容，更多关于Python自动化配置管理的资料请关注本站其它相关文章！