python子產品-PyYAML

　　YAML是專門用來寫配置檔案的語言，遠比JSON格式友善。

　　YAML語言的設計目标，就是友善人類讀寫。

　　YAML是一種比XML和JSON更輕的檔案格式，也更簡單更強大，它可以通過縮進來表示結構，是不是聽起來就和Python很搭？

　　顧名思義，用語言編寫的檔案就可以稱之為YAML檔案。PyYaml是Python的一個專門針對YAML檔案操作的子產品，使用起來非常簡單。

1.yaml檔案格式簡介

　　基本規則：

  • 大小寫敏感
  • 使用縮進表示層級關系
  • 縮進時不允許使用Tab鍵，隻允許使用空格。
  • 縮進的空格數目不重要，隻要相同層級的元素左側對齊即可
  • 使用#表示注釋
  • 字元串可以不用引号标注

　　yaml 支援的資料結構有三種：

  • 對象：鍵值對的集合，又稱為映射（mapping）/ 哈希（hashes） / 字典（dictionary）
  • 數組：一組按次序排列的值，又稱為序列（sequence） / 清單（list）
  • 純量（scalars）：單個的、不可再分的值。字元串、布爾值、整數、浮點數、Null、時間、日期

1.1 對象 

user: admin
pwd: 123
job:
  - teacher
  - nurese

#輸出
{'user': 'admin',
 'pwd': 123,
 'job': ['teacher', 'nurese']}

1.2 數組序列 

- admin1: 123456
- admin2: 111111
- admin3: 222222

#輸出：
[{'admin1': 123456},
{'admin2': 111111}, 
{'admin3': 222222}]

1.3 純量 

n1: 52.10
---------------------------------------------------------------
n2: true 
n3: false    #不區分大小寫
---------------------------------------------------------------
#None用~表示
n4: ~


輸出：{'n1': 52.1}
---------------------------------------------------------------
輸出：{'n2': True, 'n3': False}
---------------------------------------------------------------
輸出：{'n4': None}

1.4 混合使用

1.list嵌套dict 

- user: admin1
  psw: '123456'
- user: admin2
  psw: '111111'
- user: admin3
  psw: '222222'

　　用python讀取出來的結果：

[{'user': 'admin1', 'psw': '123456'},
{'user': 'admin2', 'psw': '111111'},
{'user': 'admin3', 'psw': '222222'}]

2.dict嵌套list 

nub1:
    - admin1
    - '123456'
nb2:
    - admin2
    - '111111'
nb3:
    - admin3
    - '222222'

　　用python讀取出來的結果：

{'nub1': ['admin1', '123456'],

'nb2': ['admin2', '111111'],

2.Yaml文法詳解

2.1 基本規則

  • 大小寫敏感
  • 使用縮進表示層級關系
  • 縮進時不允許使用Tab鍵，隻允許使用空格。
  • 縮進的空格數目不重要，隻要相同層級的元素左側對齊即可
  • 使用#表示注釋
  • 字元串可以不用引号标注

2.2 yaml轉字典

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

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

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

2.3 yaml轉清單

　　yaml中支援清單或數組的表示，如下：

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

輸出：
['灰藍', 0, 'Tester']

2.4 複合結構

　　字典和清單可以複合起來使用，如下：

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

輸出：
[{'name': '灰藍', 'age': 0, 'job': 'Tester'}, {'name': 'James', 'age': 30}]

2.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: "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’最後是轉義成了回車

2.6 引用

　　& 和 * 用于引用

name: &name 灰藍
tester: *name

　　這個相當于一下腳本：

name: 灰藍
tester: 灰藍

　　輸出：

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

2.7 強制轉換

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

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

　　輸出：

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

　　明顯能夠看出123被強轉成了int類型，而float型的3.14則被強轉成了str型。

2.8 分段

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

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

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

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

3.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對象。

4.PyYaml使用執行個體

4.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'./config.yaml')
#y = yaml.load(f)  #yaml5.1後廢棄這種方法
#由于Yaml 5.1版本後棄用了 yaml.load(file) 這個用法。Yaml 5.1版本之後就修改了需要指定Loader，通過預設加載器（FullLoader）禁止執行任意函數，使得此load函數的安全得到加強。
#下面三種方法都可以
# y=yaml.load(f,Loader=yaml.FullLoader)
# y=yaml.safe_load(f)
y=yaml.load(f, Loader=yaml.CLoader)
print (y)

#結果輸出
{'name': 'Tom Smith', 'age': 37, 'spouse': {'name': 'Jane Smith', 'age': 25}, 'children': [{'name': 'Jimmy Smith', 'age': 15}, {'name1': 'Jenny Smith', 'age1': 12}]}

4.2 load_all()生成一個疊代器

　　如果string或檔案包含幾塊yaml文檔，你可以使用yaml.load_all來解析全部的文檔。

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


#結果輸出
{'name': 'James', 'age': 20}
{'name': 'Lily', 'age': 19}

4.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'./config2.yaml','w')
print(yaml.dump(aproject,f))

　　檔案輸出

　　

python子產品-PyYAML

4.4 yaml.dump_all()将多個段輸出到一個檔案中 

import yaml

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

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

　　結果檔案輸出:

　　

python子產品-PyYAML

5.總結

　　看完這篇文章，可以看到，整個操作都是比較簡單的，但是是不是發現沒有增加，删除等操作呀？這個确實好像修改資料，好像隻有把資料全部取出來,然後修改,然後在存回去

官方連結:http://pyyaml.org/wiki/PyYAMLDocumentation 

Python 縮進 構造器
上一篇: Python子產品-shutil子產品詳解
下一篇: Codeforces Round #369 (Div. 2) 711C Coloring Tree (DP)

繼續閱讀