Python中读取yaml文件配置文件

简介

YAML 是 "YAML Ain't a Markup Language"（YAML 不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是："Yet Another Markup Language"（仍是一种标记语言）。
YAML 的语法和其他高级语言类似，并且可以简单表达清单、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲（例如：许多电子邮件标题格式和YAML非常接近）。
YAML 的配置文件后缀为 .yml，如：runoob.yml 。

安装

pip install pyyaml

使用

import yaml
with open('./test.yaml','r+',encoding="utf-8")as file:
    obj=yaml.safe_load(file)
print(obj)

基本语法

1. 大小写敏感
2. 使用缩进表示层级关系
3. 缩进不允许使用tab，只允许使用空格
4. 缩进的空格数不重要，只要相同层级的元素左对齐即可
5. 使用# 表示注释

数据类型

YAML支持以下数据类型

1. 对象：键值对集合，又称为映射/哈希/字典
2. 数组：一组按次序排列的值，又称为序列/列表
3. 纯量：单个的不可再分的值

YAML对象

对象键值对使用冒号结构表示key: value冒号后面要加一个空格。
也可以使用key: {key1: value,key2: value2}
还可以使用缩进表示层级关系:

key:
  chid-key: 1
  chid-key2: 2

YAML数组

以 - 开头的行表示构成一个数组：

- A
- B
- C

YAML 支持多维数组，可以使用行内表示：

key: [value1, value2, ...]

数据结构的子成员是一个数组，则可以在该项下面缩进一个空格

-
 - A
 - B
 - C

一个相对复杂的例子：

companies:
  -
    id: 1
    name: zhagnsan
    price: 2022w
  -
    id: 2
    name: lisi
    price: 201w

转化为python对象为:

{'companies': [{'id': 1, 'name': 'zhagnsan', 'price': '2022w'}, {'id': 2, 'name': 'lisi', 'price': '201w'}]}

还可以这样写

companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}]

还可以这样

languages:
  - Ruby
  - Perl
  - Python 
websites:
  YAML: yaml.org 
  Ruby: ruby-lang.org 
  Python: python.org 
  Perl: use.perl.org

纯量

纯量 是基本的，不可再分的值，包括:

1. 字符串
2. 布尔值
3. 整数
4. 浮点数
5. Null
6. 时间
7. 日期

使用一个例子来快速了解纯量的基本使用:

boolean: # 布尔值
    - TRUE  #true,True都可以
    - FALSE  #false，False都可以
float: # 浮点数
    - 3.14
    - 6.8523015e+5  #可以使用科学计数法
int: # 整数
    - 123
    - 0b1010_0111_0100_1010_1110    #二进制表示
null: # Null
    nodeName: 'node'
    parent: ~  #使用~表示null
string: # 字符串
    - 哈哈 # 字符串默认不使用引号表示
    - 'Hello world'  #可以使用双引号或者单引号包裹特殊字符
    - newline
      newline2    #字符串可以拆成多行，每一行会被转化成一个空格
date:
    - 2021-06-17    #日期必须使用ISO 8601格式，即yyyy-MM-dd
datetime: 
    -  2021-06-17T15:02:31+08:00    #时间使用ISO 8601格式，时间和日期之间使用T连接，最后使用+代表时区

打印结果

C:\Users\Administrator\PycharmProjects\pythonProject\venv\Scripts\python.exe D:/Object/python_Object/pythonProject/erlangshen_app_test2/main.py
{'boolean': [True, False], 'float': [3.14, 685230.15], 'int': [123, 685230], None: {'nodeName': 'node', 'parent': None}, 'string': ['哈哈', 'Hello world', 'newline newline2'], 'date': [datetime.date(2021, 6, 17)], 'datetime': [datetime.datetime(2021, 6, 17, 15, 2, 31, tzinfo=datetime.timezone(datetime.timedelta(seconds=28800)))]}

Process finished with exit code 0

字符串中的换行

this: | # 保留换行并且下方输出以字符串形式
  Foo
  Bar
that: > # 折叠换行，中间没有换行末尾存在换行
  Foo
  Bar
s1: | # 保留换行
  Foo

s2: |+  # 末尾添加换行
  Foo

s3: |- # 末尾删除黄行
  Foo

message: |
  <p style="color: red">
    段落
  </p>

转换数据格式
允许使用两个感叹号，强制转换数据类型

e: !!str 123
f: !!str true

转换后的文件

{'e': '123', 'f': 'true'}

锚点引用

defaults: &defaults # 添加锚点
  adapter:  postgres
  host:     localhost

development:
  database: myapp_development
  <<: *defaults # <<表示合并，*引用锚点

test:
  database: myapp_test
  <<: *defaults # <<表示合并，*引用锚点

相当于：

defaults:
  adapter:  postgres
  host:     localhost

development:
  database: myapp_development
  adapter:  postgres
  host:     localhost

test:
  database: myapp_test
  adapter:  postgres
  host:     localhost

&用来建立锚点（defaults），<<表示合并到当前数据，*用来引用锚点。

- &showell Steve
- Clark 
- Brian 
- Oren 
- *showell 

执行结果

[ 'Steve', 'Clark', 'Brian', 'Oren', 'Steve' ]

参考：yaml语言教程 - RioTian - 博客园 (cnblogs.com)