深入理解Python3yaml

一、yaml介紹

YAML全稱為”YAML Ain’t Markup Language”, 是一種可讀性高、用於表達數據序列化的格式，常用於配置文件、數據交換格式等場景。YAML文件的擴展名為.yml或.yaml，支持多種語言的解析，包括Python。相較於XML和JSON格式的文件，YAML文件更簡潔、易讀、易寫。Python中的yaml模塊，可以輕鬆地將Python中的數據結構轉化為YAML格式。

二、python3yaml基本使用

Python中的yaml模塊提供了基本的dump、dumps、load、loads函數來實現YAML與Python對象的相互轉換。

1. Python對象轉YAML

import yaml

# Python對象
data = {
    'name': 'Jack',
    'age': 30,
    'hobbies': ['reading', 'sports'],
    'contacts': {
         'email': 'jack@example.com',
         'phone': 123456789
    }
}

# 將Python對象轉換為YAML格式
yaml_data = yaml.dump(data)
print(yaml_data)

運行以上代碼，將會輸出以下結果：

age: 30
contacts:
  email: jack@example.com
  phone: 123456789
hobbies:
- reading
- sports
name: Jack

可以發現，Python數據結構被轉化成了YAML格式，對於Python中複雜的嵌套數據結構也同樣可被轉換為相應的YAML格式。

2. YAML轉Python對象

import yaml

# YAML格式的數據
yaml_data = '''
name: Jack
age: 30
hobbies:
- reading
- sports
contacts:
  email: jack@example.com
  phone: 123456789
'''

# 將YAML格式數據轉換為Python對象
data = yaml.load(yaml_data, Loader=yaml.FullLoader)
print(data)

運行以上代碼，將會輸出以下結果：

{'name': 'Jack', 'age': 30, 'hobbies': ['reading', 'sports'], 'contacts': {'email': 'jack@example.com', 'phone': 123456789}}

通過load函數，將YAML格式的數據轉換為Python對象，轉化後結果為Python中的一個字典對象。

三、yaml屬性設置

除了基本的dump、dumps、load、loads函數，yaml模塊還提供了許多屬性設置，來控制YAML的轉換過程。

1. 指定樣式

可以通過默認設置和配置樣式來指定轉化後的YAML樣式。比如對於默認情況下Python列表類型被轉換為YAML列表（使用「-」符號），也可以指定其轉換成塊或流樣式，即用中括號或無中括號的方式。

import yaml

# Python對象
data = {
    'name': 'Jack',
    'age': 30,
    'hobbies': ['reading', 'sports', 'travel'],
    'contacts': {
         'email': 'jack@example.com',
         'phone': 123456789
    }
}

# flow樣式
yaml_data1 = yaml.dump(data, default_flow_style=True)
print(yaml_data1)

# block樣式
yaml_data2 = yaml.dump(data, default_flow_style=False)
print(yaml_data2)

運行以上代碼，將會輸出以下結果：

{age: 30, contacts: {email: jack@example.com, phone: 123456789}, hobbies: [reading, sports, travel], name: Jack}
age: 30
contacts:
  email: jack@example.com
  phone: 123456789
hobbies:
- reading
- sports
- travel
name: Jack

如果指定了flow樣式，則每個元素在同一行上展示；如果指定了block樣式，則每個元素單獨佔一行。

2. 控制縮進

如果希望輸出具有更好可讀性的YAML，可以通過設置縮進屬性進行設置。

import yaml

# Python對象
data = {
    'name': 'Jack',
    'age': 30,
    'hobbies': ['reading', 'sports'],
    'contacts': {
         'email': 'jack@example.com',
         'phone': 123456789
    }
}

# 縮進為4
yaml_data1 = yaml.dump(data, default_flow_style=False, indent=4)
print(yaml_data1)

# 縮進為2
yaml_data2 = yaml.dump(data, default_flow_style=False, indent=2)
print(yaml_data2)

運行以上代碼，將會輸出以下結果：

age: 30
contacts:
    email: jack@example.com
    phone: 123456789
hobbies:
  - reading
  - sports
name: Jack
age: 30
contacts:
  email: jack@example.com
  phone: 123456789
hobbies:
  - reading
  - sports
name: Jack

可以發現，通過設置indent屬性可以控制YAML文件的縮進。值得注意的是，縮進屬性的值是一個整數，而不是將YAML文件中的空格數量作為值。

3. 設置標籤

可以為Python對象指定標籤，這些標籤可以作為對象構造函數的參數傳遞。

import yaml

# 自定義數據類型
class MyData:
    def __init__(self, val):
        self.value = val

    def __repr__(self):
        return 'MyData(%d)' % self.value

# Python對象
data = {
    'name': 'Jack',
    'age': 30,
    'value': MyData(100)
}

# 定義標籤
yaml.add_representer(MyData, lambda dumper, data: dumper.represent_scalar('!MyData', str(data.value)))

# 將Python對象轉換為YAML格式
yaml_data = yaml.dump(data)
print(yaml_data)

# 將YAML格式數據轉換為Python對象
loaded_data = yaml.load(yaml_data, Loader=yaml.FullLoader)
print(loaded_data)

運行以上代碼，將會輸出以下結果：

age: 30
name: Jack
value: !MyData 100

{'name': 'Jack', 'age': 30, 'value': MyData(100)}

在以上示例中，我們使用add_representer函數定義了一個自定義類型的標籤，並將其作為輸出的結果。

四、yaml高級應用

以上我們已經介紹了基本的python3yaml使用方法和一些常見的屬性設置。接下來，我們來了解一些yaml更高級的應用場景，包括yaml文件的拆分、引用類型、注釋等。

1. yaml文件的拆分

在大型項目中，yaml文件通常會非常龐大，如果整個文件都寫在一個文件中，可讀性會變差。解決這個問題的一種方法是將文件拆分成多個小的yaml文件。

在將yaml文件拆分成多個小文件時，可能會存在重複的定義或屬性。為了解決這個問題，可以使用anchor（錨點）和alias（別名）屬性。

使用錨點，可以將同一個屬性定義為多個錨點並進行重用。使用別名，可以將重複使用的錨點取一個別名，並在其他地方引用它。yaml模塊實現了錨點和別名相關的函數，可以通過這些函數來實現yaml文件的拆分和重用。

2. 引用類型

引用類型是指「&name」和「*name」形式的語法，用於實現yaml文件中的跨位置引用。當一個錨點被定義時，可以通過在其他位置使用「*name」來引用它。

import yaml

# Python對象
data = {
    'name': 'Jack',
    'age': 30,
    'emails': ['jack@example.com', 'jack@company.com'],
    'contacts': {
         'email': 'jack@example.com',
         'phone': 123456789
    }
}

# 定義錨點
yaml_str = '''
name: &name Jack
age: 30
emails: &emails
  - jack@example.com
  - jack@company.com
contacts:
  email: *emails
  phone: 123456789
'''

# 將YAML格式數據轉換為Python對象
loaded_data = yaml.load(yaml_str, Loader=yaml.FullLoader)
print(loaded_data)

以上程序段演示的是在yaml文件中引用錨點和別名的過程及轉換結果。

3. 注釋

注釋是指在yaml文件中對數據或配置項的解釋或說明，以幫助其他人更好地了解文件的內容。在yaml文件中，注釋以#字符開始。

import yaml

# 自定義數據類型
class MyData:
    def __init__(self, val):
        self.value = val

    def __repr__(self):
        return 'MyData(%d)' % self.value

# Python對象
data = {
    # 用戶名
    'name': 'Jack',
    # 年齡
    'age': 30,
    # 愛好
    'hobbies': ['reading', 'sports', 'travel'],
    # 聯繫方式
    'contacts': {
         # 郵箱
         'email': 'jack@example.com',
         # 電話
         'phone': 123456789
    },
    # 自定義類型
    'value': MyData(100)
}

# 定義標籤
yaml.add_representer(MyData, lambda dumper, data: dumper.represent_scalar('!MyData', str(data.value)))

# 將Python對象轉換為YAML格式
yaml_data = yaml.dump(data)
print(yaml_data)

以上程序段演示了如何在yaml文件中使用注釋對數據或配置項的解釋或說明。

五、總結

本文詳細介紹了Python3yaml的基本使用方法及一些高級應用場景，包括yaml文件的拆分、引用類型、注釋等。通過學習本文內容，讀者可以更好地了解yaml格式的概念、使用方法和一些注意事項，從而更好地應用yaml在實際項目中。

原創文章，作者：GLYWR，如若轉載，請註明出處：https://www.506064.com/zh-hk/n/368907.html

深入理解Python3yaml

一、yaml介紹

二、python3yaml基本使用

1. Python對象轉YAML

2. YAML轉Python對象

三、yaml屬性設置

1. 指定樣式

2. 控制縮進

3. 設置標籤

四、yaml高級應用

1. yaml文件的拆分

2. 引用類型

3. 注釋

五、總結

相關推薦

發表回復