Python YAML 模块使用指南：接口测试参数存储与配置

2.1 安装 PyYAML 库

安装命令：

pip install PyYAML

安装后可通过 pip list 查看是否安装成功。

2.2 核心操作（读取、写入、清空）

2.2.1 追加写入 YAML 文件

向指定 YAML 文件追加数据（若文件不存在则自动创建）：

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:
        # 安全写入数据，支持 Unicode 字符
        yaml.safe_dump(data, stream=f, allow_unicode=True)

2.2.2 读取 YAML 文件数据

根据指定键读取 YAML 文件中的对应值：

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]

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

2.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()

2.4 关键说明

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