python yaml用法詳解

YAML是一種直觀的可以被電腦識別的的數據序列化格式，容易被人類閱讀，而且容易和腳本語言交互。YAML相似於XML，可是語法比XML簡單得多，對於轉化成數組或能夠hash的數據時是很簡單有效的。 
1、PyYaml 
一、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

• 讀取yml文件：

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

二、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}

三、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]

• yaml.dump接收的第二個參數必定要是一個打開的文本文件或二進制文件，yaml.dump會把生成的yaml文檔寫到文件裏

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))

• 四、yaml.dump_all()將多個段輸出到一個文件中

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]

• 2、yaml語法 

一、基本規則

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

• 二、yaml轉字典 

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

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

• 輸出：

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

三、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}]

五、基本類型： 

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

• 這裏要注意單引號和雙引號的區別，單引號中的特殊字符轉到Python會被轉義，也就是到最後是原樣輸出了，雙引號不會被Python轉義，到最後是輸出了特殊字符；如：

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

• 輸出：

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

• 能夠看到，單引號中的’\n’最後是輸出了，雙引號中的’\n’最後是轉義成了回車 

六、引用 
& 和 * 用於引用

name: &name 灰藍 tester: *name

• 這個至關於一下腳本：

name: 灰藍 tester: 灰藍

• 輸出：

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

• 七、強制轉換 

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

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

• 輸出：

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

• 1明顯可以看出123被強轉成了int類型，而float型的3.14則被強轉成了str型。 

八、分段 
在同一個yaml文件中，能夠用 — 來分段，這樣能夠將多個文檔寫在一個文件中

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

• 3、構造器(constructors)、表示器(representers)、解析器(resolvers ) 

一、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)

二、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)

• 第一行是沒加表示器以前，多醜！中間那行是加了表示器以後，變成了規範的格式，下面添加了構造器，可以把 !person 標籤轉化爲Person對象。 

4、示例 
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