yaml是一种比xml和json更轻的文件格式,也更简单更强大,它可以通过缩进来表示结构,听着就和Python很配对不对?
yaml的介绍不在这里赘述,感兴趣可以自行百度下,先说下它的基本语法,还是配合着PyYaml来:
1. PyYaml
PyYaml是Python的一个专门针对yaml文件操作的模块,使用起来非常简单。
- 安装:
pip install PyYaml
或者到这里下载相应版本的包,人工安装,http://pyyaml.org/wiki/PyYAML 点击打开链接。
- 使用:
使用起来非常简单,就像json、pickle一样,load、dump就足够我们使用了。
load()
import yaml yaml_str = """ name: 灰蓝 age: 0 job: Tester """ y = yaml.load(yaml_str) print y
结果:{'job': 'Tester', 'age': 0, 'name': u'\u7070\u84dd'}
dump()
import yaml python_obj = {"name": u"灰蓝", "age": 0, "job": "Tester" } y = yaml.dump(python_obj, default_flow_style=False) print y
输出结果:
age: 0
job: Tester
name: "\u7070\u84DD"
上面只是简单的两个应用,还有 load_all()
、dump_all()
等,我们一般用这四个足够了,另外两个下面会讲到,其他方法可以自己看API,我也没怎么折腾过。
2. yaml语法
https://www.ibm.com/developerworks/cn/xml/x-cn-yamlintro/点击打开链接
有了上面的基础,接下来我们看看yaml的语法,首先我们准备下测试语法的环境:
创建
test.yaml
文件,我们练习语法就在这里创建
testyaml.py
文件,用来查看Python执行后的效果,其中内容如下:
# -*- coding: utf-8 -*- import yaml y = yaml.load(file('test.yaml', 'r')) print y
好了,接下来我们就来看语法吧:
1. 基本规则
- 大小写敏感
- 使用缩进表示层级关系
- 缩进时不允许使用Tab,只允许使用空格
- 缩进的空格数目不重要,只要相同层级的元素左对齐即可
#
表示注释,从它开始到行尾都被忽略
2. yaml转字典
yaml中支持映射或字典的表示,如下:
#test.yaml #下面格式读到Python里会是个dict name: 灰蓝 age: 0 job: Tester
#coding:utf-8 import yaml import os #open('test.yaml','w') #如果没有创建test.yaml,先使用open在当前目录下创建文件 #方法一 output = yaml.load(file("test.yaml")) print output #方法二 #filename = os.path.join(os.path.dirname(__file__), 'test.yaml').replace("\\", "/") #output = yaml.load(open(filename)) #print output
输出:{'job': 'Tester', 'age': 0, 'name': u'\u7070\u84dd'}
3. yaml转列表
yaml中支持列表或数组的表示,注意裂变中的每一个元素前面用符号 - 如下:
#test.yaml #下面格式读到Python里会是个list - 灰蓝 - 0 - Tester
在test.ymal文件中:
输出:[u'\u7070\u84dd', 0, 'Tester']
4. 复合结构
字典和列表可以复合起来使用,注意这里使用 - 如下:
# test.yaml #下面格式读到Python里是个list里包含dict - name: 灰蓝 age: 0 job: Tester - name: James age: 30
输出:[{'job': 'Tester', 'age': 0, 'name': u'\u7070\u84dd'}, {'age': 30, 'name': 'James'}]
5. 基本类型
yaml中有以下基本类型:
- 字符串
- 整型
- 浮点型
- 布尔型
- null
- 时间
- 日期
我们写个例子来看下:
# test.yaml #这个例子输出一个字典,其中value包括所有基本类型 str: "Hello World!" int: 110 float: 3.141 boolean: true # or false None: null # 也可以用 ~ 号来表示 null time: 2016-09-22t11:43:30.20+08:00 # ISO8601,写法百度 date: 2016-09-22 # 同样ISO8601
输出:
{'date': datetime.date(2016, 9, 22), 'None': None, 'boolean': True, 'str': 'Hello World!', 'time': datetime.datetime(2016, 9, 22, 3, 43, 30, 200000), 'int': 110, 'float': 3.141}
如果字符串没有空格或特殊字符,不需要加引号,但如果其中有空格或特殊字符,则需要加引号了
#test.yaml str: 灰蓝 str1: "Hello World" str2: "Hello\nWorld"
输出结果:{'str2': 'Hello\nWorld', 'str1': 'Hello World', 'str': u'\u7070\u84dd'}
这里要注意单引号和双引号的区别,单引号中的特殊字符转到Python会被转义,也就是到最后是原样输出了,双引号不会被Python转义,到最后是输出了特殊字符;可能比较拗口,来个例子理解下:
#test.yaml str1: 'Hello\nWorld' str2: "Hello\nWorld"
# -*- coding: utf-8 -*- import yaml y = yaml.load(file('test.yaml', 'r')) print y['str1'] print y['str2']
输出:
Hello\nWorld
Hello
World
可以看到,单引号中的’\n’最后是输出了,双引号中的’\n’最后是转义成了回车
字符串处理中写成多行、’|’、’>’、’+’、’-‘的意义这里就不讲了。
6. 引用
&
和 *
用于引用
#test.yaml name: &name 灰蓝 tester: *name
这个相当于一下脚本:
#test.yaml name: 灰蓝 tester: 灰蓝
输出:{'name': u'\u7070\u84dd', 'tester': u'\u7070\u84dd'}
7. 强制转换
yaml是可以进行强制转换的,用 !!
实现,如下:
#test.yaml str: !!str 3.14 int: !!int "123"
输出:{'int': 123, 'str': '3.14'}
明显能够看出123被强转成了int类型,而float型的3.14则被强转成了str型。另外PyYaml还支持转换成Python/object类型,这个我们下面再讨论。
8. 分段
在同一个yaml文件中,可以用 ---
来分段,这样可以将多个文档写在一个文件中
#test.yaml --- name: James age: 20 --- name: Lily age: 19
这时候我们就得用到我们的 load_all()
方法出场了,load_all()
方法会生成一个迭代器,可以用for输出出来:
# -*- coding: utf-8 -*- import yaml ys = yaml.load_all(file('test.yaml', 'r')) for y in ys: print y
输出:
{'age': 20, 'name': 'James'}
{'age': 19, 'name': 'Lily'}
对应的也有 dump_all()
方法,一个意思,就是将多个段输出到一个文件中,如:
# -*- coding: utf-8 -*- import yaml obj1 = {"name": "James", "age": 20} obj2 = ["Lily", 19] with open('test.yaml', 'w') as f: yaml.dump_all([obj1, obj2], f)
打开test.yaml看看:
{age: 20, name: James}
--- [Lily, 19]
dump()
和 dump_all()
方法可以传入列表,也可以传入一个可序列化生成器,如 range(10)
, 如下:
# -*- coding: utf-8 -*- import yaml y = yaml.dump(range(10)) print y
输出:
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
在 dump
和 dump_all()
的时候还可以配一堆参数,不一一讲解了(其实博主也不全了解。。)
3. 构造器(constructors)、表示器(representers)、解析器(resolvers )
这几个东西可以把Python的对象和yaml互转,很强大。这个翻译是博主自个儿翻译的,表达的不准确勿怪。
1. yaml.YAMLObject
yaml.YAMLObject用元类来注册一个构造器(也就是代码里的 __init__()
方法),让你把yaml节点转为Python对象实例,用表示器(也就是代码里的 __repr__()
函数)来让你把Python对象转为yaml节点,看代码:
# -*- coding: utf-8 -*- import yaml class Person(yaml.YAMLObject): yaml_tag = '!person' def __init__(self, name, age): self.name = name self.age = age def __repr__(self): return '%s(name=%s, age=%d)' % (self.__class__.__name__, self.name, self.age) james = Person('James', 20) print yaml.dump(james) # Python对象实例转为yaml lily = yaml.load('!person {name: Lily, age: 19}') print lily # yaml转为Python对象实例
输出:
!person {age: 20, name: James}
Person(name=Lily, age=19)
2. yaml.add_constructor
和 yaml.add_representer
你可能在使用过程中并不想通过上面这种元类的方式,而是想定义正常的类,那么,可以用这两种方法
# -*- coding: utf-8 -*- import yaml class Person(object): def __init__(self, name, age): self.name = name self.age = age def __repr__(self): return 'Person(%s, %s)' % (self.name, self.age) james = Person('James', 20) print yaml.dump(james) # 没加表示器之前 def person_repr(dumper, data): return dumper.represent_mapping(u'!person', {"name": data.name, "age": data.age}) # mapping表示器,用于dict yaml.add_representer(Person, person_repr) # 用add_representer方法为对象添加表示器 print yaml.dump(james) # 加了表示器之后 def person_cons(loader, node): value = loader.construct_mapping(node) # mapping构造器,用于dict name = value['name'] age = value['age'] return Person(name, age) yaml.add_constructor(u'!person', person_cons) # 用add_constructor方法为指定yaml标签添加构造器 lily = yaml.load('!person {name: Lily, age: 19}') print lily
输出:
!!python/object:__main__.Person {age: 20, name: James}
!person {age: 20, name: James}
Person(Lily, 19)
第一行是没加表示器之前,多丑!中间那行是加了表示器之后,变成了规范的格式,下面添加了构造器,能够把 !person
标签转化为Person对象。
这里用了 construct_mapping
,还有其他好多 construct_document
, construct_object
,construct_scalar
,construct_sequence
,construct_pairs
,具体怎么用,可以自己研究下,看看API,看看源码学习下。
对应的 representer
也一样,有很多,这里只用了 represent_mapping
,其他的不示例讲解了。
3. add_implicit_resolver
如果你不想每次都写标签,也可以用 add_implicit_resolver
方法添加解析器,然后它就能够把指定样式的没有标签的基本元素解析成对应的Python对象。这个就不详细分析给示例了。感兴趣的同学自己看文档学习吧。
4. 结语
yaml是一种很清晰、简洁的格式,而且跟Python非常合拍,非常容易操作,我们在搭建自动化测试框架的时候,可以采用yaml作为配置文件,或者用例文件,下面给出一个用例的示例,这个示例来自于Python restful接口框架 pyresttest
:
# Test using included Django test app # First install python-django # Then launch the app in another terminal by doing # cd testapp # python manage.py testserver test_data.json # Once launched, tests can be executed via: # python resttest.py http://localhost:8000 miniapp-test.yaml --- - config: - testset: "Tests using test app" - test: # create entity - name: "Basic get" - url: "/api/person/" - test: # create entity - name: "Get single person" - url: "/api/person/1/" - test: # create entity - name: "Get single person" - url: "/api/person/1/" - method: 'DELETE' - test: # create entity by PUT - name: "Create/update person" - url: "/api/person/1/" - method: "PUT" - body: '{"first_name": "Gaius","id": 1,"last_name": "Baltar","login": "gbaltar"}' - headers: {'Content-Type': 'application/json'} - test: # create entity by POST - name: "Create person" - url: "/api/person/" - method: "POST" - body: '{"first_name": "Willim","last_name": "Adama","login": "theadmiral"}' - headers: {Content-Type: application/json}
怎么样,赶紧用起来吧!有什么问题欢迎跟博主交流了沟通!
转载:https://blog.csdn.net/huilan_same/article/details/52625230 转载出处