Serializing YAML with PyYAML

Internal

• YAML in Python

Overview

The process of serialization to YAML is rendering an in-memory data structure as a YAML-formatted string. The simplest sequence of statements that does that is:

import yaml

data = {
    'color': 'red',
    'size': 10,
    'parts': ['top', 'middle', 'bottom']
}

yaml_string = yaml.dump(data)

The YAML-formatted string will be:

color: red
parts:
- top
- middle
- bottom
size: 10

How PyYAML Serialization Works

PyYAML core model is centered on constructors, representers and tags.

Representer

A representer is a function that serializes a class instance to a YAML node representation. The representer gets a Dumper instance as a first argument, and the data object as the second. The function must return the serialized representation of the data object instance, as a s string.

def my_representer(dumper, data):

The representers are registered with add_representer(). Representers can be added for specific types (such as str or int), or for ???

yaml.add_representer(str, my_representer)