在自动化测试项目中我们经常需要管理大量的测试数据、环境配置、用例参数 —— 如果直接写死在代码里不仅修改麻烦还会导致代码和数据强耦合。YAML 正是解决这个问题的 “神器”它以极简的语法、极高的可读性成为了自动化测试、DevOps 领域最主流的配置文件格式之一。本文将从 YAML 的基础概念、语法规则、Python 读写实战到自动化测试场景的最佳实践带你全面掌握 YAML 的使用。一、什么是 YAML它有什么优势YAML 全称是“YAML Aint Markup Language”YAML 不是标记语言是一种轻量级、人类可读的数据序列化语言专门用于存储配置信息和结构化数据。它的设计目标就是简单、易读、易写和 JSON、XML 相比优势非常明显1. 核心特点极简语法用空格缩进替代引号、方括号、大括号没有多余的 “噪音字符”原生支持多种数据类型字符串、数字、布尔值、列表、字典、嵌套结构都能直接表示和 Python 天然适配缩进风格和 Python 保持一致学习成本极低跨语言兼容支持几乎所有主流编程语言团队协作中不同语言的项目都能直接使用。2. 关键注意事项区分大小写name 和 Name 是两个完全不同的键禁止使用 Tab 键YAML 不允许 Tab 缩进编辑器中按下 Tab 会自动替换为空格严格缩进规则同层级的键必须对齐缩进错误会直接导致解析失败文件后缀推荐使用 .yml更短更常用或 .yaml。二、YAML 基础语法一文看懂所有数据类型YAML 支持所有自动化测试中常用的数据结构以下是和 JSON 的对照示例帮你快速掌握数据类型YAML 写法JSON 对应写法键值对基础key: value{key: value}整数 / 浮点数int_key: 123float_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{list_key: [item1, item2]}字典映射map_key:sub_key1: value1sub_key2: value2{map_key: {sub_key1: value1, sub_key2: value2}}嵌套结构nested_key:list_key:- item1map_key:sub_key: value{nested_key: {list_key: [item1], map_key: {sub_key: value}}}小技巧JSON 转 YAML 工具如果短时间内记不住所有语法可以直接用在线工具转换比如 json2yaml把 JSON 粘贴进去就能自动生成 YAML 格式避免手动写错。三、Python 操作 YAML读写配置文件实战在 Python 中我们使用PyYAML库来读写 YAML 文件以下是完整的安装和实战步骤。1. 安装 PyYAML在你的虚拟环境终端中执行pip install PyYAML6.0.1安装完成后就能在代码中import yaml使用了。2. 核心读写操作创建yaml文件以下是自动化测试中最常用的 YAML 读写模板包含写入、读取、清空三种操作import yaml # 追加/写入 YAML 文件 def write_yaml(filename, data, encodingutf-8, modea): with open(filename, encodingencoding, modemode) as f: yaml.safe_dump(data, streamf, allow_unicodeTrue) # 读取 YAML 文件支持按 key 读取 def read_yaml(filename, keyNone, encodingutf-8): with open(filename, encodingencoding, moder) as f: data yaml.safe_load(f) if key: return data.get(key) return data # 清空 YAML 文件 def clear_yaml(filename, encodingutf-8): with open(filename, encodingencoding, modew) as f: f.truncate() # 测试示例 def test_yaml_operation(): # 1. 写入数据 test_data { str: 12345, user: { username: admin, password: 123456 }, test_cases: [login_success, login_fail] } write_yaml(test.yml, test_data) # 2. 读取数据 ret read_yaml(test.yml, str) print(读取结果, ret) # 输出读取结果12345 # 3. 清空文件 clear_yaml(test.yml)关键函数说明yaml.safe_dump安全写入数据避免解析漏洞allow_unicodeTrue 支持写入中文yaml.safe_load安全读取数据自动将 YAML 解析为 Python 字典 / 列表read_yaml 支持按 key 读取适合自动化测试中读取指定配置项。四、YAML 在自动化测试中的核心使用场景YAML 之所以成为自动化测试的标配是因为它完美解决了测试项目中 “数据和代码耦合” 的痛点以下是最常用的三个场景1. 测试数据驱动把多组测试用例数据比如登录账号、接口参数写在 YAML 文件中用 pytest 参数化读取实现 “一套用例跑多组数据”# test_data.yml login_cases: - username: admin password: 123456 expected: 登录成功 - username: wrong_user password: 123456 expected: 用户名或密码错误在 pytest 中读取并参数化import pytest import yaml with open(test_data.yml, r, encodingutf-8) as f: login_cases yaml.safe_load(f)[login_cases] pytest.mark.parametrize(case, login_cases) def test_login(case): print(f测试用户{case[username]}预期结果{case[expected]}) # 这里写登录的测试逻辑2. 环境配置管理不同环境测试、预发、生产的 URL、数据库地址、账号密码都可以写在 YAML 中通过切换配置文件实现环境切换不用修改代码# config.yml test: base_url: http://test.example.com db_host: test-db.example.com pre: base_url: http://pre.example.com db_host: pre-db.example.com prod: base_url: http://prod.example.com db_host: prod-db.example.com3. 用例步骤管理对于复杂的 GUI 自动化用例可以把操作步骤、元素定位方式写在 YAML 中实现用例和代码分离非技术人员也能维护用例# steps.yml login_steps: - action: input locator: idusername value: admin - action: input locator: idpassword value: 123456 - action: click locator: idloginBtn五、使用 YAML 的避坑指南缩进问题同层级的键必须对齐建议使用 2 个空格缩进编辑器中关闭 Tab 自动替换功能中文乱码读写文件时必须指定 encodingutf-8yaml.safe_dump 时加上 allow_unicodeTrue空文件处理读取空 YAML 文件时会返回 None建议在 read_yaml 函数中加 if data: 判断数据类型YAML 会自动识别数据类型比如 123 会被解析为整数123 才是字符串避免类型不匹配导致断言失败。六、总结YAML 以其极简的语法、极高的可读性成为了自动化测试项目中管理配置和测试数据的最佳选择。它不仅能让你的代码更简洁、易维护还能实现数据和逻辑的解耦让非技术人员也能参与维护测试用例和配置。掌握 YAML 的读写和使用是搭建企业级自动化测试框架的必备技能。后续我们会结合 pytest 参数化、fixture带你实现一个完整的 “YAML 数据驱动 GUI 自动化测试框架”。
15:YAML配置文件
在自动化测试项目中我们经常需要管理大量的测试数据、环境配置、用例参数 —— 如果直接写死在代码里不仅修改麻烦还会导致代码和数据强耦合。YAML 正是解决这个问题的 “神器”它以极简的语法、极高的可读性成为了自动化测试、DevOps 领域最主流的配置文件格式之一。本文将从 YAML 的基础概念、语法规则、Python 读写实战到自动化测试场景的最佳实践带你全面掌握 YAML 的使用。一、什么是 YAML它有什么优势YAML 全称是“YAML Aint Markup Language”YAML 不是标记语言是一种轻量级、人类可读的数据序列化语言专门用于存储配置信息和结构化数据。它的设计目标就是简单、易读、易写和 JSON、XML 相比优势非常明显1. 核心特点极简语法用空格缩进替代引号、方括号、大括号没有多余的 “噪音字符”原生支持多种数据类型字符串、数字、布尔值、列表、字典、嵌套结构都能直接表示和 Python 天然适配缩进风格和 Python 保持一致学习成本极低跨语言兼容支持几乎所有主流编程语言团队协作中不同语言的项目都能直接使用。2. 关键注意事项区分大小写name 和 Name 是两个完全不同的键禁止使用 Tab 键YAML 不允许 Tab 缩进编辑器中按下 Tab 会自动替换为空格严格缩进规则同层级的键必须对齐缩进错误会直接导致解析失败文件后缀推荐使用 .yml更短更常用或 .yaml。二、YAML 基础语法一文看懂所有数据类型YAML 支持所有自动化测试中常用的数据结构以下是和 JSON 的对照示例帮你快速掌握数据类型YAML 写法JSON 对应写法键值对基础key: value{key: value}整数 / 浮点数int_key: 123float_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{list_key: [item1, item2]}字典映射map_key:sub_key1: value1sub_key2: value2{map_key: {sub_key1: value1, sub_key2: value2}}嵌套结构nested_key:list_key:- item1map_key:sub_key: value{nested_key: {list_key: [item1], map_key: {sub_key: value}}}小技巧JSON 转 YAML 工具如果短时间内记不住所有语法可以直接用在线工具转换比如 json2yaml把 JSON 粘贴进去就能自动生成 YAML 格式避免手动写错。三、Python 操作 YAML读写配置文件实战在 Python 中我们使用PyYAML库来读写 YAML 文件以下是完整的安装和实战步骤。1. 安装 PyYAML在你的虚拟环境终端中执行pip install PyYAML6.0.1安装完成后就能在代码中import yaml使用了。2. 核心读写操作创建yaml文件以下是自动化测试中最常用的 YAML 读写模板包含写入、读取、清空三种操作import yaml # 追加/写入 YAML 文件 def write_yaml(filename, data, encodingutf-8, modea): with open(filename, encodingencoding, modemode) as f: yaml.safe_dump(data, streamf, allow_unicodeTrue) # 读取 YAML 文件支持按 key 读取 def read_yaml(filename, keyNone, encodingutf-8): with open(filename, encodingencoding, moder) as f: data yaml.safe_load(f) if key: return data.get(key) return data # 清空 YAML 文件 def clear_yaml(filename, encodingutf-8): with open(filename, encodingencoding, modew) as f: f.truncate() # 测试示例 def test_yaml_operation(): # 1. 写入数据 test_data { str: 12345, user: { username: admin, password: 123456 }, test_cases: [login_success, login_fail] } write_yaml(test.yml, test_data) # 2. 读取数据 ret read_yaml(test.yml, str) print(读取结果, ret) # 输出读取结果12345 # 3. 清空文件 clear_yaml(test.yml)关键函数说明yaml.safe_dump安全写入数据避免解析漏洞allow_unicodeTrue 支持写入中文yaml.safe_load安全读取数据自动将 YAML 解析为 Python 字典 / 列表read_yaml 支持按 key 读取适合自动化测试中读取指定配置项。四、YAML 在自动化测试中的核心使用场景YAML 之所以成为自动化测试的标配是因为它完美解决了测试项目中 “数据和代码耦合” 的痛点以下是最常用的三个场景1. 测试数据驱动把多组测试用例数据比如登录账号、接口参数写在 YAML 文件中用 pytest 参数化读取实现 “一套用例跑多组数据”# test_data.yml login_cases: - username: admin password: 123456 expected: 登录成功 - username: wrong_user password: 123456 expected: 用户名或密码错误在 pytest 中读取并参数化import pytest import yaml with open(test_data.yml, r, encodingutf-8) as f: login_cases yaml.safe_load(f)[login_cases] pytest.mark.parametrize(case, login_cases) def test_login(case): print(f测试用户{case[username]}预期结果{case[expected]}) # 这里写登录的测试逻辑2. 环境配置管理不同环境测试、预发、生产的 URL、数据库地址、账号密码都可以写在 YAML 中通过切换配置文件实现环境切换不用修改代码# config.yml test: base_url: http://test.example.com db_host: test-db.example.com pre: base_url: http://pre.example.com db_host: pre-db.example.com prod: base_url: http://prod.example.com db_host: prod-db.example.com3. 用例步骤管理对于复杂的 GUI 自动化用例可以把操作步骤、元素定位方式写在 YAML 中实现用例和代码分离非技术人员也能维护用例# steps.yml login_steps: - action: input locator: idusername value: admin - action: input locator: idpassword value: 123456 - action: click locator: idloginBtn五、使用 YAML 的避坑指南缩进问题同层级的键必须对齐建议使用 2 个空格缩进编辑器中关闭 Tab 自动替换功能中文乱码读写文件时必须指定 encodingutf-8yaml.safe_dump 时加上 allow_unicodeTrue空文件处理读取空 YAML 文件时会返回 None建议在 read_yaml 函数中加 if data: 判断数据类型YAML 会自动识别数据类型比如 123 会被解析为整数123 才是字符串避免类型不匹配导致断言失败。六、总结YAML 以其极简的语法、极高的可读性成为了自动化测试项目中管理配置和测试数据的最佳选择。它不仅能让你的代码更简洁、易维护还能实现数据和逻辑的解耦让非技术人员也能参与维护测试用例和配置。掌握 YAML 的读写和使用是搭建企业级自动化测试框架的必备技能。后续我们会结合 pytest 参数化、fixture带你实现一个完整的 “YAML 数据驱动 GUI 自动化测试框架”。
