寫了好多關於selenium的文章，今天換個口味，推薦一個檔案格式 – yaml，以及對應的Python庫 – PyYaml。可以用之作為你自動化測試框架的配置檔案或者用例檔案。

yaml是一種比xml和json更輕的檔案格式，也更簡單更強大，它可以通過縮排來表示結構，聽著就和Python很配對不對？

yaml的介紹不在這裡贅述，感興趣可以自行百度下，先說下它的基本語法，還是配合著PyYaml來：

1. PyYaml

PyYaml是Python的一個專門針對yaml檔案操作的模組，使用起來非常簡單。

1. 安裝：

pip install PyYaml

或者到這裡下載相應版本的包，人工安裝。

1. 使用：

使用起來非常簡單，就像json、pickle一樣，load、dump就足夠我們使用了。

• load()

import yaml

yaml_str = """
name: 灰藍
age: 0
job: Tester
"""

y = yaml.load(yaml_str)
print y

結果：

{'job': 'Tester', 'age': 0, 'name': u'\u7070\u84dd'}

• dump()

import yaml

python_obj = {"name": u"灰藍",
              "age": 0,
              "job"
 
: "Tester"
              }

y = yaml.dump(python_obj, default_flow_style=False)
print y

結果：

age: 0
job: Tester
name: "\u7070\u84DD"

上面只是簡單的兩個應用，還有 load_all()、dump_all() 等，我們一般用這四個足夠了，另外兩個下面會講到，其他方法可以自己看API，我也沒怎麼折騰過。

2. yaml語法

有了上面的基礎，接下來我們看看yaml的語法，首先我們準備下測試語法的環境：

• 建立 test.yaml 檔案，我們練習語法就在這裡

• 建立 testyaml.py

  檔案，用來檢視Python執行後的效果，其中內容如下：

# -*- coding: utf-8 -*-
import yaml

y = yaml.load(file('test.yaml', 'r'))
print y

好了，接下來我們就來看語法吧：

1. 基本規則

• 大小寫敏感
• 使用縮排表示層級關係
• 縮排時不允許使用Tab，只允許使用空格
• 縮排的空格數目不重要，只要相同層級的元素左對齊即可
• # 表示註釋，從它開始到行尾都被忽略

2. yaml轉字典

yaml中支援對映或字典的表示，如下：

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

輸出：

{'job': 'Tester', 'age': 0, 'name': u'\u7070\u84dd'}

3. yaml轉列表

yaml中支援列表或陣列的表示，如下：

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

輸出：

[u'\u7070\u84dd', 0, 'Tester']

4. 複合結構

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

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

輸出：

[{'job': 'Tester', 'age': 0, 'name': u'\u7070\u84dd'}, {'age': 30, 'name': 'James'}]

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

輸出：

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

如果字串沒有空格或特殊字元，不需要加引號，但如果其中有空格或特殊字元，則需要加引號了

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

輸出：

{'str2': 'Hello\nWorld', 'str1': 'Hello World', 'str': u'\u7070\u84dd'}

這裡要注意單引號和雙引號的區別，單引號中的特殊字元轉到Python會被轉義，也就是到最後是原樣輸出了，雙引號不會被Python轉義，到最後是輸出了特殊字元；可能比較拗口，來個例子理解下：

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

# -*- coding: utf-8 -*-
import yaml

y = yaml.load(file('test.yaml', 'r'))
print y['str1']
print y['str2']

輸出：

Hello\nWorld
Hello
World

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

字串處理中寫成多行、’|’、’>’、’+’、’-‘的意義這裡就不講了。

6. 引用

& 和 * 用於引用

name: &name 灰藍
tester: *name

這個相當於一下指令碼：

name: 灰藍
tester: 灰藍

輸出：

{'name': u'\u7070\u84dd', 'tester': u'\u7070\u84dd'}

7. 強制轉換

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

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

輸出：

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

明顯能夠看出123被強轉成了int型別，而float型的3.14則被強轉成了str型。另外PyYaml還支援轉換成Python/object型別，這個我們下面再討論。

8. 分段

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

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

這時候我們就得用到我們的 load_all() 方法出場了，load_all() 方法會生成一個迭代器，可以用for輸出出來：

# -*- coding: utf-8 -*-
import yaml

ys = yaml.load_all(file('test.yaml', 'r'))
for y in ys:
    print y

輸出：

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

對應的也有 dump_all() 方法，一個意思，就是將多個段輸出到一個檔案中，舉個栗子：

# -*- coding: utf-8 -*-
import yaml

obj1 = {"name": "James", "age": 20}
obj2 = ["Lily", 19]

with open('test.yaml', 'w') as f:
    yaml.dump_all([obj1, obj2], f)

開啟test.yaml看看：

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

dump() 和 dump_all() 方法可以傳入列表，也可以傳入一個可序列化生成器，如 range(10)， 如下：

# -*- coding: utf-8 -*-
import yaml

y = yaml.dump(range(10))
print y

輸出：

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

在 dump 和 dump_all() 的時候還可以配一堆引數，不一一講解了（其實博主也不全瞭解。。）

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

這幾個東西可以把Python的物件和yaml互轉，很強大。這個翻譯是博主自個兒翻譯的，表達的不準確勿怪。

1. yaml.YAMLObject

yaml.YAMLObject用元類來註冊一個構造器（也就是程式碼裡的 __init__() 方法），讓你把yaml節點轉為Python物件例項，用表示器（也就是程式碼裡的 __repr__() 函式）來讓你把Python物件轉為yaml節點，看程式碼：

# -*- coding: utf-8 -*-
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

你可能在使用過程中並不想通過上面這種元類的方式，而是想定義正常的類，那麼，可以用這兩種方法

# -*- coding: utf-8 -*-
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物件。

這裡用了 construct_mapping ，還有其他好多 construct_document， construct_object，construct_scalar，construct_sequence，construct_pairs，具體怎麼用，可以自己研究下，看看API，看看原始碼學習下。

對應的 representer 也一樣，有很多，這裡只用了 represent_mapping，其他的不示例講解了。

3. add_implicit_resolver

如果你不想每次都寫標籤，也可以用 add_implicit_resolver 方法新增解析器，然後它就能夠把指定樣式的沒有標籤的基本元素解析成對應的Python物件。這個就不詳細分析給示例了。感興趣的同學自己看文件學習吧。

4. 結語

yaml是一種很清晰、簡潔的格式，而且跟Python非常合拍，非常容易操作，我們在搭建自動化測試框架的時候，可以採用yaml作為配置檔案，或者用例檔案，下面給出一個用例的示例，這個示例來自於Python restful介面框架 pyresttest:

# 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 selenium的文章，請關注我的CSDN專欄：