YAML 语言教程与使用案例

 

YAML语言教程与使用案例，如何编与读懂写YAML文件。

 

YAML概要

YAML 是 “YAML Ain’t a Markup Language”（YAML 不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是：”Yet Another Markup Language”（仍是一种标记语言）。

YAML是一个类似 XML、JSON 的标记性语言。YAML 强调以数据为中心，并不是以标识语言为重点。因而 YAML 本身的定义比较简单，号称“一种人性化的数据格式语言”。

 

基本语法

1、大小写敏感

2、使用缩进表示层级关系

3、缩进时不允许使用Tab键，只允许使用空格

4、缩进的空格数不重要，只要相同层级的元素左侧对齐即可。【实际使用中建议两个空格作为一个层级的缩进】

5、# 表示注释，从这个字符一直到行尾，都会被解释器忽略

6、冒号，以冒号结尾除外，其他所有冒号后面必须有空格

7、短横线，表示列表项，使用一个短横线加一个空格；多个项使用同样的缩进级别作为同一列表

 

支持的数据结构

1、对象：键值对的集合，又称为映射（mapping）/ 哈希（hashes） / 字典（dictionary）

2、数组：一组按次序排列的值，又称为序列（sequence） / 列表（list）

3、字面量/纯量（数字、字符串、布尔值）(scalars)：单个的、不可再分的值

 

YAML 组织结构

YAML 文件可以由一或多个文档组成（即相对独立的组织结构组成），文档间使用“---”（三个横线）在每文档开始作为分隔符(可选)。同时，文档也可以使用“...”（三个点号）作为结束符（可选）。如下图所示：

备注：如果只是单个文档，分隔符“---”可省略。

每个文档并不需要使用结束符“...”来表示结束，但是对于网络传输或者流来说，有明确结束的符号，有利于软件处理。（例如不需要知道流关闭就能知道文档结束）

 

Python中yaml模块的使用

Python pip 安装

如果未安装pip，则可以使用以下方法来安装：

1 # curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py   # 下载安装脚本
2 # python get-pip.py    # 运行安装脚本  或则：python3 get-pip.py  根据使用的Python决定
3 # pip --version        # 版本查看

用哪个版本的 Python 运行安装脚本，pip 就被关联到哪个版本。

 

pip安装yaml与导入

安装pyyaml

# pip install pyyaml  # 或者pip3 install pyyaml

检查是否安装成功：

1、命令行输入：python

2、再输入：import yaml

安装成功后，在脚本里导入的语句，都是 import yaml

 

YAML-对象数据类型

备注：之所以对yaml文件使用Python进行解析，是因为我们要测验yaml文件格式是否书写正确。

对象数据：是一组键值对，使用冒号结构表示。

 

单个对象文档文件

yaml文件

1 [root@docker02 yaml]# cat demo_01_obj.yml
2 ---
3 name: zhang
4 age: 22

 

Python解析

 1 [root@docker02 yaml]# cat demo_01_obj.py
 2 #!/usr/bin/env python
 3 # -*- coding: utf-8 -*-
 4 # Author: zhang
 5 
 6 import yaml
 7 
 8 file_path = "./demo_01_obj.yml"
 9 file = open(file_path, 'r')
10 ys = yaml.load(file.read(), Loader=yaml.Loader)
11 print ys

 

输出结果

1 [root@docker02 yaml]# python demo_01_obj.py 
2 {'age': 22, 'name': 'zhang'}

 

多个对象文档文件

yaml文件，仔细对比下加了”---“和”...“ 的区别

 1 [root@docker02 yaml]# cat demo_02_obj.yml
 2 ---
 3 name: zhang
 4 age: 22
 5 ...
 6 ---
 7 name: Jane
 8 age: 20
 9 key: 
10   child-key: value
11   child-key2: value2
12 ...
13 ---
14 obj: {obj_key1: value1, obj_key2: value2}
15 ...

 

Python解析

 1 [root@docker02 yaml]# cat demo_02_obj.py
 2 #!/usr/bin/env python
 3 # -*- coding: utf-8 -*-
 4 # Author: zhang
 5 
 6 import yaml
 7 import json
 8 
 9 file_path = "demo_02_obj.yml"
10 file = open(file_path, 'r')
11 
12 ys = yaml.load_all(file.read(), Loader=yaml.Loader)
13 for y in ys:
14   # 两种打印方式都尝试下 
15   #print y
16   print json.dumps(y, indent=2)

 

输出结果

 1 [root@docker02 yaml]# python demo_02_obj.py
 2 {'age': 22, 'name': 'zhang'}
 3 {'age': 20, 'name': 'Jane', 'key': {'child-key2': 'value2', 'child-key': 'value'}}
 4 {'obj': {'obj_key1': 'value1', 'obj_key2': 'value2'}}
 5 # 或者如下
 6 [root@docker02 yaml]# python demo_02_obj.py 
 7 {
 8   "age": 22, 
 9   "name": "zhang"
10 }
11 {
12   "age": 20, 
13   "name": "Jane", 
14   "key": {
15     "child-key2": "value2", 
16     "child-key": "value"
17   }
18 }
19 {
20   "obj": {
21     "obj_key1": "value1", 
22     "obj_key2": "value2"
23   }
24 }

 

YAML-数组数据类型

备注：之所以对yaml文件使用Python进行解析，是因为我们要测验yaml文件格式是否书写正确。

数组类型：一组连词线开头的行，构成一个数组

yaml文件

 1 [root@docker02 yaml]# cat demo_03_list.yml 
 2 # 书写方式1
 3 color:
 4 - red
 5 - blue
 6 - green
 7 - orange
 8 - white
 9 # 书写方式2：行内表示法
10 fruits: [orange, apple, banana]

 

Python解析

 1 [root@docker02 yaml]# cat demo_03_list.py 
 2 #!/usr/bin/env python
 3 # -*- coding: utf-8 -*-
 4 # Author: zhang
 5 
 6 import yaml
 7 import json
 8 
 9 file_path = "demo_03_list.yml"
10 file = open(file_path, 'r')
11 
12 ys = yaml.load_all(file.read(), Loader=yaml.Loader)
13 for y in ys:
14   # 两种打印方式都尝试下  
15   #print y
16   print json.dumps(y, indent=2)

 

输出结果

 1 [root@docker02 yaml]# python demo_03_list.py 
 2 {'color': ['red', 'blue', 'green', 'orange', 'white'], 'fruits': ['orange', 'apple', 'banana']}
 3 # 或者结果如下
 4 [root@docker02 yaml]# python demo_03_list.py
 5 {
 6   "color": [
 7     "red", 
 8     "blue", 
 9     "green", 
10     "orange", 
11     "white"
12   ], 
13   "fruits": [
14     "orange", 
15     "apple", 
16     "banana"
17   ]
18 }

 

YAML-复合结构

备注：之所以对yaml文件使用Python进行解析，是因为我们要测验yaml文件格式是否书写正确。

复合结构：对象和数组可以结合使用，形成复合结构

yaml文件，注意其书序格式，并细细对比输出结果

 1 [root@docker02 yaml]# cat demo_04_compose.yml
 2 shop: GoodShopping
 3 address: BJ
 4 goods:
 5   Food:
 6   - sell_time: "AM 08:30"
 7     food01: rice
 8     food02: pork
 9   Fruits:
10   - sell_time: "AM 09:00"
11   - fruit01: orange
12     price: 3.50
13   - fruit02: banana
14     price: 3.00
15   clothes:
16   - sell_time: "AM 09:30"
17   - clothe01
18   - clothe02

 

Python解析

 1 [root@docker02 yaml]# cat demo_04_compose.py 
 2 #!/usr/bin/env python
 3 # -*- coding: utf-8 -*-
 4 # Author: zhang
 5 
 6 import yaml
 7 import json
 8 
 9 file_path = "demo_04_compose.yml"
10 file = open(file_path, 'r')
11 
12 ys = yaml.load_all(file.read(), Loader=yaml.Loader)
13 for y in ys: 
14   # 两种打印方式都尝试下  
15   print y
16   #print json.dumps(y, indent=2)

 

输出结果，仔细对比下

 1 [root@docker02 yaml]# python demo_04_compose.py 
 2 {'shop': 'GoodShopping', 'goods': {'Food': [{'food02': 'pork', 'sell_time': 'AM 08:30', 'food01': 'rice'}], 'Fruits': [{'sell_time': 'AM 09:00'}, {'fruit01': 'orange', 'price': 3.5}, {'price': 3.0, 'fruit02': 'banana'}], 'clothes': [{'sell_time': 'AM 09:30'}, 'clothe01', 'clothe02']}, 'address': 'BJ'}
 3 # 或者结果如下
 4 [root@docker02 yaml]# python demo_04_compose.py 
 5 {
 6   "shop": "GoodShopping", 
 7   "goods": {
 8     "Food": [
 9       {
10         "food02": "pork", 
11         "sell_time": "AM 08:30", 
12         "food01": "rice"
13       }
14     ], 
15     "Fruits": [
16       {
17         "sell_time": "AM 09:00"
18       }, 
19       {
20         "fruit01": "orange", 
21         "price": 3.5
22       }, 
23       {
24         "price": 3.0, 
25         "fruit02": "banana"
26       }
27     ], 
28     "clothes": [
29       {
30         "sell_time": "AM 09:30"
31       }, 
32       "clothe01", 
33       "clothe02"
34     ]
35   }, 
36   "address": "BJ"
37 }

 

YAML-纯量数据类型

备注：之所以对yaml文件使用Python进行解析，是因为我们要测验yaml文件格式是否书写正确。

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

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

 

常用数据类型的表示格式进行了约定

 1 [root@docker02 yaml]# cat demo_05_scalars.yml
 2 boolean: 
 3   - TRUE   # true,True都可以
 4   - FALSE  # false，False都可以
 5 float:
 6   - 3.14
 7   - 6.8523015e+5  #可以使用科学计数法
 8 int:
 9   - 123
10 null:
11   nodeName: 'node'
12   parent: ~  # 使用~表示null
13 string:
14   - 哈哈
15   - 'Hello world'  # 可以使用双引号或者单引号包裹特殊字符
16   - newline
17     newline2    # 字符串可以拆成多行，非尾行的每一行换行符都转为空格
18 date:
19   - 2018-02-17    # 日期必须使用ISO 8601格式，即yyyy-MM-dd
20 datetime: 
21   -  2018-02-17T15:02:31+08:00    #时间使用ISO 8601格式，时间和日期之间使用T连接，最后使用+代表时区

 

双叹号强制转换类型

yaml文件

1 [root@docker02 yaml]# cat demo_06_switch.yml 
2 # 原信息
3 ori01: 3.14
4 ori02: "123"
5 # 强制转换
6 int_str: !!str 3.14  # value 整数强制转换为字符串
7 str_int: !!int "123" # value 字符串强制转换为整数

 

Python解析

 1 [root@docker02 yaml]# cat demo_06_switch.py 
 2 #!/usr/bin/env python
 3 # -*- coding: utf-8 -*-
 4 # Author: zhang
 5 
 6 import yaml
 7 import json
 8 
 9 file_path = "demo_06_switch.yml"
10 file = open(file_path, 'r')
11 
12 ys = yaml.load_all(file.read(), Loader=yaml.Loader)
13 for y in ys: 
14   # 两种打印方式都尝试下  
15   print y
16   #print json.dumps(y, indent=2)

 

输出结果，仔细对比下

 1 [root@docker02 yaml]# python demo_06_switch.py 
 2 {'ori01': 3.14, 'int_str': '3.14', 'ori02': '123', 'str_int': 123}
 3 # 或者输出如下
 4 [root@docker02 yaml]# python demo_06_switch.py 
 5 {
 6   "ori01": 3.14, 
 7   "int_str": "3.14", 
 8   "ori02": "123", 
 9   "str_int": 123
10 }

 

YAML-引用

备注：之所以对yaml文件使用Python进行解析，是因为我们要测验yaml文件格式是否书写正确。

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

yaml文件

 1 [root@docker02 yaml]# cat demo_07_anchor.yml
 2 ---
 3 hr:
 4   - Mark McGwire
 5   # Following node labeled SS
 6   - &SS Sammy Sosa            # 定义要复制的数据
 7 rbi:
 8   - *SS # Subsequent occurrence   这里是数据复制目标
 9   - Ken Griffey
10 ...
11 ---
12 defaults: &defaults
13   adapter:  postgres
14   host:     localhost
15 
16 development:
17   database: myapp_development
18   <<: *defaults
19 
20 test:
21   database: myapp_test
22   info: *defaults
23 ...

 

Python解析

 1 [root@docker02 yaml]# cat demo_07_anchor.py 
 2 #!/usr/bin/env python
 3 # -*- coding: utf-8 -*-
 4 # Author: zhang
 5 
 6 import yaml
 7 import json
 8 
 9 file_path = "demo_07_anchor.yml"
10 file = open(file_path, 'r')
11 
12 ys = yaml.load_all(file.read(), Loader=yaml.Loader)
13 for y in ys: 
14   # 两种打印方式都尝试下  
15   print y
16   #print json.dumps(y, indent=2)

 

输出结果，仔细对比下

 1 [root@docker02 yaml]# python demo_07_anchor.py 
 2 {'hr': ['Mark McGwire', 'Sammy Sosa'], 'rbi': ['Sammy Sosa', 'Ken Griffey']}
 3 {'development': {'adapter': 'postgres', 'host': 'localhost', 'database': 'myapp_development'}, 'test': {'info': {'adapter': 'postgres', 'host': 'localhost'}, 'database': 'myapp_test'}, 'defaults': {'adapter': 'postgres', 'host': 'localhost'}}
 4 # 或者结果如下
 5 [root@docker02 yaml]# python demo_07_anchor.py 
 6 {
 7   "hr": [
 8     "Mark McGwire", 
 9     "Sammy Sosa"
10   ], 
11   "rbi": [
12     "Sammy Sosa", 
13     "Ken Griffey"
14   ]
15 }
16 {
17   "development": {
18     "adapter": "postgres", 
19     "host": "localhost", 
20     "database": "myapp_development"
21   }, 
22   "test": {
23     "info": {
24       "adapter": "postgres", 
25       "host": "localhost"
26     }, 
27     "database": "myapp_test"
28   }, 
29   "defaults": {
30     "adapter": "postgres", 
31     "host": "localhost"
32   }
33 }

 

YAML-字符串

备注：之所以对yaml文件使用Python进行解析，是因为我们要测验yaml文件格式是否书写正确。

字符串是最常见，也是最复杂的一种数据类型。

字符串默认不使用引号表示。

str: 这是一行字符串

 

如果字符串之中包含空格或特殊字符，需要放在引号之中。

str: '内容： 字符串'

 

单引号和双引号都可以使用，双引号不会对特殊字符转义。

s1: '内容\n字符串'
s2: "内容\n字符串"

 

单引号之中如果还有单引号，必须连续使用两个单引号转义。

str: 'labor''s day'

 

字符串可以写成多行，从第二行开始，必须有空格缩进。换行符会被转为空格。

str: 这是一段
  多行
  字符串

 

多行字符串可以使用 | 保留换行符，也可以使用 > 折叠换行。

1 this: |
2   Foo
3   Bar
4 that: >
5   Foo
6   Bar

 

+ 表示保留字符串行末尾的换行，- 表示删除字符串末尾的换行。

1 s1: |
2   Foo
3 
4 s2: |+
5   Foo
6 
7 s3: |-
8   Foo

 

字符串之中可以插入 HTML 标记。

1 message: |
2 
3   <p style="color: red">
4     段落
5   </p>

 

字符串测验案例

yaml文件

 1 [root@docker02 yaml]# cat demo_08_str.yml 
 2 str01: zhangsan
 3 str02: 'Q: What are you doing?'
 4 
 5 str03: 'zhangsan\nlisi\nwangwu'
 6 str04: "zhangsan\nlisi\nwangwu"
 7 
 8 str05: 'What''s your name?'
 9 str06: "What's your name?"
10 
11 str07:
12   'Ken: Hello,
13   My name is Ken.
14   What''s your name?'
15 
16 str08:
17   "Ken: Hello,
18   My name is Ken.
19   What's your name?"
20 
21 str11: |
22   111
23   222
24   333
25 str12: >
26   aaa xxx
27   bbb yyy
28   ccc zzz
29 
30 # 之后有2行空行
31 str16: |
32   zhangsan
33   lisi
34   wangwu
35 
36 
37 # 之后有2行空行
38 str17: |+
39   zhangsan
40   lisi
41   wangwu
42 
43 
44 # 之后有2行空行
45 str18: |-
46   zhangsan
47   lisi
48   wangwu
49 
50 
51 message: |
52 
53   <p style="color: red"> 
54     one line str
55   </p>

 

Python解析

 1 [root@docker02 yaml]# cat demo_08_str.py 
 2 #!/usr/bin/env python
 3 # -*- coding: utf-8 -*-
 4 # Author: zhang
 5 
 6 import yaml
 7 import json
 8 
 9 file_path = "demo_08_str.yml"
10 file = open(file_path, 'r')
11 
12 ys = yaml.load_all(file.read(), Loader=yaml.Loader)
13 for y in ys: 
14   # 两种打印方式都尝试下  
15   print y
16   #print json.dumps(y, indent=2)

 

输出结果，仔细对比下

 1 [root@docker02 yaml]# python demo_08_str.py 
 2 {'str02': 'Q: What are you doing?', 'str01': 'zhangsan', 'str05': "What's your name?", 'str08': "Ken: Hello, My name is Ken. What's your name?", 'str06': "What's your name?", 'str18': 'zhangsan\nlisi\nwangwu', 'str17': 'zhangsan\nlisi\nwangwu\n\n\n', 'str16': 'zhangsan\nlisi\nwangwu\n', 'message': u'\n<p style="color: red">\n  one line str\n</p>\n', 'str03': 'zhangsan\\nlisi\\nwangwu', 'str04': 'zhangsan\nlisi\nwangwu', 'str12': 'aaa xxx bbb yyy ccc zzz\n', 'str11': '111\n222\n333\n', 'str07': "Ken: Hello, My name is Ken. What's your name?"}
 3 # 或者输出如下
 4 [root@docker02 yaml]# python demo_08_str.py 
 5 {
 6   "str02": "Q: What are you doing?", 
 7   "str01": "zhangsan", 
 8   "str05": "What's your name?", 
 9   "str08": "Ken: Hello, My name is Ken. What's your name?", 
10   "str06": "What's your name?", 
11   "str18": "zhangsan\nlisi\nwangwu", 
12   "str17": "zhangsan\nlisi\nwangwu\n\n\n", 
13   "str16": "zhangsan\nlisi\nwangwu\n", 
14   "message": "\n<p style=\"color: red\">\n  one line str\n</p>\n",
15   "str03": "zhangsan\\nlisi\\nwangwu", 
16   "str04": "zhangsan\nlisi\nwangwu", 
17   "str12": "aaa xxx bbb yyy ccc zzz\n", 
18   "str11": "111\n222\n333\n", 
19   "str07": "Ken: Hello, My name is Ken. What's your name?"
20 }

 

完毕！

 

———END———
如果觉得不错就关注下呗 (-^O^-) ！

 

posted on 2020-07-11 08:15  踏歌行666  阅读(1600)  评论(0)  编辑  收藏  举报

导航