python yaml用法詳解
- 2020 年 1 月 10 日
- 筆記
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
讀取yml文件：
import yaml f = open(r'E:AutomaticTestTest_Frameworkconfigconfig.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]
yaml.dump接收的第二個參數一定要是一個打開的文本文件或二進位文件，yaml.dump會把生成的yaml文檔寫到文件里
import yaml aproject = {'name': 'Silenthand Olleander', 'race': 'Human', 'traits': ['ONE_HAND', 'ONE_EYE'] } f = open(r'E:AutomaticTestTest_Frameworkconfigconfig.yml','w') print(yaml.dump(aproject,f))
4、yaml.dump_all()將多個段輸出到一個文件中
import yaml obj1 = {"name": "James", "age": 20} obj2 = ["Lily", 19] with open(r'E:AutomaticTestTest_Frameworkconfigconfig.yml', 'w') as f: yaml.dump_all([obj1, obj2], f)
輸出到文件：
{age: 20, name: James} --- [Lily, 19]
二、yaml語法 1、基本規則
1. 大小寫敏感 2. 使用縮進表示層級關係 3. 縮進時不允許使用Tab，只允許使用空格 4. 縮進的空格數目不重要，只要相同層級的元素左對齊即可 5. # 表示注釋，從它開始到行尾都被忽略
2、yaml轉字典 yaml中支援映射或字典的表示，如下：
# 下面格式讀到Python里會是個dict name: 灰藍 age: 0 job: Tester
輸出：
{'name': '灰藍', 'age': 0, 'job': 'Tester'}
3、yaml轉列表 yaml中支援列表或數組的表示，如下：
# 下面格式讀到Python里會是個list - 灰藍 - 0 - Tester
輸出：
['灰藍', 0, 'Tester']
4、複合結構： 字典和列表可以複合起來使用，如下：
# 下面格式讀到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: "HellonWorld"
輸出：
{'str': '灰藍', 'str1': 'Hello World', 'str2': 'HellonWorld'}
這裡要注意單引號和雙引號的區別，單引號中的特殊字元轉到Python會被轉義，也就是到最後是原樣輸出了，雙引號不會被Python轉義，到最後是輸出了特殊字元；如：
str1: 'HellonWorld' str2: "HellonWorld"
輸出：
{'str1': 'Hello\nWorld', 'str2': 'HellonWorld'}
可以看到，單引號中的』n』最後是輸出了，雙引號中的』n』最後是轉義成了回車 6、引用 & 和 * 用於引用
name: &name 灰藍 tester: *name
這個相當於一下腳本：
name: 灰藍 tester: 灰藍
輸出：
{'name': '灰藍', 'tester': '灰藍'}
7、強制轉換 yaml是可以進行強制轉換的，用 !! 實現，如下：
str: !!str 3.14 int: !!int "123"
輸出：
{'int': 123, 'str': '3.14'}
明顯能夠看出123被強轉成了int類型，而float型的3.14則被強轉成了str型。 8、分段 在同一個yaml文件中，可以用 — 來分段，這樣可以將多個文檔寫在一個文件中
--- name: James age: 20 --- name: Lily age: 19
三、構造器(constructors)、表示器(representers)、解析器(resolvers ) 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)
第一行是沒加表示器之前，多醜！中間那行是加了表示器之後，變成了規範的格式，下面添加了構造器，能夠把 !person 標籤轉化為Person對象。 四、示例 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}
