yaml基础知识

Yaml基础知识

Author：Onceday Date：2022年11月12日

漫漫长路。有人对你微笑过嘛…

1.简介

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

YAML 的语法和其他高级语言类似，并且可以简单表达清单、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲。

有数百种不同的编程语言，但只有少数几种语言用于存储和传输数据。尽管YAML的潜力几乎是无限的，但它是专门为一些常见用例而创建的，例如:配置文件、日志文件、进程间消息传递、跨语言数据共享、对象持久性和复杂数据结构的调试。当数据易于查看和理解时，编程就变得更简单了。

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

参考文档：

• YAML 入门教程 | 菜鸟教程 (runoob.com)
• YAML块样式 - YAML教程 (yiibai.com)
• The Official YAML Web Site
• YAML Ain’t Markup Language (YAML™) revision 1.2.2

可以在python里面快速体验yaml，需要安转以下包之一：

• pip3 install ruamel.yaml这个是版本1.2
• pip3 install PyYAML这个是版本1.1

以ruamel.yaml使用为例：Examples — Python YAML package documentation

import sys
from ruamel.yaml import YAML

inp = """\
# example
name:
  # details
  family: Smith   # very common
  given: Alice    # one of the siblings
"""

yaml = YAML()
code = yaml.load(inp)
code['name']['given'] = 'Bob'

yaml.dump(code, sys.stdout)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

2.基础语法

2.1 基本格式

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

2.2 数据类型

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

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

2.3 对象

对象键值使用冒号结构来表示，冒号后面要加一个空格、

如key:value和key:{key1:value1,key2:value2,...}

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

key: 
    child-key: value
    child-key2: value2
1
2
3

复杂的对象格式，可以如下表示， ?表明一个复杂的映射键名：

?  
    - complexkey1
    - complexkey2
:
    - complexvalue1
    - complexvalue2
1
2
3
4
5
6

意思即对象的属性是一个数组 [complexkey1,complexkey2]，对应的值也是一个数组 [complexvalue1,complexvalue2]

2.4 yaml数组

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

- A
- B
- C
1
2
3

也可表示在一行：key:[value1, value2, ...]。

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

-
 - A
 - B
 - C
1
2
3
4

下面是一个复杂的例子：

companies:
    -
        id: 1
        name: company1
        price: 200W
    -
        id: 2
        name: company2
        price: 500W
1
2
3
4
5
6
7
8
9

意思是 companies 属性是一个数组，每一个数组元素又是由 id、name、price 三个属性构成。

数组也可以使用流式(flow)的方式表示：

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

2.5 复合结构

数组和对象可以构成复合结构，例：

languages:
  - Ruby
  - Perl
  - Python 
websites:
  YAML: yaml.org 
  Ruby: ruby-lang.org 
  Python: python.org 
  Perl: use.perl.org
1
2
3
4
5
6
7
8
9

转换为 json 为：

{ 
  languages: [ 'Ruby', 'Perl', 'Python'],
  websites: {
    YAML: 'yaml.org',
    Ruby: 'ruby-lang.org',
    Python: 'python.org',
    Perl: 'use.perl.org' 
  } 
}
1
2
3
4
5
6
7
8
9

2.6 纯量

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

• 字符串
• 布尔值
• 整数
• 浮点数
• 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连接，最后使用+代表时区
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

2.7 引用

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

defaults: &defaults
  adapter:  postgres
  host:     localhost

development:
  database: myapp_development
  <<: *defaults

test:
  database: myapp_test
  <<: *defaults
1
2
3
4
5
6
7
8
9
10
11

相当于:

defaults:
  adapter:  postgres
  host:     localhost

development:
  database: myapp_development
  adapter:  postgres
  host:     localhost

test:
  database: myapp_test
  adapter:  postgres
  host:     localhost
1
2
3
4
5
6
7
8
9
10
11
12
13

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

下面是另一个例子:

- &showell Steve 
- Clark 
- Brian 
- Oren 
- *showell 
1
2
3
4
5

转为 JavaScript 代码如下:

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

2.8 结构开始和结束

YAML可以使用---来表示一个YAML文档的开始，...表示一个YAML文档的结束。

# Ranking of 1998 home runs
---
- Mark McGwire
- Sammy Sosa
- Ken Griffey

# Team ranking
---
- Chicago Cubs
- St Louis Cardinals
1
2
3
4
5
6
7
8
9
10

---
time: 20:03:20
player: Sammy Sosa
action: strike (miss)
...
---
time: 20:03:47
player: Sammy Sosa
action: grand slam
...
1
2
3
4
5
6
7
8
9
10

2.9 标量表示

标量内容可以用块表示法编写，使用文字样式(由“|”表示)，其中所有换行符都是有效的。或者，也可以使用折叠样式(用“>”表示)来编写换行符，其中每个换行符都被折叠为一个空格，除非换行符以空行或更缩进的行结束。

name: Mark McGwire
accomplishment: >
  Mark set a major league
  home run record in 1998.
stats: |
  65 Home Runs
  0.278 Batting Average
1
2
3
4
5
6
7

输出：

 ('name', 'Mark McGwire'), ('accomplishment', 'Mark set a major league home run record in 1998.\n'), 
('stats', '65 Home Runs\n0.278 Batting Average\n')
1
2

YAML的流标量包括普通样式(到目前为止的大多数示例)和两种引用样式。双引号样式提供转义序列。当不需要转义时，单引号样式很有用。所有的流量标量都可以跨越多条线;换行符总是折叠的。

unicode: "Sosa did fine.\u263A"
control: "\b1998\t1999\t2000\n"
hex esc: "\x0d\x0a is \r\n"

single: '"Howdy!" he cried.'
quoted: ' # Not a ''comment''.'
tie-fighter: '|\-*-/|'

plain:
  This unquoted scalar
  spans many lines.

quoted: "So does this
  quoted scalar.\n"
1
2
3
4
5
6
7
8
9
10
11
12
13
14

2.10 标签

在YAML中，根据应用程序给出未标记节点的类型。本规范中的示例通常使用来自故障安全模式的seq、map和str类型。一些示例还使用JSON模式中的int、float和null类型。

整数类型：

canonical: 12345
decimal: +12345
octal: 0o14
hexadecimal: 0xC
1
2
3
4

浮点类型：

canonical: 1.23015e+3
exponential: 12.3015e+02
fixed: 1230.15
negative infinity: -.inf
not a number: .nan
1
2
3
4
5

混合类型：

null:
booleans: [ true, false ]
string: '012345'
1
2
3

时间标签：

canonical: 2001-12-15T02:59:43.1Z
iso8601: 2001-12-14t21:59:43.10-05:00
spaced: 2001-12-14 21:59:43.10 -5
date: 2002-12-14
1
2
3
4

显式类型用一个使用感叹号(“!”)符号的标记表示。全局标记是uris，可以在使用句柄的标记简写符号中指定。还可以使用特定于应用程序的本地标记。

不同的显示标签：

not-date: !!str 2002-04-28

picture: !!binary |
 R0lGODlhDAAMAIQAAP//9/X
 17unp5WZmZgAAAOfn515eXv
 Pz7Y6OjuDg4J+fn5OTk6enp
 56enmleECcgggoBADs=

application specific tag: !something |
 The semantics of the tag
 above may be different for
 different documents.
1
2
3
4
5
6
7
8
9
10
11
12

3. 模型