详解Python yaml模块


Posted in Python onSeptember 23, 2020

一、yaml文件介绍

yaml是一个专门用来写配置文件的语言。

1. yaml文件规则

  • 区分大小写;
  • 使用缩进表示层级关系;
  • 使用空格键缩进,而非Tab键缩进
  • 缩进的空格数目不固定,只需要相同层级的元素左侧对齐;
  • 文件中的字符串不需要使用引号标注,但若字符串包含有特殊字符则需用引号标注;
  • 注释标识为#

2. yaml文件数据结构

  • 对象:键值对的集合(简称 "映射或字典")

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

  • 数组:一组按序排列的值(简称 "序列或列表")

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

  • 纯量(scalars):单个的、不可再分的值(如:字符串、bool值、整数、浮点数、时间、日期、null等)

None值可用null可 ~ 表示

二、python中读取yaml配置文件

1. 前提条件

python中读取yaml文件前需要安装pyyaml和导入yaml模块:

  • 使用yaml需要安装的模块为pyyaml(pip3 install pyyaml);
  • 导入的模块为yaml(import yaml)

2. 读取yaml文件数据

python通过open方式读取文件数据,再通过load函数将数据转化为列表或字典;

import yaml
import os

def get_yaml_data(yaml_file):
  # 打开yaml文件
  print("***获取yaml文件数据***")
  file = open(yaml_file, 'r', encoding="utf-8")
  file_data = file.read()
  file.close()
  
  print(file_data)
  print("类型:", type(file_data))

  # 将字符串转化为字典或列表
  print("***转化yaml数据为字典或列表***")
  data = yaml.load(file_data)
  print(data)
  print("类型:", type(data))
  return data
current_path = os.path.abspath(".")
yaml_path = os.path.join(current_path, "config.yaml")
get_yaml_data(yaml_path)

"""
***获取yaml文件数据***
# yaml键值对:即python中字典
usr: my
psw: 123455
类型:<class 'str'>
***转化yaml数据为字典或列表***
{'usr': 'my', 'psw': 123455}
类型:<class 'dict'>
"""

3. yaml文件数据为键值对

(1)yaml文件中内容为键值对:

# yaml键值对:即python中字典
usr: my
psw: 123455
s: " abc\n"

python解析yaml文件后获取的数据:

{'usr': 'my', 'psw': 123455, 's': ' abc\n'}

(2)yaml文件中内容为“键值对'嵌套"键值对"

# yaml键值对嵌套:即python中字典嵌套字典
usr1:
 name: a
 psw: 123
usr2:
 name: b
 psw: 456

python解析yaml文件后获取的数据:

{'usr1': {'name': 'a', 'psw': 123}, 'usr2': {'name': 'b', 'psw': 456}}

(3)yaml文件中“键值对”中嵌套“数组”

python解析yaml文件后获取的数据:

# yaml键值对中嵌套数组
usr3:
 - a
 - b
 - c
usr4:
 - b

python解析yaml文件后获取的数据:

{'usr3': ['a', 'b', 'c'], 'usr4': ['b']}

4. yaml文件数据为数组

(1)yaml文件中内容为数组

# yaml数组
- a
- b
- 5

python解析yaml文件后获取的数据:

['a', 'b', 5]

(2)yaml文件“数组”中嵌套“键值对”

# yaml"数组"中嵌套"键值对"
- usr1: aaa
- psw1: 111
 usr2: bbb
 psw2: 222

python解析yaml文件后获取的数据:

[{'usr1': 'aaa'}, {'psw1': 111, 'usr2': 'bbb', 'psw2': 222}]

5. yaml文件中基本数据类型:

# 纯量
s_val: name       # 字符串:{'s_val': 'name'}
spec_s_val: "name\n"  # 特殊字符串:{'spec_s_val': 'name\n'
num_val: 31.14     # 数字:{'num_val': 31.14}
bol_val: true      # 布尔值:{'bol_val': True}
nul_val: null      # null值:{'nul_val': None}
nul_val1: ~       # null值:{'nul_val1': None}
time_val: 2018-03-01t11:33:22.55-06:00   # 时间值:{'time_val': datetime.datetime(2018, 3, 1, 17, 33, 22, 550000)}
date_val: 2019-01-10  # 日期值:{'date_val': datetime.date(2019, 1, 10)}

6. yaml文件中引用

yaml文件中内容

animal3: &animal3 fish
test: *animal3

python读取的数据

{'animal3': 'fish', 'test': 'fish'}

三、python中读取多个yaml文档

1. 多个文档在一个yaml文件,使用 --- 分隔方式来分段

如:yaml文件中数据

# 分段yaml文件中多个文档
---
animal1: dog
age: 2
---
animal2: cat
age: 3

2. python脚本读取一个yaml文件中多个文档方法

python获取yaml数据时需使用load_all函数来解析全部的文档,再从中读取对象中的数据

# yaml文件中含有多个文档时,分别获取文档中数据
def get_yaml_load_all(yaml_file):
  # 打开yaml文件
  file = open(yaml_file, 'r', encoding="utf-8")
  file_data = file.read()
  file.close()
  all_data = yaml.load_all(file_data)
  for data in all_data:
    print(data)
current_path = os.path.abspath(".")
yaml_path = os.path.join(current_path, "config.yaml")
get_yaml_load_all(yaml_path)
"""结果
{'animal1': 'dog', 'age': 2}
{'animal2': 'cat', 'age': 3}
"""

四、python对象生成yaml文档

1. 直接导入yaml(即import yaml)生成的yaml文档

通过yaml.dump()方法不会将列表或字典数据进行转化yaml标准模式,只会将数据生成到yaml文档中

# 将python对象生成yaml文档
import yaml
def generate_yaml_doc(yaml_file):
  py_object = {'school': 'zhang',
         'students': ['a', 'b']}
  file = open(yaml_file, 'w', encoding='utf-8')
  yaml.dump(py_object, file)
  file.close()
current_path = os.path.abspath(".")
yaml_path = os.path.join(current_path, "generate.yaml")
generate_yaml_doc(yaml_path)
"""结果
school: zhang
students: [a, b]
"""

2. 使用ruamel模块中的yaml方法生成标准的yaml文档

(1)使用ruamel模块中yaml前提条件

  • 使用yaml需要安装的模块:ruamel.yaml(pip3 install ruamel.yaml);
  • 导入的模块:from ruamel import yaml

(2)ruamel模块生成yaml文档

def generate_yaml_doc_ruamel(yaml_file):
  from ruamel import yaml
  py_object = {'school': 'zhang',
         'students': ['a', 'b']}
  file = open(yaml_file, 'w', encoding='utf-8')
  yaml.dump(py_object, file, Dumper=yaml.RoundTripDumper)
  file.close()
current_path = os.path.abspath(".")
yaml_path = os.path.join(current_path, "generate.yaml")
generate_yaml_doc_ruamel(yaml_path)
"""结果
school: zhang
students:
- a
- b
"""

(3)ruamel模块读取yaml文档

# 通过from ruamel import yaml读取yaml文件

def get_yaml_data_ruamel(yaml_file):
  from ruamel import yaml
  file = open(yaml_file, 'r', encoding='utf-8')
  data = yaml.load(file.read(), Loader=yaml.Loader)
  file.close()
  print(data)
current_path = os.path.abspath(".")
yaml_path = os.path.join(current_path, "dict_config.yaml")
get_yaml_data_ruamel(yaml_path)

以上就是详解Python yaml模块的详细内容,更多关于Python yaml模块的资料请关注三水点靠木其它相关文章!

Python 相关文章推荐
使用70行Python代码实现一个递归下降解析器的教程
Apr 17 Python
python中Apriori算法实现讲解
Dec 10 Python
Python编程scoketServer实现多线程同步实例代码
Jan 29 Python
解决安装tensorflow遇到无法卸载numpy 1.8.0rc1的问题
Jun 13 Python
python中int与str互转方法
Jul 02 Python
Python进阶之使用selenium爬取淘宝商品信息功能示例
Sep 16 Python
PHP统计代码行数的小代码
Sep 19 Python
python 函数嵌套及多函数共同运行知识点讲解
Mar 03 Python
Python按照list dict key进行排序过程解析
Apr 04 Python
为什么相对PHP黑python的更少
Jun 21 Python
Python爬虫之App爬虫视频下载的实现
Dec 08 Python
python中HTMLParser模块知识点总结
Jan 25 Python
python 绘制场景热力图的示例
Sep 23 #Python
Anaconda使用IDLE的实现示例
Sep 23 #Python
python获取时间戳的实现示例(10位和13位)
Sep 23 #Python
python rsa-oaep加密的示例代码
Sep 23 #Python
python删除文件、清空目录的实现方法
Sep 23 #Python
详解Anaconda 的安装教程
Sep 23 #Python
如何使用pycharm连接Databricks的步骤详解
Sep 23 #Python
You might like
浅析PHP递归函数返回值使用方法
2013/02/18 PHP
PHP魔术引号所带来的安全问题分析
2014/07/15 PHP
微信公众号OAuth2.0网页授权问题浅析
2017/01/21 PHP
详解PHP函数 strip_tags 处理字符串缺陷bug
2017/06/11 PHP
PNGHandler-借助JS让PNG图在IE下实现透明(包括背景图)
2007/08/31 Javascript
jQuery EasyUI API 中文文档 - NumberBox数字框
2011/10/13 Javascript
javascript中数组的冒泡排序使用示例
2013/12/18 Javascript
js获取视频时长代码
2014/04/10 Javascript
javascript 数组操作详解
2015/01/29 Javascript
JavaScript插件化开发教程(五)
2015/02/01 Javascript
easyui Droppable组件实现放置特效
2015/08/19 Javascript
第五章之BootStrap 栅格系统
2016/04/25 Javascript
JavaScript知识点总结(十六)之Javascript闭包(Closure)代码详解
2016/05/31 Javascript
AngularGauge 属性解析详解
2016/09/06 Javascript
Angularjs 实现一个幻灯片示例代码
2016/09/08 Javascript
简单理解vue中Props属性
2016/10/27 Javascript
微信小程序使用picker实现时间和日期选择框功能【附源码下载】
2017/12/11 Javascript
[52:41]OG vs IG 2018国际邀请赛小组赛BO2 第二场 8.18
2018/08/20 DOTA
Python的Flask框架中实现登录用户的个人资料和头像的教程
2015/04/20 Python
Python的GUI框架PySide的安装配置教程
2016/02/16 Python
用python写的一个wordpress的采集程序
2016/02/27 Python
Python文件的读写和异常代码示例
2017/10/31 Python
解决Mac安装scrapy失败的问题
2018/06/13 Python
Pycharm2017版本设置启动时默认自动打开项目的方法
2018/10/29 Python
提升python处理速度原理及方法实例
2019/12/25 Python
Python 创建TCP服务器的方法
2020/07/28 Python
HTML5中input[type='date']自定义样式与日历校验功能的实现代码
2017/07/11 HTML / CSS
花园仓库建筑:Garden Buildings Direct
2018/02/16 全球购物
巴西箱包、背包、钱包和旅行配件购物网站:Inovathi
2019/12/14 全球购物
英国时尚配饰、珠宝和服装网站:KJ Beckett
2020/01/23 全球购物
英国领先的男装设计师服装独立零售商:Repertoire Fashion
2020/10/19 全球购物
计算机专业大学生的自我评价
2013/11/14 职场文书
公益活动策划方案
2014/01/09 职场文书
迅雷Cued工作心得体会
2014/01/27 职场文书
领导班子四风表现材料
2014/08/23 职场文书
中学生打架检讨书
2014/10/13 职场文书