YAML书写规范

发布时间：2020-12-16 23:56:31 所属栏目：Python 来源：网络整理

导读：h4 id="h4_0"1. 认识 YAML YAML是一个类似 XML、JSON 的标记性语言。YAML 强调以数据为中心，并不是以标识语言为重点。因而 YAML 本身的定义比较简单，号称“一种人性化的数据格式语言”。人类容易阅读可用于不同程序间的数据交换适合描述程序所使用的数

<h4 id="h4_0">1. 认识 YAML

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

人类容易阅读

可用于不同程序间的数据交换

适合描述程序所使用的数据结构，特别是脚本语言

丰富的表达能力与可扩展性

易于使用

YAML 与 XML

具有 XML 同样的优点，但比 XML 更加简单、敏捷等

YAML 与 JSON

JSON 可以看作是 YAML 的子集，也就是说 JSON 能够做的事情，YAML 也能够做

YAML 能表示得比 JSON 更加简单和阅读，例如“字符串不需要引号”。所以 YAML 容易可以写成 JSON 的格式，但并不建议这种做

YAML 能够描述比 JSON 更加复杂的结构，例如“关系锚点”可以表示数据引用（如重复数据的引用）。

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

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

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

　　YAML 认为数据由以下三种结构组成：（每个文档由三种结构混合组成）

标量（相当于数据类型）

序列（相当于数组和列表）

键值表（相当于 Map 表）

规范一：文档使用 Unicode 编码作为字符标准编码，例如 UTF-8
规范二：使用“#”来表示注释内容
规范三：使用空格作为嵌套缩进工具。通常建议使用两个空格缩进，不建议使用 tab （甚至不支持）
规范四：序列表示
- 使用“-”（横线） + 单个空格表示单个列表项
- 使用"[]"表示一组数据
- 组合表示。每个结构都可以嵌套组成复杂的表示结构。
规范五：键值表
- 使用 “:”（冒号） + 空格表示单个键值对
- 使用"{}"表示一个键值表
- "? " 问号+空格表示复杂的键。当键是一个列表或键值表时，就需要使用本符号来标记。
- 组合表示。每个结构都可以嵌套组成复杂的表示结构。?
```
相当于 (也是 JSON 的表示)
```

{Color: [blue,green]}

div:
- border: {color: red,width: 2px}
- background: {color: green}
- padding: [0,10px,10px]

使用缩进表示的键值表与列表项

items:
- item: cpu
model: i3
price: ￥800.00
- item: HD
model: WD
price: ￥450.00

上面使用 “-” 前导与缩进来表示多个列表项，相当于下面的JSON表示

items: [{item:cpu,model:i3,price:￥800.00},{item:HD,model:WD,price: ￥450.00}]

规范六：文本块

使用 “|” 和文本内容缩进表示的块：保留块中已有的回车换行。相当于段落块

使用 “>” 和文本内容缩进表示的块：将块中回车替换为空格，最终连接成一行。

      # 注意 如果你想更深入的学习YAML，我建议你去 <span class="hljs-attribute">http:<span class="hljs-comment">//www.yaml.org 看看

使用定界符“”（双引号）、‘’（单引号）或回车表示的块：最终表示成一行。

<span class="hljs-attr">yaml:     <span class="hljs-comment"># 使用了双引号，双引号的好处是可以转义，即在里面可以使用特殊符号

<span class="hljs-string">"JSON的语法其实是YAML的子集，

大部分的JSON文件都可以被YAML的解释器解释。"

规范七：数据类型的约定

对一些常用数据类型的表示格式进行了约定，包括:

<span class="hljs-attr"> float: <span class="hljs-number">1.23e+3     <span class="hljs-comment"># 浮点数

<span class="hljs-attr"> fixed: <span class="hljs-number">13.67       <span class="hljs-comment"># 固定小数

<span class="hljs-attr"> minmin: -.inf      <span class="hljs-comment"># 表示负无穷

<span class="hljs-attr"> notNumber: .NaN    <span class="hljs-comment"># 无效数字
<span class="hljs-attr"> null:              <span class="hljs-comment"># 空值

<span class="hljs-attr"> boolean: [<span class="hljs-literal">true,<span class="hljs-literal">false] <span class="hljs-comment"># 布尔值

<span class="hljs-attr"> string: <span class="hljs-string">'12345'    <span class="hljs-comment"># 字符串
<span class="hljs-attr"> date: <span class="hljs-number">2015<span class="hljs-bullet">-08<span class="hljs-bullet">-23   <span class="hljs-comment"># 日期

<span class="hljs-attr"> datetime: <span class="hljs-number">2015<span class="hljs-bullet">-08<span class="hljs-bullet">-23T02:<span class="hljs-number">02:<span class="hljs-number">00.1z  <span class="hljs-comment"># 日期时间

<span class="hljs-attr"> iso8601: <span class="hljs-number">2015<span class="hljs-bullet">-08<span class="hljs-bullet">-23t21:<span class="hljs-number">59:<span class="hljs-number">43.10<span class="hljs-bullet">-05:<span class="hljs-number">00  <span class="hljs-comment"># iso8601 日期格式

<span class="hljs-attr"> spaced: <span class="hljs-number">2015<span class="hljs-bullet">-08<span class="hljs-bullet">-23 <span class="hljs-number">21:<span class="hljs-number">59:<span class="hljs-number">43.10 <span class="hljs-bullet">-5      <span class="hljs-comment"># ?

“!”（叹号）显式指示类型，或自定义类型标识。单叹号通常是自定义类型，双叹号是内置类型

<span class="hljs-comment">#下面是一些例子：

<span class="hljs-bullet"> --- <span class="hljs-type">!!omap

<span class="hljs-attr"> - Mark: <span class="hljs-number">65

<span class="hljs-attr"> - Sammy: <span class="hljs-number">63

<span class="hljs-attr"> - Key: <span class="hljs-number">58
<span class="hljs-bullet"> --- <span class="hljs-type">!!set           <span class="hljs-comment"># 注意，“?”表示键为列表，在这里列表为 null

? Mark

? Sammy

? Key
<span class="hljs-comment"># 下面是自定义的类型或标识

%TAG ! tag:clarkevans.com,<span class="hljs-number">2002:   <span class="hljs-comment"># % 是指令符号

<span class="hljs-bullet"> --- !shape

<span class="hljs-comment"># Use the ! handle for presenting

<span class="hljs-comment"># tag:clarkevans.com,2002:circle

<span class="hljs-bullet"> - !circle

<span class="hljs-attr">   center: &ORIGIN {x: <span class="hljs-number">73,y: <span class="hljs-number">129}

<span class="hljs-attr">   radius: <span class="hljs-number">7

<span class="hljs-bullet"> - !line

<span class="hljs-attr">   start: <span class="hljs-meta">ORIGIN

<span class="hljs-attr">   finish: { x: <span class="hljs-number">89,y: <span class="hljs-number">102 }

<span class="hljs-bullet"> - !label

<span class="hljs-attr">   start: <span class="hljs-meta">ORIGIN

<span class="hljs-attr">   color: <span class="hljs-number">0xFFEEBB

<span class="hljs-attr">   text: Pretty vector drawing.

规范八：锚点与引用，定义数据的复用。

第一步：使用 “&” 定义数据锚点（即要复制的数据）
第二步：使用 “*” 引用上述锚点数据（即数据的复制目的地）

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!

YAML书写规范

人类容易阅读 可用于不同程序间的数据交换 适合描述程序所使用的数据结构，特别是脚本语言 丰富的表达能力与可扩展性 易于使用

使用缩进表示的键值表与列表项

上面使用 “<span class="hljs-selector-tag">-” 前导与缩进来表示多个列表项，相当于下面的<span class="hljs-selector-tag">JSON表示

人类容易阅读

可用于不同程序间的数据交换

适合描述程序所使用的数据结构，特别是脚本语言

丰富的表达能力与可扩展性

易于使用