Python配置文件yaml的用法詳解

更新時(shí)間：2022年03月30日 16:14:44 作者：py3study

YAML是一種直觀的能夠被電腦識(shí)別的的數(shù)據(jù)序列化格式，容易被人類(lèi)閱讀，并且容易和腳本語(yǔ)言交互。本文將詳細(xì)介紹一下Python中yaml文件的用法，需要的可以參考一下

YAML是一種直觀的能夠被電腦識(shí)別的的數(shù)據(jù)序列化格式，容易被人類(lèi)閱讀，并且容易和腳本語(yǔ)言交互。YAML類(lèi)似于XML，但是語(yǔ)法比XML簡(jiǎn)單得多，對(duì)于轉(zhuǎn)化成數(shù)組或可以hash的數(shù)據(jù)時(shí)是很簡(jiǎn)單有效的。

一、PyYaml

1、load() :返回一個(gè)對(duì)象

我們先創(chuàng)建一個(gè)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)

結(jié)果：

{'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()生成一個(gè)迭代器

如果string或文件包含幾塊yaml文檔，你可以使用yaml.load_all來(lái)解析全部的文檔。

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

執(zhí)行結(jié)果：

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

3、yaml.dump 將一個(gè)python對(duì)象生成為yaml文檔

import yaml
aproject = {'name': 'Silenthand Olleander',
            'race': 'Human',
            'traits': ['ONE_HAND', 'ONE_EYE']
            }

print(yaml.dump(aproject，))

執(zhí)行結(jié)果：

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

yaml.dump接收的第二個(gè)參數(shù)一定要是一個(gè)打開(kāi)的文本文件或二進(jìn)制文件，yaml.dump會(huì)把生成的yaml文檔寫(xiě)到文件里

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

4、yaml.dump_all()將多個(gè)段輸出到一個(gè)文件中

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]

二、yaml語(yǔ)法

1、基本規(guī)則

1. 大小寫(xiě)敏感

2. 使用縮進(jìn)表示層級(jí)關(guān)系

3. 縮進(jìn)時(shí)不允許使用Tab，只允許使用空格

4. 縮進(jìn)的空格數(shù)目不重要，只要相同層級(jí)的元素左對(duì)齊即可

5. # 表示注釋?zhuān)瑥乃_(kāi)始到行尾都被忽略

2、yaml轉(zhuǎn)字典

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

# 下面格式讀到Python里會(huì)是個(gè)dict
name: 灰藍(lán)
age: 0
job: Tester

輸出：

{'name': '灰藍(lán)', 'age': 0, 'job': 'Tester'}

3、yaml轉(zhuǎn)列表

yaml中支持列表或數(shù)組的表示，如下：

# 下面格式讀到Python里會(huì)是個(gè)list
- 灰藍(lán)
- 0
- Tester

輸出：

['灰藍(lán)', 0, 'Tester']

4、復(fù)合結(jié)構(gòu)

字典和列表可以復(fù)合起來(lái)使用，如下：

# 下面格式讀到Python里是個(gè)list里包含dict
- name: 灰藍(lán)
  age: 0
  job: Tester
- name: James
  age: 30

輸出：

[{'name': '灰藍(lán)', 'age': 0, 'job': 'Tester'}, {'name': 'James', 'age': 30}]

5、基本類(lèi)型

yaml中有以下基本類(lèi)型：

字符串
整型
浮點(diǎn)型
布爾型
null
時(shí)間
日期

我們寫(xiě)個(gè)例子來(lái)看下：

# 這個(gè)例子輸出一個(gè)字典，其中value包括所有基本類(lèi)型
str: "Hello World!"
int: 110
float: 3.141
boolean: true  # or false
None: null  # 也可以用 ~ 號(hào)來(lái)表示 null
time: 2016-09-22t11:43:30.20+08:00  # ISO8601，寫(xiě)法百度
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)}

如果字符串沒(méi)有空格或特殊字符，不需要加引號(hào)，但如果其中有空格或特殊字符，則需要加引號(hào)了

str: 灰藍(lán)
str1: "Hello World"
str2: "Hello\nWorld"

輸出：

{'str': '灰藍(lán)', 'str1': 'Hello World', 'str2': 'Hello\nWorld'}

這里要注意單引號(hào)和雙引號(hào)的區(qū)別，單引號(hào)中的特殊字符轉(zhuǎn)到Python會(huì)被轉(zhuǎn)義，也就是到最后是原樣輸出了，雙引號(hào)不會(huì)被Python轉(zhuǎn)義，到最后是輸出了特殊字符；如：

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

輸出：

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

可以看到，單引號(hào)中的’\n’最后是輸出了，雙引號(hào)中的’\n’最后是轉(zhuǎn)義成了回車(chē)

6、引用

& 和 * 用于引用

name: &name 灰藍(lán)
tester: *name

這個(gè)相當(dāng)于一下腳本：

name: 灰藍(lán)
tester: 灰藍(lán)

輸出：

{'name': '灰藍(lán)', 'tester': '灰藍(lán)'}

7、強(qiáng)制轉(zhuǎn)換

yaml是可以進(jìn)行強(qiáng)制轉(zhuǎn)換的，用 !! 實(shí)現(xiàn)，如下：

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

輸出：

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

明顯能夠看出123被強(qiáng)轉(zhuǎn)成了int類(lèi)型，而float型的3.14則被強(qiáng)轉(zhuǎn)成了str型。

8、分段

在同一個(gè)yaml文件中，可以用 — 來(lái)分段，這樣可以將多個(gè)文檔寫(xiě)在一個(gè)文件中

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

三、構(gòu)造器(constructors)、表示器(representers)、解析器(resolvers )

1、yaml.YAMLObject

yaml.YAMLObject用元類(lèi)來(lái)注冊(cè)一個(gè)構(gòu)造器（也就是代碼里的 init() 方法），讓你把yaml節(jié)點(diǎn)轉(zhuǎn)為Python對(duì)象實(shí)例，用表示器（也就是代碼里的 repr() 函數(shù)）來(lái)讓你把Python對(duì)象轉(zhuǎn)為yaml節(jié)點(diǎn)，看代碼：

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對(duì)象實(shí)例轉(zhuǎn)為yaml

lily = yaml.load('!person {name: Lily, age: 19}')

print (lily)  # yaml轉(zhuǎn)為Python對(duì)象實(shí)例

輸出：

!person {age: 20, name: James}

Person(name=Lily, age=19)

2、yaml.add_constructor 和 yaml.add_representer

你可能在使用過(guò)程中并不想通過(guò)上面這種元類(lèi)的方式，而是想定義正常的類(lèi)，那么，可以用這兩種方法

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))  # 沒(méi)加表示器之前


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方法為對(duì)象添加表示器
print (yaml.dump(james))  # 加了表示器之后


def person_cons(loader, node):
    value = loader.construct_mapping(node)  # mapping構(gòu)造器，用于dict
    name = value['name']
    age = value['age']
    return Person(name, age)

yaml.add_constructor(u'!person', person_cons)  # 用add_constructor方法為指定yaml標(biāo)簽添加構(gòu)造器
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)

第一行是沒(méi)加表示器之前，多丑！中間那行是加了表示器之后，變成了規(guī)范的格式，下面添加了構(gòu)造器，能夠把 !person 標(biāo)簽轉(zhuǎn)化為Person對(duì)象。

四、示例

yaml是一種很清晰、簡(jiǎn)潔的格式，而且跟Python非常合拍，非常容易操作，我們?cè)诖罱ㄗ詣?dòng)化測(cè)試框架的時(shí)候，可以采用yaml作為配置文件，或者用例文件，下面給出一個(gè)用例的示例

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

到此這篇關(guān)于Python配置文件yaml的用法詳解的文章就介紹到這了,更多相關(guān)Python yaml用法內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: