博客

前言

YAML 简介

YAML，Yet Another Markup Language的简写，通常用来编写项目配置，也可用于数据存储，相比conf等配置文件要更简洁。

YAML 语法

支持的数据类型：

字典、列表、字符串、布尔值、整数、浮点数、Null、时间等

基本语法规则：

1、大小写敏感

2、使用缩进表示层级关系

3、相同层级的元素左侧对齐

4、键值对用冒号 “:” 结构表示，冒号与值之间需用空格分隔

5、数组前加有 “-” 符号，符号与值之间需用空格分隔

6、None值可用null 和 ~ 表示

7、多组数据之间使用3横杠—分割

8、# 表示注释，但不能在一段代码的行末尾加 #注释，否则会报错

注意：网上查找到各种博客都提到yaml缩进时不能使用tab键，但我在pycharm编辑器里实际使用时是可以使用tab键进行缩进的，读写时并没有报错！

安装第三方yaml文件处理库PyYAML

python没有自带的处理yaml文件的库，需要下载第三方库PyYAML 或 ruamel.yaml ，这里我们安装PyYAML。

pip install pyyaml

# 下载速度慢的话加上清华镜像源
pip install pyyaml -i https://pypi.tuna.tsinghua.edu.cn/simple

读取yaml文件

1、从yaml中读取字典

yaml中的字典格式如下：

# yaml文件，文件名为yamlData
os: Android
osVersion: 10
account:
  username: xiaoqq
  password: 123456
deviceName: null
appPackage: ~
bool1: True

读取字典代码：

import yaml

with open('./yamlData.yml', 'r', encoding='utf-8') as f:
    result = yaml.load(f.read(), Loader=yaml.FullLoader)
print(result, type(result))
print(result['os'], type(result['os']))
print(result['osVersion'], type(result['osVersion']))
print(result['account'], type(result['account']))
print(result['account']['username'])
print(result['deviceName'])
print(result['appPackage'])
print(result['bool1'], type(result['bool1']))

读取结果：

{'os': 'Android', 'osVersion': 10, 'account': {'username': 'xiaoqq', 'password': 123456}, 'deviceName': None, 'appPackage': None} <class 'dict'>
Android <class 'str'>
10 <class 'int'>
{'username': 'xiaoqq', 'password': 123456} <class 'dict'>
xiaoqq
None
None
True <class 'bool'>

从读取结果可以看出：

读取出来的数据不会改变原数据类型，即yaml里是什么数据类型，读出来就是什么类型。

Loader=yaml.FullLoader参数不写的话对结果不会有影响，但运行时会出现警告信息。

yaml.load(f.read(), Loader=yaml.FullLoader)也可以写成yaml.load(f, Loader=yaml.FullLoader)，读取出来的结果相同。

2、从yaml中读取list

yaml中list格式：数据前加’-’ 并使用空格与数据间隔开，如下：

#yaml文件名yamlData
- Android
- 10
- null
- ~
- True

读取list代码：

import yaml

with open('./yamlData.yml', 'r', encoding='utf-8') as f:
    result = yaml.load(f.read(), Loader=yaml.FullLoader)
print(result, type(result))

读取结果：

['Android', 10, None, None, True] <class 'list'>

3、从yaml中读取元组

yaml中存储元组格式：yaml中使用!!对数据类型进行转换，yaml中tuple由list转换而来。如下：

# yaml文件名yamlData
!!python/tuple
- Android
- 10
- null
- ~
- True

读取元组代码：

import yaml

with open('./yamlData.yml', 'r', encoding='utf-8') as f:
    result = yaml.load(f.read(), Loader=yaml.FullLoader)
print(result, type(result))

读取结果：

('Android', 10, None, None, True) <class 'tuple'>

在实际使用中，很多的时候往往是多种类型嵌套的数据。如下yaml数据

# yaml文件名yamlData

os: Android
osVersion: 10
account:
  - username1: xiaoqq
  - password1: 123456
  - username2: Lilei
  - password2: 888888
deviceName: null
appPackage: ~
bool1: True

读取结果：

{'os': 'Android', 'osVersion': 10, 'account': [{'username1': 'xiaoqq'}, {'password1': 123456}, {'username2': 'Lilei'}, {'password2': 888888}], 'deviceName': None, 'appPackage': None, 'bool1': True}

4、从yaml中读取多组数据

yaml多组数据时，每组数据之间需要用3横杠分隔’—’，如下：

os: Android
osVersion: 10
account1:
  username1: xiaoqq
  password1: 123456
---
os: ios
osVersion: 12
account1:
  username2: Lilei
  password2: 888888

从yaml中读取多组数据时需要使用yaml.load_all()方法，返回结果为一个生成器，需要使用for循环语句获取每组数据。代码如下：

import yaml

with open('./yamlData.yml', 'r', encoding='utf-8') as f:
    result = yaml.load_all(f.read(), Loader=yaml.FullLoader)
    print(result, type(result))
    for i in result:
        print(i)

读取结果：

<generator object load_all at 0x000001F78EBD5B48> <class 'generator'>
{'os': 'Android', 'osVersion': 10, 'account1': {'username1': 'xiaoqq', 'password1': 123456}}
{'os': 'ios', 'osVersion': 12, 'account1': {'username2': 'Lilei', 'password2': 888888}}

写入yaml文件

1、单组数据写入yaml文件

使用yaml.dump()方法，加入allow_unicode=True参数防止写入的中文乱码，如下：

import yaml

apiData = {
   "page": 1,
   "msg": "地址",
   "data": [{
      "id": 1,
      "name": "学校"
   }, {
      "id": 2,
      "name": "公寓"
   }, {
      "id": 3,
      "name": "流动人口社区"
   }],
}

with open('./writeYamlData.yml', 'w', encoding='utf-8') as f:
   yaml.dump(data=apiData, stream=f, allow_unicode=True)

写入结果：

data:
- id: 1
  name: 学校
- id: 2
  name: 公寓
- id: 3
  name: 流动人口社区
msg: 地址
page: 1

2、多组数据写入yaml文件

使用yaml.dump_all()方法，如下：

import yaml

apiData1 = {
   "page": 1,
   "msg": "地址",
   "data": [{
      "id": 1,
      "name": "学校"
   }, {
      "id": 2,
      "name": "公寓"
   }, {
      "id": 3,
      "name": "流动人口社区"
   }],
}

apiData2 = {
   "page": 2,
   "msg": "地址",
   "data": [{
      "id": 1,
      "name": "酒店"
   }, {
      "id": 2,
      "name": "医院"
   }, {
      "id": 3,
      "name": "养老院"
   }],
}

with open('./writeYamlData.yml', 'w', encoding='utf-8') as f:
   yaml.dump_all(documents=[apiData1, apiData2], stream=f, allow_unicode=True)

写入结果：

data:
- id: 1
  name: 学校
- id: 2
  name: 公寓
- id: 3
  name: 流动人口社区
msg: 地址
page: 1
---
data:
- id: 1
  name: 酒店
- id: 2
  name: 医院
- id: 3
  name: 养老院
msg: 地址
page: 2

在Python中除了PyYAML库之外，还有ruamel.yaml库也可以对yaml文件进行读写操作。

一、Python编程入门到精通

二、接口自动化项目实战

三、Web自动化项目实战

四、App自动化项目实战

五、一线大厂简历

六、测试开发DevOps体系

七、常用自动化测试工具

八、JMeter性能测试

九、总结（尾部小惊喜）

在疲惫时，坚持不懈；在困难中，挑战自我；在迷茫时，保持梦想。奋斗是人生的密码，努力是成功的秘诀。相信自己的能力，勇敢前行，你将书写出属于自己的辉煌篇章。

人生犹如航行的船只，奋斗是驶向成功的风帆，不论风浪如何，只需坚持航向，扬起勇气的旗帜，便能穿越苦难，到达胜利的彼岸。相信自己，敢于追逐梦想，付出努力，你将创造令人惊艳的人生奇迹。

生活可能会给你带来挫折和困难，但不要屈服，勇敢面对并奋力前行。坚持努力，相信自己的潜能，你能超越极限，创造出令人惊叹的成就。