最近在搭建自動(dòng)化測(cè)試項(xiàng)目過(guò)程中經(jīng)常遇到y(tǒng)aml文件的讀寫(xiě)，為了方便后續(xù)使用，決定記下筆記。
YAML 簡(jiǎn)介
YAML，Yet Another Markup Language的簡(jiǎn)寫(xiě)何暇，通常用來(lái)編寫(xiě)項(xiàng)目配置，也可用于數(shù)據(jù)存儲(chǔ)跋炕，相比conf等配置文件要更簡(jiǎn)潔赖晶。
YAML 語(yǔ)法
- 支持的數(shù)據(jù)類型：
字典、列表、字符串遏插、布爾值捂贿、整數(shù)、浮點(diǎn)數(shù)胳嘲、Null厂僧、時(shí)間等 - 基本語(yǔ)法規(guī)則：
1、大小寫(xiě)敏感
2了牛、使用縮進(jìn)表示層級(jí)關(guān)系
3颜屠、相同層級(jí)的元素左側(cè)對(duì)齊
4、鍵值對(duì)用冒號(hào) “:” 結(jié)構(gòu)表示鹰祸，冒號(hào)與值之間需用空格分隔
5甫窟、數(shù)組前加有 “-” 符號(hào)，符號(hào)與值之間需用空格分隔
6蛙婴、None值可用null 和 ~ 表示
7粗井、多組數(shù)據(jù)之間使用3橫杠---分割
8、# 表示注釋街图，但不能在一段代碼的行末尾加 #注釋浇衬，否則會(huì)報(bào)錯(cuò)
注意：網(wǎng)上查找到各種博客都提到y(tǒng)aml縮進(jìn)時(shí)不能使用tab鍵，但我在pycharm編輯器里實(shí)際使用時(shí)是可以使用tab鍵進(jìn)行縮進(jìn)的餐济，讀寫(xiě)時(shí)并沒(méi)有報(bào)錯(cuò)耘擂！
安裝第三方y(tǒng)aml文件處理庫(kù)PyYAML
python沒(méi)有自帶的處理yaml文件的庫(kù)，需要下載第三方庫(kù)PyYAML 或 ruamel.yaml 絮姆，這里我們安裝PyYAML醉冤。
pip install pyyaml
# 下載速度慢的話加上清華鏡像源
pip install pyyaml -i https://pypi.tuna.tsinghua.edu.cn/simple
讀取yaml文件
一，從yaml中讀取字典
yaml中的字典格式如下：
# yaml文件滚朵，文件名為yamlData
os: Android
osVersion: 10
account:
username: xiaoqq
password: 123456
deviceName: null
appPackage: ~
bool1: True
讀取字典代碼：
# @author: 給你一頁(yè)白紙
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']))
讀取結(jié)果：
{'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'>
從讀取結(jié)果可以看出：
1冤灾，讀取出來(lái)的數(shù)據(jù)不會(huì)改變?cè)瓟?shù)據(jù)類型前域，即yaml里是什么數(shù)據(jù)類型辕近，讀出來(lái)就是什么類型。
2匿垄，Loader=yaml.FullLoader參數(shù)不寫(xiě)的話對(duì)結(jié)果不會(huì)有影響移宅，但運(yùn)行時(shí)會(huì)出現(xiàn)警告信息。
3椿疗，yaml.load(f.read(), Loader=yaml.FullLoader)也可以寫(xiě)成yaml.load(f, Loader=yaml.FullLoader)漏峰，讀取出來(lái)的結(jié)果相同。
二届榄，從yaml中讀取list
yaml中l(wèi)ist格式：數(shù)據(jù)前加'-' 并使用空格與數(shù)據(jù)間隔開(kāi)浅乔，如下：
# yaml文件名yamlData
- Android
- 10
- null
- ~
- True
讀取list代碼：
# @author: 給你一頁(yè)白紙
import yaml
with open('./yamlData.yml', 'r', encoding='utf-8') as f:
result = yaml.load(f.read(), Loader=yaml.FullLoader)
print(result, type(result))
讀取結(jié)果：
['Android', 10, None, None, True] <class 'list'>
三，從yaml中讀取元組
yaml中存儲(chǔ)元組格式：yaml中使用!!對(duì)數(shù)據(jù)類型進(jìn)行轉(zhuǎn)換，yaml中tuple由list轉(zhuǎn)換而來(lái)靖苇。如下：
# yaml文件名yamlData
!!python/tuple
- Android
- 10
- null
- ~
- True
讀取元組代碼：
# @author: 給你一頁(yè)白紙
import yaml
with open('./yamlData.yml', 'r', encoding='utf-8') as f:
result = yaml.load(f.read(), Loader=yaml.FullLoader)
print(result, type(result))
讀取結(jié)果：
('Android', 10, None, None, True) <class 'tuple'>
在實(shí)際使用中席噩，很多的時(shí)候往往是多種類型嵌套的數(shù)據(jù)。如下yaml數(shù)據(jù)
# yaml文件名yamlData
os: Android
osVersion: 10
account:
- username1: xiaoqq
- password1: 123456
- username2: Lilei
- password2: 888888
deviceName: null
appPackage: ~
bool1: True
讀取結(jié)果：
{'os': 'Android', 'osVersion': 10, 'account': [{'username1': 'xiaoqq'}, {'password1': 123456}, {'username2': 'Lilei'}, {'password2': 888888}], 'deviceName': None, 'appPackage': None, 'bool1': True}
四贤壁，從yaml中讀取多組數(shù)據(jù)
yaml多組數(shù)據(jù)時(shí)悼枢，每組數(shù)據(jù)之間需要用3橫杠分隔'---'，如下：
os: Android
osVersion: 10
account1:
username1: xiaoqq
password1: 123456
---
os: ios
osVersion: 12
account1:
username2: Lilei
password2: 888888
從yaml中讀取多組數(shù)據(jù)時(shí)需要使用yaml.load_all()方法脾拆，返回結(jié)果為一個(gè)生成器馒索，需要使用for循環(huán)語(yǔ)句獲取每組數(shù)據(jù)。代碼如下：
# @author: 給你一頁(yè)白紙
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)
讀取結(jié)果：
<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}}
寫(xiě)入yaml文件
一名船，單組數(shù)據(jù)寫(xiě)入yaml文件
使用yaml.dump()方法绰上，加入allow_unicode=True參數(shù)防止寫(xiě)入的中文亂碼，如下：
# @author: 給你一頁(yè)白紙
import yaml
apiData = {
"page": 1,
"msg": "地址",
"data": [{
"id": 1,
"name": "學(xué)校"
}, {
"id": 2,
"name": "公寓"
}, {
"id": 3,
"name": "流動(dòng)人口社區(qū)"
}],
}
with open('./writeYamlData.yml', 'w', encoding='utf-8') as f:
yaml.dump(data=apiData, stream=f, allow_unicode=True)
寫(xiě)入結(jié)果：
data:
- id: 1
name: 學(xué)校
- id: 2
name: 公寓
- id: 3
name: 流動(dòng)人口社區(qū)
msg: 地址
page: 1
二渠驼，多組數(shù)據(jù)寫(xiě)入yaml文件
使用yaml.dump_all()方法渔期，如下：
# @author: 給你一頁(yè)白紙
import yaml
apiData1 = {
"page": 1,
"msg": "地址",
"data": [{
"id": 1,
"name": "學(xué)校"
}, {
"id": 2,
"name": "公寓"
}, {
"id": 3,
"name": "流動(dòng)人口社區(qū)"
}],
}
apiData2 = {
"page": 2,
"msg": "地址",
"data": [{
"id": 1,
"name": "酒店"
}, {
"id": 2,
"name": "醫(yī)院"
}, {
"id": 3,
"name": "養(yǎng)老院"
}],
}
with open('./writeYamlData.yml', 'w', encoding='utf-8') as f:
yaml.dump_all(documents=[apiData1, apiData2], stream=f, allow_unicode=True)
寫(xiě)入結(jié)果：
data:
- id: 1
name: 學(xué)校
- id: 2
name: 公寓
- id: 3
name: 流動(dòng)人口社區(qū)
msg: 地址
page: 1
---
data:
- id: 1
name: 酒店
- id: 2
name: 醫(yī)院
- id: 3
name: 養(yǎng)老院
msg: 地址
page: 2
在Python中除了PyYAML庫(kù)之外，還有ruamel.yaml庫(kù)也可以對(duì)yaml文件進(jìn)行讀寫(xiě)操作渴邦，后續(xù)再記筆記進(jìn)行介紹疯趟。
