python yaml用法詳解

YAML是一種直觀的能夠被電腦識別的的數據序列化格式，容易被人類閱讀，並且容易和腳本語言交互。YAML類似於XML，但是語法比XML簡單得多，對於轉化成數組或可以hash的數據時是很簡單有效的。 
一、PyYaml 
1、load() :返回一個對象 
我們先創建一個yml文件，config.yml:

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

import yaml f = open(r'E:\AutomaticTest\Test_Framework\config\config.yml') y = yaml.load(f) print (y)

{'name': 'Tom Smith', 'age': 37, 'spouse': {'name': 'Jane Smith', 'age': 25}, 'children': [{'name': 'Jimmy Smith', 'age': 15}, {'name1': 'Jenny Smith', 'age1': 12}]}

2、load_all()生成一個迭代器 
如果string或文件包含幾塊yaml文檔，你可以使用yaml.load_all來解析全部的文檔。

import yaml
f = ''' --- name: James age: 20 --- name: Lily age: 19 ''' y = yaml.load_all(f) for data in y: print(data)

{'name': 'James', 'age': 20} {'name': 'Lily', 'age': 19}

3、yaml.dump 將一個python對象生成為yaml文檔

import yaml aproject = {'name': 'Silenthand Olleander', 'race': 'Human', 'traits': ['ONE_HAND', 'ONE_EYE'] } print(yaml.dump(aproject，))

name: Silenthand Olleander race: Human traits: [ONE_HAND, ONE_EYE]

import yaml aproject = {'name': 'Silenthand Olleander', 'race': 'Human', 'traits': ['ONE_HAND', 'ONE_EYE'] } f = open(r'E:\AutomaticTest\Test_Framework\config\config.yml','w') print(yaml.dump(aproject,f))

import yaml obj1 = {"name": "James", "age": 20} obj2 = ["Lily", 19] with open(r'E:\AutomaticTest\Test_Framework\config\config.yml', 'w') as f: yaml.dump_all([obj1, obj2], f)

{age: 20, name: James} --- [Lily, 19]

1、基本規則

 1. 大小寫敏感 2. 使用縮進表示層級關系 3. 縮進時不允許使用Tab，只允許使用空格 4. 縮進的空格數目不重要，只要相同層級的元素左對齊即可 5. # 表示注釋，從它開始到行尾都被忽略

yaml中支持映射或字典的表示，如下：

# 下面格式讀到Python里會是個dict name: 灰藍 age: 0 job: Tester

{'name': '灰藍', 'age': 0, 'job': 'Tester'}

3、yaml轉列表 
yaml中支持列表或數組的表示，如下：

# 下面格式讀到Python里會是個list
- 灰藍 - 0 - Tester

['灰藍', 0, 'Tester']

字典和列表可以復合起來使用，如下：

# 下面格式讀到Python里是個list里包含dict
- name: 灰藍 age: 0 job: Tester - name: James age: 30

[{'name': '灰藍', 'age': 0, 'job': 'Tester'}, {'name': 'James', 'age': 30}]

5、基本類型： 

yaml中有以下基本類型：

字符串
整型
浮點型
布爾型
null 時間 日期

# 這個例子輸出一個字典，其中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

{'str': 'Hello World!', 'int': 110, 'float': 3.141, 'boolean': True, 'None': None, 'time': datetime.datetime(2016, 9, 22, 3, 43, 30, 200000), 'date': datetime.date(2016, 9, 22)}

str: 灰藍 str1: "Hello World" str2: "Hello\nWorld"

{'str': '灰藍', 'str1': 'Hello World', 'str2': 'Hello\nWorld'}

str1: 'Hello\nWorld' str2: "Hello\nWorld"

{'str1': 'Hello\\nWorld', 'str2': 'Hello\nWorld'}

6、引用 
& 和 * 用於引用

name: &name 灰藍 tester: *name

name: 灰藍 tester: 灰藍

{'name': '灰藍', 'tester': '灰藍'}

yaml是可以進行強制轉換的，用 !! 實現，如下：

str: !!str 3.14 int: !!int "123"

{'int': 123, 'str': '3.14'}

8、分段 
在同一個yaml文件中，可以用 — 來分段，這樣可以將多個文檔寫在一個文件中

--- name: James age: 20 --- name: Lily age: 19

1、yaml.YAMLObject 
yaml.YAMLObject用元類來注冊一個構造器（也就是代碼里的 init() 方法），讓你把yaml節點轉為Python對象實例，用表示器（也就是代碼里的 repr() 函數）來讓你把Python對象轉為yaml節點，看代碼：

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 
你可能在使用過程中並不想通過上面這種元類的方式，而是想定義正常的類，那么，可以用這兩種方法

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)

四、示例 
yaml是一種很清晰、簡潔的格式，而且跟Python非常合拍，非常容易操作，我們在搭建自動化測試框架的時候，可以采用yaml作為配置文件，或者用例文件，下面給出一個用例的示例

# 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}

1.python中yaml的模塊的使用

（1）安裝yaml模塊到機器環境中

（2）編寫yaml配置文件test.yaml

 

1.  
   name: Tom Smith
2.  
   age: 37
3.  
   spouse:
4.  
   name: Jane Smith
5.  
   age: 25
6.  
   children:
7.  
   - name: Jimmy Smith
8.  
   age: 15
9.  
   - name1: Jenny Smith
10.  
    age1: 12

（3）編寫解析yaml文件的python程序test.py

 

 

1.  
   import sys
2.  
   sys.path.insert( 0, '/home/wahaha/coding/python')
3.  
    
4.  
   import yaml
5.  
   f = open( 'test.yaml')
6.  
   x = yaml.load(f)
7.  
    
8.  
   print type(x)
9.  
   print x

程序輸出的結果為（yaml.load產出的是dict哦）：

 

 

1.  
   < type 'dict'>
2.  
   { 'age': 37, 'spouse': {'age': 25, 'name': 'Jane Smith'}, 'name': 'Tom Smith', 'children': [{'age': 15, 'name': 'Jimmy Smith'}, {'age1': 12, 'name1': 'Jenny Smith'}]}

 

2.yaml文檔編寫格式

http://www.mutouxiaogui.cn/blog/?p=357