YAML文件处理：使用Python PyYAML库
PyYAML是一个强大的Python库，专门用来处理YAML（YAML Ain't Markup Language）格式的文件。YAML是一种高度可读的数据序列化语言，非常适合用来编写配置文件。本文将展示如何使用PyYAML库来读取、写入以及处理YAML文件。
安装PyYAML
首先，确保您的环境中已经安装了PyYAML库。如果尚未安装，可以通过以下命令进行安装：
pip install pyyaml
读取YAML文件
在许多应用场景中，我们需要从YAML文件中读取配置信息。以下是使用PyYAML读取YAML文件的示例代码：
import yaml
# 打开并读取YAML文件
with open('config.yaml', 'r') as file:
config = yaml.safe_load(file)
print(config)
# 假设config.yaml文件内容如下：
# yaml: database:
# host: localhost
# port: 3306
# username: user
# password: secret
写入YAML文件
同样地，我们有时需要将数据以YAML格式写入文件。以下是相应的示例代码：
import yaml
# 要写入的数据
data = {
'database': {
'host': 'localhost',
'port': 3306,
'username': 'user',
'password': 'secret'
}
}
# 写入YAML文件
with open('config.yaml', 'w') as file:
yaml.safe_dump(data, file)
加载YAML字符串
除了从文件读取，PyYAML还支持从字符串加载YAML格式的数据：
import yaml
# YAML格式的字符串
yaml_string = """
database:
host: localhost
port: 3306
username: user
password: secret
"""
# 加载YAML字符串
config = yaml.safe_load(yaml_string)
print(config)
生成YAML字符串
与加载YAML字符串相对应，PyYAML也允许我们将Python对象转换为YAML格式的字符串：
import yaml
# Python字典
data = {
'database': {
'host': 'localhost',
'port': 3306,
'username': 'user',
'password': 'secret'
}
}
# 生成YAML字符串
yaml_string = yaml.safe_dump(data)
print(yaml_string)
处理列表数据
YAML文件中经常包含列表数据，以下是处理这类数据的示例：
import yaml
# 打开并读取包含列表的YAML文件
with open('list.yaml', 'r') as file:
data = yaml.safe_load(file)
print(data)
# 假设list.yaml文件内容如下：
# fruits:
# - apple
# - banana
# - cherry
处理嵌套结构
YAML文件支持复杂的嵌套结构，以下是处理这种结构的示例代码：
import yaml
# 打开并读取包含嵌套结构的YAML文件
with open('nested.yaml', 'r') as file:
data = yaml.safe_load(file)
print(data)
# 假设nested.yaml文件内容如下：
# user:
# name: John Doe
# age: 30
# address:
# street: 123 Main St
# city: Anytown
# state: CA
处理复杂数据类型
YAML文件可以包含复杂的数据类型，例如字典和列表的组合：
import yaml
# 打开并读取包含复杂数据类型的YAML文件
with open('complex.yaml', 'r') as file:
data = yaml.safe_load(file)
print(data)
# 假设complex.yaml文件内容如下：
# employees:
# - name: Alice
# position: Developer
# skills:
# - Python
# - JavaScript
# - name: Bob
# position: Designer
# skills:
# - Photoshop
# - Illustrator
使用YAML标签
YAML标签允许我们表示特定的数据类型：
import yaml
# 使用YAML标签的字符串
yaml_string = """
!!python/object/apply:datetime.datetime
year: 2024
month: 8
day: 15
hour: 12
minute: 42
second: 0
tzinfo: !!python/object/apply:datetime.timezone
offset: -1
name: UTC
"""
# 加载并打印数据
data = yaml.safe_load(yaml_string)
print(data)
处理YAML锚点和别名
YAML锚点和别名用于避免重复定义相同的结构：
import yaml
# 使用锚点和别名的YAML字符串
yaml_string = """
company:
name: Example Corp
employees:
- &employee
name: Alice
position: Developer
- *employee
name: Bob
position: Designer
"""
# 加载并打印数据
data = yaml.safe_load(yaml_string)
print(data)
使用YAML标签表示Python类
PyYAML允许我们使用标签来表示Python类的对象：
import yaml
class User:
def __init__(self, name, age):
self.name = name
self.age = age
# 使用Python类的YAML字符串
yaml_string = """
!!python/object/new:__main__.User
args:
- Alice
- 30
"""
# 加载并打印数据
user = yaml.safe_load(yaml_string)
print(user.name, user.age)
处理YAML流
YAML流允许我们从多个文档中读取数据：
import yaml
# YAML流字符串
yaml_stream = """
--- # Document 1
name: Alice
age: 30
--- # Document 2
name: Bob
age: 25
"""
# 读取YAML流
for doc in yaml.safe_load_all(yaml_stream):
print(doc)
使用环境变量
环境变量可以用于动态替换YAML文件中的值：
import os
import yaml
# 读取并替换环境变量的YAML文件
with open('env.yaml', 'r') as file:
data = yaml.safe_load(file)
data['database']['password'] = os.getenv('DB_PASSWORD')
print(data)
# 假设env.yaml文件内容如下：
# database:
# host: localhost
# port: 3306
# username: user
# password: ${DB_PASSWORD}
通过上述示例，我们可以看到PyYAML库在处理YAML文件方面的强大功能。无论是读取、写入，还是处理复杂的数据结构，PyYAML都能提供简洁而高效的方法。
