yaml基本语法以及读取yaml文件

一、基本语法

YAML 的配置文件后缀为 .yml，如：runoob.yml 。

1.语法

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

2.数据类型

YAML 支持以下几种数据类型：

对象：键值对的集合，又称为映射（mapping）/ 哈希（hashes） / 字典（dictionary）
数组：一组按次序排列的值，又称为序列（sequence） / 列表（list）
纯量（scalars）：单个的、不可再分的值

3.YAML 对象

对象键值对使用冒号结构表示 key: value，冒号后面要加一个空格。

也可以使用 key:{key1: value1, key2: value2, ...}。

还可以使用缩进表示层级关系：

key: 
    child-key: value
    child-key2: value2

4.YAML 数组

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

- A
- B
- C

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

key: [value1, value2, ...]

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

-
 - A
 - B
 - C

例子：

companies:
    -
        id: 1
        name: company1
        price: 200W
    -
        id: 2
        name: company2
        price: 500W

输出：

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

5.纯量

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

字符串
布尔值
整数
浮点数
Null
时间
日期

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

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

6.引用

& 锚点和 * 别名，可以用来引用:

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

转为 JavaScript 代码如下:

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

二、读取yml文件

1、安装yaml

pip install pyyaml

2、编写yaml文件

新建一个yaml，命名为test.yml

info:
  url:
   - http://127.0.0.1:8000
  params:
    title: welcome back
    year: 1992
  loginUser:
    user: tom
    passwd: 123456

3、读取yaml文件

import os
import yaml
def collect_data():
    rootdir = os.path.dirname(os.path.dirname(__file__))
    confFilePath = os.path.join(rootdir,'conf','test.yml').replace('\\','/')#打开文件,通过pyyaml读取内容
    with open(confFilePath,mode='r',encoding='utf-8') as f:
        data = yaml.load(f,Loader=yaml.FullLoader)
        print(data)
    return data

if __name__ == '__main__':
    collect_data2()

输出：

{'info': {'url': ['http://127.0.0.1:8000'], 'params': {'title': 'welcome back', 'year': 1992}, 'loginUser': {'user': 'tom', 'passwd': 123456}}}

获取某个参数值，假设返回值对象叫infoRes,我们要获取里面params参数：

params =infoRes.get('info').get('params', None)

4、FAQ

执行yaml.load()出现警告信息:YAMLLoadWarning: calling yaml.load() without Loader=...

警告提示：

YAMLLoadWarning: calling yaml.load() without Loader=... is deprecated, as the default Loader is unsafe. Please read https://msg.pyyaml.org/load for full details.

原因：

yaml 5.1版本后弃用了yaml.load(file)这个用法，因为觉得很不安全，5.1版本之后就修改了需要指定Loader，通过默认加载器（FullLoader）禁止执行任意函数

解决：

yaml.load(f, Loader=yaml.FullLoader)