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

更新时间：2026年03月13日 08:48:41 作者：独断万古他化

本文介绍了YAML（YAMLAin't Markup Language）的简介、核心特点、数据类型和语法,以及在Python环境中的使用方法,包括安装PyYAML库、核心操作（读取、写入、清空）和完整使用示例,需要的朋友可以参考下

一、YAML介绍

YAML 是一种数据序列化语言，用于以人类可读的形式存储信息。其最初代表“Yet Another Markup Language”，后更改为“YAML Ain’t Markup Language”（YAML 不是一种标记语言），以区别于传统标记语言。

1.1 核心特点

简洁易读：语法简洁，减少 JSON、XML 中的引号、括号等“噪音”格式；
非编程语言：主要用于存储配置信息，不具备编程逻辑；
缩进敏感：缩进规则类似 Python，通过缩进来表示层级关系；
区分大小写：对键名、值的大小写严格区分；
禁用 Tab 键：不允许使用制表符缩进，需通过空格实现缩进（部分编辑器可配置 Tab 自动转为空格）。

1.2 支持的数据类型及语法对比（与JSON）

YAML 文件后缀名为 .yaml 或 .yml（常用 .yml），支持多种数据类型，其语法与 JSON 对比如下：

数据类型	YAML 语法	JSON 语法
简单标量值	key: value	`{"key": "value"}`
整数和浮点数	int_key: 123 float_key: 123.456	`{"int_key": 123, "float_key": 123.456}`
布尔值	bool_key: true	`{"bool_key": true}`
字符串	string_key: “This is a string”	`{"string_key": "This is a string"}`
列表	list_key: - item1 - item2 - item3	`{"list_key": ["item1", "item2", "item3"]}`
映射（字典）	map_key: sub_key1: sub_value1 sub_key2: sub_value2	`{"map_key": {"sub_key1": "sub_value1", "sub_key2": "sub_value2"}}`
嵌套结构	nested_key: list_key: - item1 - item2 map_key: sub_key1: sub_value1 sub_key2: sub_value2	`{"nested_key": {"list_key": ["item1", "item2"], "map_key": {"sub_key1": "sub_value1", "sub_key2": "sub_value2"}}}`

1.3 语法辅助工具

若对 YAML 语法不熟悉，可使用 JSON 转 YAML 工具快速生成，生成后需二次检查格式正确性。

工具地址：https://www.jashtool.com/json/to-yaml

示例：

二、YAML 使用（Python 环境）

在 Python 中使用 YAML 需借助 PyYAML 库，主要用于读取、写入、清空 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" 避免中文等特殊字符出现乱码。

到此这篇关于Python YAML模块使用指南(接口测试参数存储与配置)的文章就介绍到这了,更多相关Python YAML模块使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

深入理解Django-Signals信号量
这篇文章主要介绍了深入理解Django-Signals信号量，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2019-02-02
Python中的Function定义方法
Python中，函数是可被重用的程序段。对于函数的定义，可以使用def关键字。
2009-09-09
python实现文件批量重命名
这篇文章主要为大家详细介绍了python实现文件批量重命名，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-04-04
使用Python操作Elasticsearch数据索引的教程
这篇文章主要介绍了使用Python操作Elasticsearch数据索引的教程,Elasticsearch处理数据索引非常高效,要的朋友可以参考下
2015-04-04
Python字符串处理与正则表达式用法实战指南
Python为我们提供了丰富的字符串操作方法和正则表达式工具,帮助我们高效处理文本数据,这篇文章主要介绍了Python字符串处理与正则表达式用法的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
2025-07-07
Python:type、object、class与内置类型实例
今天小编就为大家分享一篇Python:type、object、class与内置类型实例，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2019-12-12
Django实现jquery select2带搜索的下拉框
最近在开发一个web应用中需要用到带搜索功能下拉框，本文实现Django实现jquery select2带搜索的下拉框，感兴趣的小伙伴们可以参考一下
2021-06-06
Keras中Conv1D的使用及说明
这篇文章主要介绍了Keras中Conv1D的使用及说明，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-12-12
Python中re模块常用方法总结分析
这篇文章主要为大家介绍了Python中re模块常用方法，并对这些常用方法进行总结分析，有需要的朋友可以借鉴参考下，希望能够有所帮助
2021-09-09
Python 加密的实例详解
这篇文章主要介绍了 Python 加密的实例详解的相关资料,这里提供了两种实现方法，需要的朋友可以参考下
2017-10-10