灵活运用yaml格式配置你的python项目

Python开发时常用的配置文件后缀是.ini、.conf、.py、.json，今天风云要介绍的 .yaml 是当下最推荐的配置文件格式。容易阅读和修改，支持注释，且支持丰富的数据类型。

YAML（YAML Ain't Markup Language）是一种人类可读的数据序列化格式，广泛用于配置文件、数据交换和存储。Python 中的 yaml 库提供了对 YAML 格式的解析和生成支持。

1. YAML 库的功能

yaml 库的主要功能包括：

解析 YAML 文件：将 YAML 格式的字符串或文件解析为 Python 对象（如字典、列表等）。

生成 YAML 文件：将 Python 对象序列化为 YAML 格式的字符串或文件。

支持复杂数据结构：YAML 支持嵌套的字典、列表、标量值等复杂数据结构。

自定义标签和类型：允许用户定义自定义标签和类型，扩展 YAML 的功能。

2. YAML 库的安装

yaml 库通常通过 PyYAML 包提供。可以使用 pip 安装：

pip install pyyaml

3. YAML 库的用法

3.1 解析 YAML 文件

将 YAML 文件或字符串解析为 Python 对象：

import yaml


# 从字符串解析
yaml_str = """
    name: John Doe
    age: 30
    hobbies:
      - Reading
      - Hiking
"""

data = yaml.safe_load(yaml_str)
print(data)

# 输出: {'name': 'John Doe', 'age': 30, 'hobbies': ['Reading', 'Hiking']}

# 从文件解析
with open('example.yaml', 'r') as file:
    data = yaml.safe_load(file)
    print(data)

3.2 生成 YAML 文件

将 Python 对象序列化为 YAML 格式的字符串或文件：

import yaml


data = {
    'name': 'John Doe',
    'age': 30,
    'hobbies': ['Reading', 'Hiking']
}

# 生成 YAML 字符串
yaml_str = yaml.dump(data)
print(yaml_str)

# 输出:
# name: John Doe
# age: 30
# hobbies:
#   - Reading
#   - Hiking

# 写入 YAML 文件
with open('output.yaml', 'w') as file:
    yaml.dump(data, file)

3.3 自定义标签和类型

YAML 支持自定义标签，允许用户定义特定类型的解析和生成规则：

import yaml


# 定义自定义标签
def custom_constructor(loader, node):
    return node.value

yaml.add_constructor('!custom', custom_constructor)

# 使用自定义标签
yaml_str = """
    value: !custom "example"
"""

data = yaml.load(yaml_str, Loader=yaml.FullLoader)
print(data)

# 输出: {'value': 'example'}

4. YAML 库的优点和特色

4.1 优点

人类可读：YAML 的语法简洁明了，易于阅读和编写。

跨语言支持：YAML 是一种通用的数据格式，支持多种编程语言。

支持复杂数据结构：YAML 支持嵌套的字典、列表、标量值等复杂数据结构。

灵活性：YAML 支持自定义标签和类型，扩展性强。

4.2 特色

缩进表示层次：YAML 使用缩进来表示数据的层次结构，类似于 Python 的语法。

多种数据类型：YAML 支持字符串、整数、浮点数、布尔值、日期等多种数据类型。

锚点和引用：YAML 支持锚点和引用，避免重复数据。

5. YAML 库的应用场景

5.1 配置文件

YAML 广泛用于配置文件，如 Docker Compose、Kubernetes、Ansible 等工具的配置文件。

# Docker Compose 配置文件示例

version: '3'

services:
  web:
    image: nginx
    ports:
      - "80:80"

  db:
    image: postgres

    environment:
      POSTGRES_USER: admin
      POSTGRES_PASSWORD: secret

5.2 数据交换

YAML 可以用于不同系统之间的数据交换，如 API 请求和响应的数据格式。

5.3 测试数据

YAML 可以用于存储测试数据，便于测试脚本读取和使用。

# 测试数据示例
test_cases:
  - input: 1
    expected_output: 2

  - input: 2
    expected_output: 4

5.4 文档生成

YAML 可以用于生成文档，如 Swagger API 文档。

# Swagger API 文档示例
swagger: '2.0'

info:
  title: Sample API
  version: 1.0.0paths:

  /users:
    get:
      summary: Get all users

      responses:
        '200':
          description: OK

6. YAML 库的注意事项

6.1 安全性

避免使用 yaml.load：yaml.load 可以执行任意代码，存在安全风险。建议使用 yaml.safe_load 或 yaml.full_load。

验证输入数据：在解析 YAML 文件时，应验证输入数据的合法性，避免注入攻击。

6.2 性能

大文件处理：对于较大的 YAML 文件，解析和生成可能会占用较多内存和时间，需注意性能优化。

6.3 语法规范

缩进一致性：YAML 对缩进要求严格，需确保缩进一致，避免解析错误。

数据类型转换：YAML 会自动推断数据类型，可能导致意外的类型转换，需注意数据类型的准确性。

7. 示例代码

7.1 解析复杂 YAML 文件

# example.yaml
person:
  name: John Doe
  age: 30
  address:
    street: 123 Main St
    city: Anytown
    state: CA

  hobbies:
    - Reading
    - Hiking



import yaml

with open('example.yaml', 'r') as file:
    data = yaml.safe_load(file)
    print(data['person']['name'])  # 输出: John Doe
    print(data['person']['hobbies'])  # 输出: ['Reading', 'Hiking']

7.2 生成复杂 YAML 文件

import yaml



data = {
    'person': {
        'name': 'Jane Doe',
        'age': 25,
        'address': {
            'street': '456 Elm St',
            'city': 'Othertown',
            'state': 'NY'
        },

        'hobbies': ['Swimming', 'Cycling']
    }
}

with open('output.yaml', 'w') as file:
    yaml.dump(data, file)

最后，看看风云的项目配置案例