Python組態檔yaml的用法詳解

2022-03-30 19:03:20

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

到此這篇關於Python組態檔yaml的用法詳解的文章就介紹到這了,更多相關Python yaml用法內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！