Python YAML文件處理的完整指南
更新時(shí)間：2025年07月17日 11:04:14 作者：Yant224
yaml是一種比xml和json更輕的文件格式,也更簡單更強(qiáng)大,它可以通過縮進(jìn)來表示結(jié)構(gòu),聽著就和Python很配對不對?本文給大家詳細(xì)介紹了Python YAML文件處理的完整指南,需要的朋友可以參考下
一、YAML基礎(chǔ)與Python環(huán)境搭建
1. YAML簡介
YAML（YAML Ain’t Markup Language）是一種人類可讀的數(shù)據(jù)序列化格式，特點(diǎn)：
- 使用縮進(jìn)表示層級關(guān)系
- 支持復(fù)雜數(shù)據(jù)結(jié)構(gòu)
- 包含注釋功能
- 跨語言兼容
2. 核心特性對比
| 特性 | YAML | JSON | XML |
|---|---|---|---|
| 可讀性 | ★★★★★ | ★★☆☆☆ | ★★★☆☆ |
| 注釋支持 | ? | ? | ? |
| 數(shù)據(jù)類型 | 豐富 | 基本 | 基本 |
| 語法復(fù)雜度 | 簡單 | 簡單 | 復(fù)雜 |
3. 安裝Python YAML庫
# 安裝PyYAML（基礎(chǔ)庫） pip install pyyaml # 安裝ruamel.yaml（高級庫，推薦） pip install ruamel.yaml
4. YAML基本結(jié)構(gòu)
# 基本數(shù)據(jù)類型 string: "Hello YAML" integer: 25 float: 3.14 boolean: true null_value: null # 復(fù)合數(shù)據(jù)類型 list: - item1 - item2 - item3 dictionary: key1: value1 key2: value2 # 多行文本 multiline_text: | 這是第一行 這是第二行 第三行自動(dòng)換行 # 注釋示例 settings: theme: dark # 界面主題 autosave: true # 自動(dòng)保存功能
二、PyYAML 核心函數(shù)詳解
1. 讀取操作
yaml.safe_load(stream)
功能：安全加載 YAML 內(nèi)容（限制可解析類型）
??參數(shù)??：
stream：文件對象或字符串
??返回??：解析后的 Python 對象
??安全等級??：★★★★★（防止惡意代碼執(zhí)行）
案例：
import yaml
# 安全讀取YAML文件
with open('config.yaml', 'r') as f:
loaded_data = yaml.safe_load(f)
print(loaded_data['database']['host']) # 輸出: localhost
yaml.load(stream, Loader=Loader)
功能：加載 YAML 內(nèi)容（支持完整功能）
??參數(shù)??：
stream：文件對象或字符串Loader：指定加載器（默認(rèn)為全功能加載器）
??警告??：可能執(zhí)行惡意代碼，不推薦用于不可信數(shù)據(jù)
案例：
# 讀取包含自定義類型的YAML
class User:
def __init__(self, name, role):
self.name = name
self.role = role
# 注冊自定義構(gòu)造函數(shù)
def user_constructor(loader, node):
values = loader.construct_mapping(node)
return User(values['name'], values['role'])
yaml.add_constructor('!User', user_constructor)
with open('users.yaml') as f:
users = yaml.load(f) # 處理自定義!User標(biāo)簽
2. 寫入操作
yaml.dump(data, stream=None, **kwargs)
功能：將 Python 對象序列化為 YAML 格式
??參數(shù)??：
data：要序列化的 Python 對象stream：輸出文件對象（可選）
??返回??：若 stream 為 None 則返回字符串，否則寫入文件
??關(guān)鍵參數(shù)??：default_flow_style=False：禁用內(nèi)聯(lián)格式indent=4：設(shè)置縮進(jìn)大小allow_unicode=True：支持 Unicode 字符sort_keys=False：保持鍵的原始順序
案例：
import yaml
# 準(zhǔn)備配置數(shù)據(jù)
data = {
'database': {
'host': 'localhost',
'port': 5432,
'credentials': {
'user': 'admin',
'password': 'secret'
}
},
'features': ['logging', 'caching', 'api']
}
# 寫入YAML文件
with open('config.yaml', 'w') as f:
yaml.dump(data, f,
default_flow_style=False, # 禁用內(nèi)聯(lián)格式
indent=2, # 縮進(jìn)2個(gè)空格
allow_unicode=True, # 支持Unicode
sort_keys=False) # 保持鍵順序
yaml.safe_dump(data, stream=None, **kwargs)
功能：安全序列化 Python 對象
??參數(shù)??：同 yaml.dump()
??特點(diǎn)??：僅序列化安全的數(shù)據(jù)類型
案例：
# 安全寫入配置
with open('safe_config.yaml', 'w') as f:
yaml.safe_dump(data, f)
3. 多文檔處理
yaml.load_all(stream)
功能：加載包含多個(gè) YAML 文檔的流
??參數(shù)??：
stream：文件對象或字符串
??返回??：生成器，每次產(chǎn)生一個(gè)文檔對象
案例：
# 讀取多文檔YAML
with open('multi_doc.yaml') as f:
for doc in yaml.safe_load_all(f):
print("文檔內(nèi)容:", doc)
yaml.dump_all(documents, stream=None, **kwargs)
功能：序列化多個(gè)文檔到 YAML
??參數(shù)??：
documents：文檔對象列表stream：輸出文件對象
案例：
# 寫入多文檔YAML
doc1 = {'config': 'base'}
doc2 = {'overrides': {'debug': True}}
with open('output.yaml', 'w') as f:
yaml.dump_all([doc1, doc2], f)
三、ruamel.yaml 核心函數(shù)詳解
1. 讀取操作
YAML(typ='rt').load(stream)
功能：加載 YAML 內(nèi)容（保留注釋和格式）
??參數(shù)??：
stream：文件對象或字符串
類型參數(shù)：
typ='rt'：往返處理（保留注釋/格式）typ='safe'：安全模式（限制類型）typ='unsafe'：完整功能（可能不安全）- typ=‘base’：基礎(chǔ)功能
案例：
from ruamel.yaml import YAML
# 創(chuàng)建YAML處理器
yaml = YAML(typ='rt') # 保留注釋和格式
# 讀取帶注釋的配置
with open('commented_config.yaml') as f:
config = yaml.load(f)
print("數(shù)據(jù)庫端口:", config['database']['port'])
2. 寫入操作
YAML().dump(data, stream)
功能：輸出 YAML 內(nèi)容（保留原始格式）
??參數(shù)??：
data：要序列化的 Python 對象stream：輸出文件對象
?配置選項(xiàng)??：
yaml.indent(mapping=4, sequence=4, offset=2)：自定義縮進(jìn)yaml.preserve_quotes=True：保留字符串引號yaml.explicit_start=True：添加文檔起始符---
案例：
from ruamel.yaml import YAML
# 創(chuàng)建配置精細(xì)的YAML處理器
yaml = YAML()
yaml.indent(mapping=4, sequence=6, offset=2) # 自定義縮進(jìn)
yaml.preserve_quotes = True # 保留引號
yaml.explicit_start = True # 添加文檔起始符
# 準(zhǔn)備數(shù)據(jù)
server_config = {
'host': 'api.example.com',
'ports': [80, 443],
'ssl': {
'enabled': True,
'cert': '/path/to/cert.pem'
}
}
# 寫入文件
with open('server_config.yaml', 'w') as f:
yaml.dump(server_config, f)
3. 高級類型處理
YAML().register_class(cls)
功能：注冊自定義類進(jìn)行序列化
??參數(shù)??：
cls：要注冊的 Python 類
案例：
from datetime import datetime
from ruamel.yaml import YAML
class CustomDate:
def __init__(self, year, month, day):
self.date = datetime(year, month, day)
def __repr__(self):
return f"CustomDate({self.date.year}, {self.date.month}, {self.date.day})"
# 創(chuàng)建YAML處理器并注冊類
yaml = YAML()
yaml.register_class(CustomDate)
# 使用自定義類型
data = {'created_at': CustomDate(2023, 7, 15)}
# 序列化和反序列化
with open('custom_type.yaml', 'w') as f:
yaml.dump(data, f)
with open('custom_type.yaml') as f:
loaded = yaml.load(f)
print(loaded['created_at']) # 輸出: CustomDate(2023, 7, 15)
四、安全最佳實(shí)踐
1. 安全加載模式對比
| 方法 | 庫 | 安全級別 | 推薦場景 |
|---|---|---|---|
| yaml.safe_load() | PyYAML | ★★★★★ | 處理不可信數(shù)據(jù) |
| YAML(typ='safe').load() | ruamel.yaml | ★★★★★ | 企業(yè)級安全需求 |
| yaml.load() | PyYAML | ★☆☆☆☆ | 僅限可信數(shù)據(jù) |
| YAML(typ='unsafe').load() | ruamel.yaml | ★☆☆☆☆ | 避免使用 |
2. 自定義安全加載器
import yaml
# 創(chuàng)建安全加載器（僅允許基礎(chǔ)類型）
class StrictSafeLoader(yaml.SafeLoader):
def __init__(self, stream):
super().__init__(stream)
# 僅允許基礎(chǔ)類型
self.yaml_constructors = {
'tag:yaml.org,2002:map': self.construct_yaml_map,
'tag:yaml.org,2002:str': self.construct_yaml_str,
'tag:yaml.org,2002:seq': self.construct_yaml_seq,
'tag:yaml.org,2002:int': self.construct_yaml_int,
'tag:yaml.org,2002:float': self.construct_yaml_float,
'tag:yaml.org,2002:bool': self.construct_yaml_bool
}
# 使用安全加載器
with open('untrusted.yaml') as f:
data = yaml.load(f, Loader=StrictSafeLoader)
五、實(shí)用案例解析
1. 應(yīng)用配置管理（PyYAML）
import yaml
import os
class AppConfig:
_instance = None
def __init__(self, path='config.yaml'):
self.path = path
self.config = self._load_config()
def _load_config(self):
"""加載配置文件"""
if not os.path.exists(self.path):
# 創(chuàng)建默認(rèn)配置
default = {
'debug': False,
'database': {
'host': 'localhost',
'port': 5432
}
}
with open(self.path, 'w') as f:
yaml.safe_dump(default, f)
return default
with open(self.path) as f:
return yaml.safe_load(f)
def get(self, key, default=None):
"""獲取配置項(xiàng)"""
keys = key.split('.')
value = self.config
for k in keys:
if isinstance(value, dict) and k in value:
value = value[k]
else:
return default
return value
def set(self, key, value):
"""更新配置項(xiàng)"""
keys = key.split('.')
current = self.config
for k in keys[:-1]:
if k not in current:
current[k] = {}
current = current[k]
current[keys[-1]] = value
# 保存更新
with open(self.path, 'w') as f:
yaml.safe_dump(self.config, f)
# 使用示例
config = AppConfig()
print("數(shù)據(jù)庫主機(jī):", config.get('database.host'))
config.set('debug', True)
2. Kubernetes清單生成（ruamel.yaml）
from ruamel.yaml import YAML
def generate_k8s_deployment(name, replicas, image, ports):
"""生成K8s部署YAML"""
yaml = YAML()
yaml.explicit_start = True
yaml.indent(sequence=4, offset=2)
deployment = {
'apiVersion': 'apps/v1',
'kind': 'Deployment',
'metadata': {'name': name},
'spec': {
'replicas': replicas,
'selector': {'matchLabels': {'app': name}},
'template': {
'metadata': {'labels': {'app': name}},
'spec': {
'containers': [{
'name': 'main',
'image': image,
'ports': [{'containerPort': p} for p in ports]
}]
}
}
}
}
# 寫入文件
filename = f'{name}-deployment.yaml'
with open(filename, 'w') as f:
yaml.dump(deployment, f)
print(f"已生成部署文件: {filename}")
# 使用示例
generate_k8s_deployment(
name='web-app',
replicas=3,
image='web-app:v1.2.3',
ports=[80, 443]
)
3. 配置文件熱重載
from ruamel.yaml import YAML
import time
import os
class HotReloadConfig:
def __init__(self, path):
self.path = path
self.yaml = YAML()
self.config = None
self.last_modified = 0
self.load()
def load(self):
"""加載配置文件"""
self.last_modified = os.path.getmtime(self.path)
with open(self.path) as f:
self.config = self.yaml.load(f)
print("配置文件已重新加載")
def check_reload(self):
"""檢查是否需要重新加載"""
current_modified = os.path.getmtime(self.path)
if current_modified > self.last_modified:
self.load()
return True
return False
def get(self, key, default=None):
"""獲取配置項(xiàng)"""
# 簡單實(shí)現(xiàn)，實(shí)際中可添加更復(fù)雜的路徑解析
return self.config.get(key, default)
# 使用示例
config = HotReloadConfig('app_config.yaml')
# 監(jiān)控線程（實(shí)際中應(yīng)使用線程）
while True:
print("當(dāng)前調(diào)試模式:", config.get('debug', False))
config.check_reload() # 檢查更新
time.sleep(5)
六、常見問題解決
1. 編碼問題處理
# 顯式指定UTF-8編碼
with open('config.yaml', 'w', encoding='utf-8') as f:
yaml.dump(data, f)
# 自動(dòng)檢測編碼
import chardet
def read_yaml_with_encoding(path):
"""自動(dòng)檢測編碼讀取YAML"""
with open(path, 'rb') as f:
raw_data = f.read(4096) # 讀取前4KB檢測編碼
result = chardet.detect(raw_data)
encoding = result['encoding'] or 'utf-8'
with open(path, 'r', encoding=encoding) as f:
return yaml.safe_load(f)
data = read_yaml_with_encoding('unknown_encoding.yaml')
2. 特殊字符處理
# 使用ruamel.yaml保留特殊字符
yaml = YAML()
yaml.preserve_quotes = True
# 包含特殊字符的值
data = {
'regex': r'^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$',
'path': 'C:\\Program Files\\App',
'percent': '100%'
}
with open('special_chars.yaml', 'w') as f:
yaml.dump(data, f)
3. 大型文件處理
from ruamel.yaml import YAML
def process_large_yaml(path):
"""流式處理大型YAML文件"""
yaml = YAML()
with open(path) as f:
for doc in yaml.load_all(f):
# 處理每個(gè)文檔
process_document(doc)
def process_document(doc):
"""處理單個(gè)文檔（示例）"""
print(f"處理文檔，包含 {len(doc)} 個(gè)鍵")
# 使用示例
process_large_yaml('large_dataset.yaml')
總結(jié)：YAML處理最佳實(shí)踐
1. 庫選擇指南
- 簡單場景：PyYAML（易用、輕量）
- 復(fù)雜場景：ruamel.yaml（保留注釋、格式控制）
- 安全優(yōu)先：總是使用安全加載方法
2. 核心操作速查表
| 操作 | PyYAML | ruamel.yaml |
|---|---|---|
| 安全讀取 | yaml.safe_load() | YAML(typ='safe').load() |
| 標(biāo)準(zhǔn)讀取 | yaml.load() | YAML(typ='rt').load() |
| 寫入 | yaml.dump() | Yaml().dump() |
| 多文檔讀取 | yaml.safe_load_all() | Yaml().load_all() |
| 多文檔寫入 | yaml.dump_all() | Yaml().dump_all() |
| 保留注釋 | ? | ? |
| 自定義類型 | add_constructor | register_class |
3. 性能優(yōu)化建議
- 大型文件：使用流式處理（
load_all） - 頻繁讀寫：緩存解析器實(shí)例
- 內(nèi)存優(yōu)化：避免加載超大文件到內(nèi)存
- 選擇性解析：僅加載需要的部分?jǐn)?shù)據(jù)
通過掌握這些核心技術(shù)和最佳實(shí)踐，您將能夠高效處理各種 YAML 應(yīng)用場景，從簡單的配置文件到復(fù)雜的數(shù)據(jù)交換需求，構(gòu)建可靠的 Python 數(shù)據(jù)處理系統(tǒng)。
以上就是Python YAML文件處理的完整指南的詳細(xì)內(nèi)容，更多關(guān)于Python YAML文件處理的資料請關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
這篇文章主要介紹了Python一行命令部署http?ftp服務(wù)實(shí)現(xiàn)過程詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2024-01-01
Pycharm創(chuàng)建python文件自動(dòng)添加日期作者等信息(步驟詳解)
這篇文章主要介紹了Pycharm創(chuàng)建python文件自動(dòng)添加日期作者等信息(步驟詳解),本文分步驟給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2021-02-02
Python通過串口實(shí)現(xiàn)收發(fā)文件
這篇文章主要為大家詳細(xì)介紹了Python如何通過串口實(shí)現(xiàn)收發(fā)文件功能,文中的示例代碼簡潔易懂,具有一定的借鑒價(jià)值,感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2023-11-11
python調(diào)用帶空格的windows?cmd命令問題及連續(xù)運(yùn)行多個(gè)命令方式
這篇文章主要介紹了python調(diào)用帶空格的windows?cmd命令問題及連續(xù)運(yùn)行多個(gè)命令方式,具有很好的參考價(jià)值,希望對大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-02-02
這篇文章主要為大家詳細(xì)介紹了十大Python庫，學(xué)習(xí)數(shù)據(jù)分析應(yīng)該弄清楚該學(xué)習(xí)什么技能，該使用哪種工具，本文具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2022-01-01
詳解python中init方法和隨機(jī)數(shù)方法
這篇文章主要介紹了python中init方法和隨機(jī)數(shù)方法，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-03-03
詳解如何從TensorFlow的mnist數(shù)據(jù)集導(dǎo)出手寫體數(shù)字圖片
這篇文章主要介紹了詳解如何從TensorFlow的mnist數(shù)據(jù)集導(dǎo)出手寫體數(shù)字圖片，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-08-08
當(dāng)處理迷宮問題時(shí),遺傳算法提供了創(chuàng)新的解決方案,本文將深入探討如何運(yùn)用Python和遺傳算法來解決迷宮問題,這是一個(gè)經(jīng)典的尋路問題,尋找從起點(diǎn)到終點(diǎn)的最佳路徑,遺傳算法是一種啟發(fā)式優(yōu)化方法,適用于解決復(fù)雜問題,其中個(gè)體進(jìn)化和自然選擇的概念被用于尋找最優(yōu)解2023-12-12
在現(xiàn)代社會(huì)中,搖號系統(tǒng)廣泛應(yīng)用于車牌搖號、房屋搖號等公共資源分配領(lǐng)域,本文將詳細(xì)介紹如何使用Python實(shí)現(xiàn)一個(gè)簡單的搖號系統(tǒng),有需要的可以了解下2024-11-11
實(shí)現(xiàn)ECharts雙Y軸左右刻度線一致的例子
這篇文章主要介紹了實(shí)現(xiàn)ECharts雙Y軸左右刻度線一致的例子，具有很好的參考價(jià)值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-05-05