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

向指定文件追加数据时，如果文件不存在会自动创建。注意这里使用了 safe_dump 而非 dump，这是为了防止反序列化过程中执行恶意代码。

import yaml
import os

def write_yaml(filename, data):
    # 拼接文件路径，默认保存在项目根目录的 data 文件夹下
    file_path = os.getcwd() + "/data/" + filename
    
    # 以追加模式打开，指定 utf-8 编码
    with open(file_path, encoding="utf-8", mode="a+") as f:
        # allow_unicode=True 确保中文正常显示
        yaml.safe_dump(data, stream=f, allow_unicode=True)

2. 读取 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:
        # 安全加载数据
        data = yaml.safe_load(f)
        return data[key]

3. 清空 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()

关键注意事项

1. 安全性优先：始终使用 yaml.safe_dump() 和 yaml.safe_load()。旧版的 yaml.load() 存在反序列化漏洞风险，生产环境严禁使用。
2. 路径处理：示例中使用 os.getcwd() 获取当前工作目录，请确保 data 文件夹已预先创建，否则会抛出异常。
3. 编码设置：读写时显式指定 encoding="utf-8"，避免中文或特殊字符出现乱码。
4. 缩进规范：编写 YAML 源文件时，务必使用空格而非 Tab，否则解析器会报错。