Python使用yaml模塊操作YAML文檔的方法
更新時間：2023年01月13日 16:01:18 作者：牛油菠蘿包
YAML是可讀性高，用來表達(dá)數(shù)據(jù)序列化格式的，專用于寫配置文件的語言，這篇文章主要介紹了Python使用yaml模塊操作YAML文檔,需要的朋友可以參考下
1. YAML簡介
YAML是可讀性高，用來表達(dá)數(shù)據(jù)序列化格式的，專用于寫配置文件的語言。YAML文件其實也是一種配置文件類型，后綴名是.yaml或.yml都可以。其以數(shù)據(jù)為中心，使用空白，縮進(jìn)，分行組織數(shù)據(jù)，從而使得表示更加簡潔。
2. 語法規(guī)則
- 大小寫敏感
- 使用縮進(jìn)表示層級關(guān)系
- 使用空格鍵縮進(jìn)，而非Tab鍵縮進(jìn)
- 縮進(jìn)的空格數(shù)目不重要，只需要相同層級的元素左側(cè)對齊
- 文件中的字符串不需要使用引號標(biāo)注，但若字符串包含有特殊字符則需用引號標(biāo)注
- 注釋標(biāo)識為 #
3. 文件數(shù)據(jù)結(jié)構(gòu)
對象：鍵值對的集合(簡稱"映射或字典")
鍵值對用冒號 “:” 結(jié)構(gòu)表示 冒號與值之間需用空格分隔
數(shù)組：一組按序排列的值(簡稱"序列或列表")
數(shù)組前加有 “-” 符號 符號與值之間需用空格分隔
純量(scalars)：單個的、不可再份的值(如：字符串、bool值、整數(shù)、浮點數(shù)、時間、日期、null等)
None值可用null，也可用~表示
4. YAML數(shù)據(jù)格式示例
# 對象：yaml鍵值對；即Python中字典
user: 'admin'
pwd: 'admin@123'
site: "www.yaml.com"
# 解析后: {'user': 'admin', 'password': 'admin@123', 'site': 'www.yaml.com'}
# 2. 數(shù)組：yaml鍵值對中嵌套數(shù)組
user2:
- a
- b
- c
user3:
- d
# 解析后：{'user2':['a','b','c'],'user3':['d']}
# 3. 純量
val_name: name # 字符串: {'val_name': 'name'}
spec_val: "name\n" # 特殊字符串: {'spec_val': 'name\n'}
pi_val: 3.14 # 數(shù)字: {'pi_val': 3.14}
bol_val: true # 布爾值: {'bol_val': true}
nul_val: null # null值: {'nul_val': None}
nul_val: ~ # null值: {'nul_val': None}
time_val: 2023-02-03t22:33:22.33-03:00 # 時間值：{'time_val': datetime.datetime(2023, 2, 3, 22, 33, 22, 330000)}
date_val: 2024-01-01 # 日期值：{'date_val': datetime.date(2024, 1, 1)}
# 4. 引用
name: &name 白云
tester: *name
# 相當(dāng)于
name: 白云
tester: 白云
# 解析后內(nèi)容：{'name': '白云', 'tester': '白云'}
# 5. 強制轉(zhuǎn)換
str: !!str 3.14
int: !!int "666"
# 輸出: {'str': '3.14','int': 123}
5. 安裝yaml庫
pip install pyyaml
6. 讀取YAML
6.1 讀取鍵值對或嵌套鍵值對
yaml文件內(nèi)容為：
user1: name: xm stu: 101 user2: name: xh stu: 102 user3: name: xl stu: 103
程序代碼：
import yaml
import os
class ReadYAML(object):
def read_yaml(self,yaml_file):
with open(yaml_file,'r',encoding='utf-8') as f:
file_data = f.read()
print("file_data類型：",type(file_data))
data = yaml.safe_load(file_data)
print("data類型:",type(data))
return data
if __name__ == "__main__":
base_name = os.path.dirname(os.path.realpath(__file__))
yaml_path = os.path.join(base_name,'test.yaml')
ry = ReadYAML()
res = ry.read_yaml(yaml_path)
print(res)輸出結(jié)果：
file_data類型： <class 'str'>
data類型: <class 'dict'>
{'user1': {'name': 'xm', 'stu': 101}, 'user2': {'name': 'xh', 'stu': 102}, 'user3': {'name': 'xl', 'stu': 103}}
6.2 讀取數(shù)組類型
yaml文件內(nèi)容為：
class1: - stu1 - stu2 - stu3 class2: - stu2
程序代碼：
import yaml
import os
class ReadArraysYAML(object):
def read_yaml(self,yaml_file):
with open(yaml_file,'r',encoding='utf-8') as f:
file_data = f.read()
# print("file_data類型：",type(file_data))
data = yaml.safe_load(file_data)
# print("data類型:",type(data))
return data
if __name__ == "__main__":
base_name = os.path.dirname(os.path.realpath(__file__))
yaml_path = os.path.join(base_name,'arrays.yaml')
ry = ReadArraysYAML()
res = ry.read_yaml(yaml_path)
print(res)輸出結(jié)果：
{'class1': ['stu1', 'stu2', 'stu3'], 'class2': ['stu2']}
6.3 多文檔同在一份yaml文件中時的讀取方法
yaml文件內(nèi)容：
# 分段yaml文件中存在多個文檔 --- animal1: dog age: 1 --- animal2: cat age: 2
程序代碼：
"""
多文檔同在一份yaml文件中時的讀取方法（使用yaml.safe_load_all()）
"""
import yaml
import os
def get_yaml_load_all(yaml_file):
file = open(yaml_file,'r',encoding='utf-8')
file_data = file.read()
file.close()
all_data = yaml.safe_load_all(file_data)
for data in all_data:
print(data)
if __name__ == "__main__":
current_path = os.path.dirname(__file__)
print(current_path)
yaml_path = os.path.join(current_path,'muti.yaml')
get_yaml_load_all(yaml_path)輸出結(jié)果：
d:\PyProject\YAML
{'animal1': 'dog', 'age': 1}
{'animal2': 'cat', 'age': 2}
6.4 向YAML文檔寫入
程序代碼：
"""
使用yaml.dump()方法將列表或字典數(shù)據(jù)寫入進(jìn)已存在的yaml文檔
"""
import yaml
import os
def generate_yaml_doc(yaml_file):
py_object = {'school':'Fxxking U','student':['stu1','stu2']}
file = open(yaml_file,'w',encoding='utf-8')
yaml.safe_dump(py_object,file)
file.close()
if __name__ == "__main__":
current_path = os.path.dirname(__file__)
print(current_path)
yaml_path = os.path.join(current_path,'generateYAML.yaml')
generate_yaml_doc(yaml_path)寫入后，YAML文檔內(nèi)容：
school: Fxxking U student: - stu1 - stu2
注：若想要以追加的形式寫入，只需將open()中的’w’改為’a’即可
6.5 更新/修改 YAML文件內(nèi)容
修改前YAML文件內(nèi)容：
school: Fxxking U student: - stu1 - stu2
程序代碼：
import yaml
import os
from readArraysYAML import ReadArraysYAML
def update_yaml(k,v,yaml_file):
readY = ReadArraysYAML()
old_data = readY.read_yaml(yaml_file)
old_data[k] = v # 修改讀取的數(shù)據(jù)，如果k不存在則新增一組鍵值對
with open(yaml_file,'w',encoding='utf-8') as f:
yaml.safe_dump(old_data,f)
if __name__ == "__main__":
current_path = os.path.dirname(__file__)
yaml_path = os.path.join(current_path,'generateYAML.yaml')
k = 'school'
v = 'SZ U'
update_yaml(k,v,yaml_path)修改后，YAML文件內(nèi)容：
school: SZ U student: - stu1 - stu2
7. 使用ruamel模塊將數(shù)據(jù)轉(zhuǎn)換為標(biāo)準(zhǔn)的yaml內(nèi)容
安裝ruamel庫
pip install ruamel.yaml
程序代碼：
from ruamel import yaml
import os
def generate_yaml_doc_ruamel(yaml_file):
py_object = {'file_type':'ruamel_yaml','school':'Fxxking U','student':['c','d']}
with open(yaml_file,'w',encoding='utf-8') as f:
yaml.dump(py_object,f,Dumper=yaml.RoundTripDumper)
if __name__ == "__main__":
current_path = os.path.dirname(__file__)
yaml_path = os.path.join(current_path,'ruamelGenerateYAML.yaml')
generate_yaml_doc_ruamel(yaml_path)
print("寫入成功！")寫入后，YAML文件內(nèi)容：
file_type: ruamel_yaml school: Fxxking U student: - c - d
到此這篇關(guān)于Python使用yaml模塊操作YAML文檔的文章就介紹到這了,更多相關(guān)Python使用yaml模塊內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
python 中的列表生成式、生成器表達(dá)式、模塊導(dǎo)入
這篇文章主要介紹了python中的列表生成式、生成器表達(dá)式、模塊導(dǎo)入 ,本文通過實例代碼給大家介紹的非常詳細(xì)，具有一定的參考借鑒價值，需要的朋友可以參考下2019-06-06
基于Python Numpy的數(shù)組array和矩陣matrix詳解
下面小編就為大家分享一篇基于Python Numpy的數(shù)組array和矩陣matrix詳解，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2018-04-04
這篇文章主要介紹了Django DRF路由與擴展功能的實現(xiàn)，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-06-06
Python lambda和Python def區(qū)別分析
Python支持一種有趣的語法，它允許你快速定義單行的最小函數(shù)。這些叫做lambda的函數(shù)，是從Lisp借用來的，可以用在任何需要函數(shù)的地方2014-11-11
Python用HBuilder創(chuàng)建交流社區(qū)APP
這篇文章主要講解Python使用HBuilder創(chuàng)建交流社區(qū)APP，使用HBuilder做一個簡單的社區(qū)瀏覽界面，下面文章附有詳細(xì)的代碼,需要的朋友可以參考一下2021-11-11
今天小編就為大家分享一篇Python 尋找局部最高點的實現(xiàn)，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2019-12-12
這篇文章主要給大家分享了Python?4種實現(xiàn)定時任務(wù)的方案，運用 while True: + sleep()、Timeloop 庫、threading.Timer 、內(nèi)置模塊 sched ，下面就來看看具體的實現(xiàn)過程吧2021-12-12
這篇文章主要介紹了Python grpc超時機制代碼示例,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2020-09-09
這篇文章主要介紹了Python DES加密實現(xiàn)原理及實例解析,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2020-07-07
Django是基于Python的一個Web開發(fā)框架,可以實現(xiàn)前端和后臺間的數(shù)據(jù)連接,下面這篇文章主要給大家介紹了關(guān)于Django中引入bootstrap的相關(guān)資料,需要的朋友可以參考下2022-10-10