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

这里有个细节：每次调用 write_yaml 都会追加内容。如果希望覆盖整个文件，建议改用 mode="w"。

2.2 读取配置数据

读取时同样建议使用 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]

2.3 清空文件内容

有时候我们需要重置测试数据，直接清空文件是最快的方式。

import os

def clear_yaml(filename):
    file_path = os.getcwd() + "/data/" + filename
    
    with open(file_path, encoding="utf-8", mode="w") as f:
        # truncate() 方法将文件截断为空
        f.truncate()

3. 完整使用示例

将上述函数组合起来，我们可以快速验证数据的持久化效果。

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()，因为它可能执行任意 Python 代码，存在安全隐患。
2. 编码问题：显式指定 encoding="utf-8"，防止中文出现乱码。
3. 路径管理：示例中使用 os.getcwd() 获取当前工作目录。实际项目中建议根据项目结构定义绝对路径或使用相对路径常量，避免在不同运行环境下出错。
4. 目录存在性：写入前请确保 data 文件夹已存在，否则会抛出 FileNotFoundError。可以在代码中加入 os.makedirs 自动创建目录。