一文读懂YAML文件：从基础语法到实战应用

创作时间:

作者:

@小白创作中心

一文读懂YAML文件：从基础语法到实战应用

引用

CSDN

https://m.blog.csdn.net/m0_58552717/article/details/145912144

YAML（YAML Ain't Markup Language）是一种人类可读的数据序列化格式。它被设计成易于阅读和编写，同时也适合表示复杂的数据结构。通常情况下，YAML 用于配置文件、数据交换和描述性数据的表示。

基本结构

YAML 使用空格和缩进来表示数据层级关系，因此缩进对于正确解析数据结构至关重要。

键值对

key: value
another_key: another_value

列表

- item1
- item2
- item3

嵌套结构

parent_key:
  child_key1: value1
  child_key2: value2

注释

YAML 支持单行注释，使用 # 符号：

# 这是一个注释
key: value # 这也是注释

数据类型

YAML 支持多种数据类型：

Scalars（标量）
Mappings（映射）
Sequences（序列）

示例

以下是一个简单的 YAML 示例，展示了不同类型的数据结构：

# 字符串、整数、浮点数、布尔值和 null
name: John Doe
age: 30
height: 1.75
is_student: false
description: null

# 列表
skills:
- Python
- JavaScript
- SQL

# 嵌套结构
address:
  street: 123 Main St
  city: Anytown
  country: Countryland

用途

YAML 在许多领域都有广泛的应用，包括但不限于：

配置文件
数据交换
文档结构描述

使用 PyYAML 库读取 YAML 配置文件

首先，确保你已经安装 PyYAML。你可以使用以下命令进行安装：

pip install pyyaml

然后，创建一个 YAML 配置文件，比如 config.yaml：

database:
  host: localhost
  port: 5432
  username: myuser
  password: mypassword
app:
  debug: true
  log_file: app.log

接下来，使用 Python 编写一个脚本来读取这个配置文件：

import yaml

def load_config(file_path):
    with open(file_path, 'r') as file:
        config = yaml.safe_load(file)
    return config

# 读取配置文件
config_path = 'config.yaml'
config_data = load_config(config_path)

# 访问配置项
database_config = config_data.get('database', {})
app_config = config_data.get('app', {})

# 打印配置项
print("Database Configuration:")
print(f"Host: {database_config.get('host')}")
print(f"Port: {database_config.get('port')}")
print(f"Username: {database_config.get('username')}")
print(f"Password: {database_config.get('password')}")

print("\nApp Configuration:")
print(f"Debug: {app_config.get('debug')}")
print(f"Log File: {app_config.get('log_file')}")

这个脚本使用 PyYAML 库中的 safe_load 函数来加载 YAML 文件，然后通过字典的方式访问配置项。这只是一个简单的例子，你可以根据实际需求扩展和修改代码。这种方法使得你可以将配置信息存储在易读易写的 YAML 文件中，并在代码中方便地使用。确保在实际的生产环境中，对配置文件的读取和解析进行适当的错误处理和安全性检查。