Python使用PyYAML库读写yaml文件的方法


Posted in Python onApril 06, 2022

Python中yaml文件的读写(使用PyYAML库)。最近在搭建自动化测试项目过程中经常遇到yaml文件的读写,为了方便后续使用,决定记下笔记。

最近在搭建自动化测试项目过程中经常遇到yaml文件的读写,为了方便后续使用,决定记下笔记。

一,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

读取字典代码:

# @author: 给你一页白纸
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'>

从读取结果可以看出:

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

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

3,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代码:

# @author: 给你一页白纸
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

读取元组代码:

# @author: 给你一页白纸
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循环语句获取每组数据。代码如下:

# @author: 给你一页白纸
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参数防止写入的中文乱码,如下:

# @author: 给你一页白纸
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()方法,如下:

# @author: 给你一页白纸
import yaml
apiData1 = {
   "page": 1,
   "msg": "地址",
   "data": [{
      "id": 1,
      "name": "学校"
   }, {
      "id": 2,
      "name": "公寓"
      "id": 3,
      "name": "流动人口社区"
   }],
}
apiData2 = {
   "page": 2,
      "name": "酒店"
      "name": "医院"
      "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使用PyYAML库读写yaml文件的方法的文章就介绍到这了,更多相关Python读写yaml文件内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Python 相关文章推荐
python获取糗百图片代码实例
Dec 18 Python
python3之微信文章爬虫实例讲解
Jul 12 Python
python微信聊天机器人改进版(定时或触发抓取天气预报、励志语录等,向好友推送)
Apr 25 Python
Python之NumPy(axis=0 与axis=1)区分详解
May 27 Python
python实现视频分帧效果
May 31 Python
Django 多表关联 存储 使用方法详解 ManyToManyField save
Aug 09 Python
Python3.7将普通图片(png)转换为SVG图片格式(网站logo图标)动起来
Apr 21 Python
python+requests接口自动化框架的实现
Aug 31 Python
使用python爬取抖音app视频的实例代码
Dec 01 Python
filter使用python3代码进行迭代元素的实例详解
Dec 03 Python
python用opencv 图像傅里叶变换
Jan 04 Python
Anaconda安装pytorch及配置PyCharm 2021环境
Jun 04 Python
python+pytest接口自动化之token关联登录的实现
Python图像处理库PIL详细使用说明
Apr 06 #Python
Python可变与不可变数据和深拷贝与浅拷贝
Apr 06 #Python
Python 全局空间和局部空间
Apr 06 #Python
Selenium浏览器自动化如何上传文件
Apr 06 #Python
在Python 中将类对象序列化为JSON
Apr 06 #Python
Python中itertools库的四个函数介绍
Apr 06 #Python
You might like
PHP JSON格式数据交互实例代码详解
2011/01/13 PHP
php ajax 静态分页过程形式
2011/09/02 PHP
PHP内核介绍及扩展开发指南―基础知识
2011/09/11 PHP
PHP中文件读、写、删的操作(PHP中对文件和目录操作)
2012/03/06 PHP
Zend Framework教程之Zend_Db_Table表关联实例详解
2016/03/23 PHP
PHP实现用session来实现记录用户登陆信息
2018/10/15 PHP
jquery.post用法关于type设置问题补充
2014/01/03 Javascript
js获取网页可见区域、正文以及屏幕分辨率的高度
2014/05/15 Javascript
js/jquery判断浏览器的方法小结
2014/09/02 Javascript
浅谈regExp的test方法取得的值变化的原因及处理方法
2017/03/01 Javascript
利用js的闭包原理做对象封装及调用方法
2017/04/07 Javascript
js原生方法被覆盖,从新赋值原生的方法
2018/01/02 Javascript
基于Vue 服务端Cookies删除的问题
2018/09/21 Javascript
vue store之状态管理模式的详细介绍
2019/06/13 Javascript
基于openlayers实现角度测量功能
2020/09/28 Javascript
[02:08]我的刀塔不可能这么可爱 胡晓桃_1
2014/06/20 DOTA
[56:45]DOTA2上海特级锦标赛D组小组赛#1 EG VS COL第一局
2016/02/28 DOTA
python批量生成本地ip地址的方法
2015/03/23 Python
Python实现把json格式转换成文本或sql文件
2015/07/10 Python
从源码解析Python的Flask框架中request对象的用法
2016/06/02 Python
基于python的Tkinter编写登陆注册界面
2017/06/30 Python
在unittest中使用 logging 模块记录测试数据的方法
2018/11/30 Python
python实现大战外星人小游戏实例代码
2019/12/26 Python
简单了解Django ORM常用字段类型及参数配置
2020/01/07 Python
利用Pycharm + Django搭建一个简单Python Web项目的步骤
2020/10/22 Python
GitHub上值得推荐的8个python 项目
2020/10/30 Python
经典婚礼主持开场白
2014/03/13 职场文书
2014年冬季防火方案
2014/05/21 职场文书
教师党员个人自我评价
2015/03/04 职场文书
2015年六一儿童节活动方案
2015/05/05 职场文书
中学教师读书笔记
2015/07/01 职场文书
小学数学教师研修感悟
2015/11/18 职场文书
2016教师节感恩话语
2015/12/09 职场文书
小学体育队列队形教学反思
2016/02/16 职场文书
超外差式晶体管收音机的组装与统调
2021/04/22 无线电
Lombok的详细使用及优缺点总结
2021/07/15 Java/Android