How to Flexibly Configure Your Python Projects with YAML

YAML Library Features

Parse YAML strings or files into native Python objects (e.g., dict, list).

Serialize Python objects to YAML strings or files.

Support for nested dictionaries, lists, and scalar values.

Custom tags and types allow user‑defined parsing and generation rules.

Installation

pip install pyyaml

Usage

Parsing YAML

import yaml
yaml_str = """
    name: John Doe
    age: 30
    hobbies:
      - Reading
      - Hiking
"""
# From string
data = yaml.safe_load(yaml_str)
print(data)  # {'name': 'John Doe', 'age': 30, 'hobbies': ['Reading', 'Hiking']}

# From file
with open('example.yaml', 'r') as file:
    data = yaml.safe_load(file)
    print(data)

Generating YAML

import yaml

data = {
    'name': 'John Doe',
    'age': 30,
    'hobbies': ['Reading', 'Hiking']
}
# To string
yaml_str = yaml.dump(data)
print(yaml_str)
# To file
with open('output.yaml', 'w', encoding='utf-8') as file:
    yaml.dump(data, file)

Custom Tags

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'}

Advantages and Characteristics

Advantages

Human‑readable : Concise syntax makes files easy to read and edit.

Cross‑language support : Adopted by many languages and tools.

Supports complex structures : Nested dictionaries, lists, and scalars.

Flexibility : Custom tags extend functionality.

Characteristics

Indentation‑based hierarchy : Indentation defines nesting, similar to Python.

Multiple data types : Strings, integers, floats, booleans, dates, etc.

Anchors and references : Reuse nodes to avoid duplication.

Application Scenarios

Configuration Files

version: '3'
services:
  web:
    image: nginx
    ports:
      - "80:80"
  db:
    image: postgres
    environment:
      POSTGRES_USER: admin
      POSTGRES_PASSWORD: secret

Data Exchange

YAML can serve as the payload format for API requests and responses.

Test Data

# Test data example
test_cases:
  - input: 1
    expected_output: 2
  - input: 2
    expected_output: 4

Documentation Generation

# Swagger API example
swagger: '2.0'
info:
  title: Sample API
  version: 1.0.0
paths:
  /users:
    get:
      summary: Get all users
      responses:
        '200':
          description: OK

Considerations

Security

Avoid yaml.load because it can execute arbitrary code. Prefer yaml.safe_load or yaml.full_load and validate input data to prevent injection attacks.

Performance

Parsing or dumping large YAML files may consume significant memory and CPU time; performance optimizations may be required for big files.

Syntax Rules

Consistent indentation is required to avoid parsing errors.

YAML automatically infers data types, which can lead to unexpected conversions; ensure correct type handling.

Example Code

Parsing a Complex YAML File

# 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']

Generating a Complex YAML File

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)