【Python】如何在samconfig.yml中以List (array)格式编写CommaDelimitedList

📅 发布日: 2025/02/09, 更新日: 2025/02/09 ⏱️ 预计阅读时间约2分钟 (915字)

在SAM CLI中使用samconfig.yml部署时，如果以CommaDelimitedList Type编写参数，则必须将其写为字符串。
如果有许多元素，将其写为字符串将使其更长且更难读取。
由于CommaDelimitedList以数组格式编写在samconfig.yml中，因此转换过程已在Python中实现，因此我们将解释如何执行此操作。

编码标准和先决条件
使用 samconfig.yml 将 CommadelimitedList 转换为列表格式的过程
（额外）部署 CloudFormation 时从 YAML 文件生成 –cli-input-json 的 JSON 文件

编码标准和先决条件

本文引用的Python脚本符合PEP8。
他们使用 flake8 进行语法检查，使用 black 进行自动格式化。
由于处理原因必须忽略检查的代码包括“#noqa”。
最大行长度（ max-line-length ）设置为 200 个字符。
Python运行时版本为3.12.1，兼容性已测试。

使用 samconfig.yml 将 CommadelimitedList 转换为列表格式的过程

所需的模块是：
argparse 是标准库的一部分，因此不需要额外安装。

pyyaml

以下 Python 脚本将 samconfig.yml 中的 parameter_overrides 值从数组格式转换为 CommadelimitedList 格式。使用适当的 Python 文件名保存它（例如“transform_parameter_overrides.py”）。
由于无法在 SAM CLI 选项之间切换，因此请将此脚本合并到您的执行过程或 CI/CD 管道中。

import yaml
import argparse

def is_already_transformed(overrides):
    return all(isinstance(item, str) and "=" in item for item in overrides)

def transform_parameter_overrides(data):
    for key, value in data.items():
        if isinstance(value, dict) and "global" in value and "parameters" in value["global"]:
            parameters = value["global"]["parameters"]
            if "parameter_overrides" in parameters:
                if not is_already_transformed(parameters["parameter_overrides"]):
                    new_overrides = []
                    for override in parameters["parameter_overrides"]:
                        if isinstance(override, dict):
                            for k, v in override.items():
                                if isinstance(v, list):
                                    v = ",".join(v)
                                new_overrides.append(f"{k}={v}")
                    parameters["parameter_overrides"] = new_overrides
    return data

def main(input_file, output_file):
    with open(input_file, "r") as f:
        data = yaml.safe_load(f)

    transformed_data = transform_parameter_overrides(data)

    with open(output_file, "w") as f:
        yaml.dump(transformed_data, f, default_flow_style=False, sort_keys=False)

if __name__ == "__main__":
    parser = argparse.ArgumentParser(description="Transform parameter overrides in a YAML file.")
    parser.add_argument("--input-file", help="Path to the input YAML file.", default="samconfig.original.yml")
    parser.add_argument("--output-file", help="Path to the output YAML file.", default="samconfig.yml")
    args = parser.parse_args()

    main(args.input_file, args.output_file)

这是如何运行脚本的示例。例如，将以 List 格式编写的 samconfig.original.yml 文件转换为 samconfig.yml ：
该脚本使用这些作为默认值，因此您可以在不指定任何参数的情况下运行它。
如果需要，请在运行脚本时指定文件路径作为参数。

python transform_parameter_overrides.py

下面是 samconfig.original.yml 的示例。转换此文件将生成“samconfig.yml”。

version: 0.1
dev:
  global:
    parameters:
      parameter_overrides:
        - Environment: dev
        - Whitelist:
            # Windows Update
            # reference: https://learn.microsoft.com/en-us/windows-server/administration/windows-server-update-services/deploy/2-configure-wsus#211-configure-your-firewall-to-allow-your-first-wsus-server-to-connect-to-microsoft-domains-on-the-internet
            - .windowsupdate.microsoft.com
            - .update.microsoft.com
            - .windowsupdate.com
            - download.microsoft.com
            - .download.windowsupdate.com
            - wustat.windows.com
            - ntservicepack.microsoft.com
            - go.microsoft.com
            - dl.delivery.mp.microsoft.com
            - .delivery.mp.microsoft.com
            - .microsoft.com

下面是转换后的 samconfig.yml 的示例。您可以看到 Whitelist 的值已转换为 CommadelimitedList 格式。

version: 0.1
dev:
  global:
    parameters:
      parameter_overrides:
      - Environment=dev
      - Whitelist=.windowsupdate.microsoft.com,.update.microsoft.com,.windowsupdate.com,download.microsoft.com,.download.windowsupdate.com,wustat.windows.com,ntservicepack.microsoft.com,go.microsoft.com,dl.delivery.mp.microsoft.com,.delivery.mp.microsoft.com,.microsoft.com

（额外）部署 CloudFormation 时从 YAML 文件生成 –cli-input-json 的 JSON 文件

部署CloudFormation时，您可以提供参数作为外部文件，并使用“–cli-input-json”选项指定JSON文件。从 YAML 文件生成此 JSON 文件的过程如下。
所需的模块是：
argparse 是标准库的一部分，因此不需要额外安装。

pyyaml
json

以下 Python 脚本将 parameter.original.yml 中的 Parameters 值转换为 JSON 文件，以便与 --cli-input-json 一起使用。使用适当的 Python 文件名保存它（例如“transform_parameters.py”）。

import yaml
import json
import argparse

def transform_parameters(data):
    if "Parameters" in data:
        new_parameters = []
        for param in data["Parameters"]:
            for key, value in param.items():
                if isinstance(value, list):
                    value = ",".join(value)
                new_parameters.append({"ParameterKey": key, "ParameterValue": value})
        data["Parameters"] = new_parameters
    return data

def main(input_file, output_file):
    with open(input_file, "r") as f:
        data = yaml.safe_load(f)

    transformed_data = transform_parameters(data)

    with open(output_file, "w") as f:
        json.dump(transformed_data, f, indent=4)

if __name__ == "__main__":
    parser = argparse.ArgumentParser(description="Transform parameters in a YAML file.")
    parser.add_argument("--input-file", help="Path to the input YAML file.", default="parameter.original.yml")
    parser.add_argument("--output-file", help="Path to the output JSON file.", default="parameter.json")
    args = parser.parse_args()

    main(args.input_file, args.output_file)

这是如何运行脚本的示例。例如，要将 YAML 格式的 parameter.original.yml 转换为 parameter.json ：
该脚本使用这些作为默认值，因此您可以在不指定任何参数的情况下运行它。
如果需要，请在运行脚本时指定文件路径作为参数。

python transform_parameters.py

下面是 parameter.original.yml 的示例。转换此文件将生成“parameter.json”。

Parameters:
  Environment:
    - dev
  Whitelist:
    - .windowsupdate.microsoft.com
    - .update.microsoft.com
    - .windowsupdate.com
    - download.microsoft.com
    - .download.windowsupdate.com
    - wustat.windows.com
    - ntservicepack.microsoft.com
    - go.microsoft.com
    - dl.delivery.mp.microsoft.com
    - .delivery.mp.microsoft.com
    - .microsoft.com

下面是转换后的“parameter.json”示例。可以看到 Parameters 的值已经转换为 --cli-input-json 需要的JSON文件格式。

{
    "Parameters": [
        {
            "ParameterKey": "Environment",
            "ParameterValue": "dev"
        },
        {
            "ParameterKey": "Whitelist",
            "ParameterValue": ".windowsupdate.microsoft.com,.update.microsoft.com,.windowsupdate.com,download.microsoft.com,.download.windowsupdate.com,wustat.windows.com,ntservicepack.microsoft.com,go.microsoft.com,dl.delivery.mp.microsoft.com,.delivery.mp.microsoft.com,.microsoft.com"
        }
    ]
}