YAML 在Python中的配置应用

- 环境搭建
- YAML语法
  - 语法规则
  - 数据结构
    - 列表数组
    - 原子量
- YAML应用
  - 案例
  - load
  - dump
- 总结

YAML是一个堪比XML，JSON数据格式的更加方便，简洁的，易于人眼阅读的序列化数据格式。在很多的脚本语言中都有涉及，下面以其在Python语言中为例，简单的记录一下，以备今后复习所用。

环境搭建

这貌似是所有试验的开场白了，那就是搭建好本次试验的环境。因为Python解析的时候，需要解析器的支持，所以需要安装一个。

下载地址：http://pyyaml.org/wiki/PyYAML
下载解析器支持

博主的为windows64位，所以选择途中箭头所示的版本。具体要依照个人情况而定。

安装是否成功的验证方法就是打开Python解释器，import一下即可。若出现下图，那么恭喜，环境搭建完毕了。
验证yaml环境是否安装成功

YAML语法

提及到语法层面，就得严肃认真一点了。之前看过阮一峰老师关于YAML在JavaScript中的应用，对比在Python中的应用，原理其实是一致的。可以参考一下：

语法规则

总的来说，语法没什么难度，也是人们司空见惯的了。
- 大小写敏感
- 使用缩进表示层级关系
- 缩进时不允许使用Tab键，只允许使用空格。
- 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可

另外，和Python的注释方式一样，以#号作为注释符，很人性化了吧。

数据结构

YAML本身语法很简单，但是却可以基于此实现比较强大的配置功能。思考一下，作为一个配置文件，可能出现的情况有哪些？

一连串类型一致的数据？
基本的数据类型？
key-value组合？

其实，认真的思考一下就会明白了。YAML不是一个凭空捏造的数据格式，而是经过了实际考验的人性化设计的一套规范。针对上面的问题，答案就是YAML本身支持的数据结构了，也很好记忆。

列表，数组（一串类型相同或者不同的组合）
纯量（类似于原子性，不可再分）
对象（键值对的组合，一对一的特性）

列表，数组

类比Python语言，YAML性质与其保持一致。但是书写方式上来说嘛，也可以是不一致的。大致有如下两种：

[]式：

['数组1','数组2','数组3','数组4','数组5']

竖-式：

- 数组1
- 数组2
- 数组3
- 数组4
- 数组5

注意好符合一开始讲的，语法规则即可。

原子量

也即是纯量，不能再细分的数据结构。类比其他的编程语言，YAML也充分地考虑到了这一点。

数值型：直接书写即可。不区分整型还是浮点型。
字符串：字符串可以加引号，也可以不加。还有相关于换行什么的更多特殊的用法，这里强烈建议阅读以下阮一峰老师的这篇文章：
http://www.ruanyifeng.com/blog/2016/07/yaml.html?f=tt
- 单引号内会自动的转义特殊字符，对单引号转义是使用两个单引号，其表示一个原生的单引号。
- 双引号内保持原字符不变。
日期，时间：
- 时间： ISO8601 格式。如2001-12-14t21:59:43.10-05:00
- 日期：采用复合 iso8601 格式的年、月、日表示。如1970-01-01
关于强制类型转换：可以通过两个英文感叹号+新的数据类型的方式来进行强制的类型转换。

如：

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

将变为：

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

除此简单的介绍之外，YAML还有很多更为奇妙的语法，但是掌握了这些基础的使用，写一个配置文件基本上就够用了。如果有兴趣的话，可以在深入的研究一下。

YAML应用

这里主要是记录一下YAML在Python语言中的应用。类比于json库，yaml库与其有惊人的相似之处。一个load方法，一个dump方法。顾名知义，也比较的好理解。

案例

下面是从网上找的一个简单的按照YAML语法书写的一个文件，将作为待会的源来使用。

name: Tom Smith
age: 37
spouse:
    name: Jane Smith
    age: 25
children:
 - name: Jimmy Smith
   age: 15
 - name1: Jenny Smith
   age1: 12

load

# coding:utf-8
import sys

reload(sys)
sys.setdefaultencoding('utf8')
#    __author__ = '郭 璞'
#    __date__ = '2016/10/31'
#    __Desc__ = YAML 在Python中的应用

import yaml

stream = file('example.yaml', 'r')
data = yaml.load(stream)
print data['children'][0]['name']

所得结果为：

Jimmy Smith

理解层面以Python中的dict来理解即可。

dump

# coding:utf-8
import sys

reload(sys)
sys.setdefaultencoding('utf8')
#    __author__ = '郭 璞'
#    __date__ = '2016/10/31'
#    __Desc__ = YAML 在Python中的应用

import yaml

s = 'I have an apple'
print yaml.dump(s)

lists = ['zhangsan', 'lisi', 'wangwu', 'zhaoliu']
print yaml.dump(lists)


class Person(object):
    def __init__(self, name, age):
        self.name = name
        self.age = age

p1 = Person('zhangsan', 19)
p2 = Person('lisi', 20)
p3 = Person('wangwu', 21)

persons = [p1, p2, p3]

print yaml.dump(persons)

运行结果：

I have an apple
...

[zhangsan, lisi, wangwu, zhaoliu]

- !!python/object:__main__.Person {age: 19, name: zhangsan}
- !!python/object:__main__.Person {age: 20, name: lisi}
- !!python/object:__main__.Person {age: 21, name: wangwu}

同样的，这里也可以看到强制类型转换的身影。

总结

这样的话，类比json库的学习，yaml库也可以很好的被应用了。
使用这样的方式可以最大限度的解耦和代码，实现更高的可移植性。

同样，写配置文件也不一定要用YAML，还可以有很多的选择，比如ConfigParser了， .ini了，还可以自定义（借助于正则表达式做好相关的存取即可）。

没有哪种是最好的，只有适合的才是最好的。在不同的场合选择适合自己的配置文件的书写方式即可。

(^__^) 嘻嘻……

Biegral Blog