Python YAML 模块实战：接口测试参数存储与配置

读取 YAML 文件数据

根据指定键读取 YAML 文件中的对应值。加载时建议使用 safe_load 以确保安全性。

import yaml
import os

def read_yaml(filename, key):
    file_path = os.getcwd() + "/data/" + filename
    with open(file_path, encoding="utf-8", mode="r") as f:
        # 安全加载 YAML 数据
        data = yaml.safe_load(f)
        # 返回指定键对应的值
        return data[key]

清空 YAML 文件

清空指定 YAML 文件中的所有内容，通常用于重置测试数据。

import os

def clear_yaml(filename):
    file_path = os.getcwd() + "/data/" + filename
    with open(file_path, encoding="utf-8", mode="w") as f:
        # 清空文件内容
        f.truncate()

完整使用示例

下面是一个整合了写入、读取和清空功能的测试脚本，可以直接运行验证效果。

import yaml
import os

# 追加写入
def write_yaml(filename, data):
    file_path = os.getcwd() + "/data/" + filename
    with open(file_path, encoding="utf-8", mode="a+") as f:
        yaml.safe_dump(data, stream=f, allow_unicode=True)

# 读取
def read_yaml(filename, key):
    file_path = os.getcwd() + "/data/" + filename
    with open(file_path, encoding="utf-8", mode="r") as f:
        data = yaml.safe_load(f)
        return data[key]

# 清空
def clear_yaml(filename):
    file_path = os.getcwd() + "/data/" + filename
    with open(file_path, encoding="utf-8", mode="w") as f:
        f.truncate()

# 测试函数
def test_yml():
    # 1. 写入 YAML 文件（数据为字典类型）
    data = {"str": "12345", "user": "zhangsan", "password": "123456"}
    write_yaml('test.yml', data)

    # 2. 读取 YAML 文件中 "str" 键对应的值
    ret = read_yaml('test.yml', "str")
    print("读取结果:", ret)  # 输出：读取结果：12345

    # 3. 清空 YAML 文件
    clear_yaml('test.yml')

if __name__ == "__main__":
    test_yml()

关键说明

• 安全写入：推荐使用 yaml.safe_dump()，避免执行恶意代码，而非 yaml.dump()；
• 安全加载：同样推荐 yaml.safe_load()，防范潜在的安全风险，避免使用 yaml.load()；
• 文件路径：示例中默认将 YAML 文件放在项目根目录的 data 文件夹下，需确保该文件夹已创建，否则会抛出文件不存在异常；
• 编码格式：指定 encoding="utf-8" 以避免中文等特殊字符出现乱码。