PyYAML，一个强大的 Python 库！

news2025/1/11 8:13:47

更多资料获取

📚 个人网站：ipengtao.com

大家好，今天为大家分享一个强大的 Python 库 - pyyaml。

Github地址：https://github.com/yaml/pyyaml/

在处理配置文件、序列化数据等场景中，YAML（YAML Ain’t Markup Language）格式因其简洁、易读易写而备受开发者青睐。Python 中的 PyYAML 库为我们提供了灵活高效地处理 YAML 数据的解析和生成功能。本文将全面介绍 PyYAML 库的原理、基本用法以及一些高级特性，并通过丰富的示例代码展示其强大的功能和实际应用场景。

什么是 Python PyYAML 库？

PyYAML 是 Python 中的 YAML 处理库，它能够将 YAML 格式的文本转换为 Python 中的数据结构（如字典、列表等），并且可以将 Python 数据结构序列化为 YAML 格式的文本。PyYAML 提供了简单易用的接口，使得开发者能够轻松地读取、编辑和生成 YAML 数据。

核心功能

加载 YAML 数据：PyYAML 可以将 YAML 格式的文本加载为 Python 中的数据结构。
导出 YAML 数据：PyYAML 可以将 Python 中的数据结构导出为 YAML 格式的文本。
支持标量类型：PyYAML 支持解析和生成各种标量类型，如字符串、整数、浮点数、布尔值等。
支持序列类型：PyYAML 支持解析和生成列表、字典等序列类型的数据。
支持自定义对象：PyYAML 支持解析和生成自定义对象，并且可以通过扩展标记来实现更复杂的数据转换。

使用方法

1. 安装 PyYAML 库

首先，需要安装 PyYAML 库：

pip install pyyaml

2. 加载 YAML 数据

import yaml

# 加载 YAML 文件
with open('data.yaml', 'r') as file:
    data = yaml.safe_load(file)

print(data)

3. 导出 YAML 数据

import yaml

# Python 数据
data = {'name': 'John', 'age': 30}

# 导出为 YAML 格式文本
yaml_text = yaml.dump(data)
print(yaml_text)

实际应用场景

1. 配置文件解析

PyYAML 可以用于解析各种配置文件，如服务器配置、应用配置等。

# config.yaml
server:
  host: '127.0.0.1'
  port: 8080
database:
  name: 'example'
  user: 'user'
  password: 'password'

import yaml

# 加载配置文件
with open('config.yaml', 'r') as file:
    config = yaml.safe_load(file)

print(config['server']['host'])  # 输出：127.0.0.1

2. 数据序列化与反序列化

PyYAML 可以将 Python 对象序列化为 YAML 格式的文本，也可以将 YAML 格式的文本反序列化为 Python 对象。

import yaml

# Python 对象
data = {'name': 'John', 'age': 30}

# 序列化为 YAML 格式文本
yaml_text = yaml.dump(data)

# 反序列化为 Python 对象
new_data = yaml.safe_load(yaml_text)
print(new_data)

高级功能和进阶用法

1. 自定义标签

PyYAML 支持自定义标签，使得开发者能够自定义数据转换规则。

import yaml

# 自定义标签处理函数
def custom_tag_constructor(loader, node):
    return node.value.upper()

yaml.add_constructor('!custom', custom_tag_constructor)

# 加载 YAML 数据
data = yaml.safe_load('!custom hello')

print(data)  # 输出：HELLO

2. 多文档处理

PyYAML 支持处理包含多个 YAML 文档的文件。

import yaml

# 加载包含多个 YAML 文档的文件
with open('multi_document.yaml', 'r') as file:
    documents = yaml.safe_load_all(file)

for doc in documents:
    print(doc)

总结

通过本文的介绍，深入了解了 Python PyYAML 库的原理、基本用法以及一些高级特性。PyYAML 提供了强大而灵活的功能，使得开发者能够轻松地处理 YAML 格式的数据，包括加载、导出、自定义标签处理等。无论是解析配置文件、序列化数据，还是处理复杂的数据转换，PyYAML 都是一个非常实用的工具，为工作带来更多的便利和效率。