Skip to content

API reference

Most programs need only from yamluna import YAML. These pages cover the public methods and types used to read, edit, and write documents.

Reference Covers
YAML Loading, saving, settings, and class registration
Containers Dictionaries and lists with comments and formatting
Strings and numbers Types for choosing how a value is written
Tag registry Registering classes and sharing registrations
Errors Exceptions and source positions

All types listed here are importable from yamluna. For examples, start with the guides. For less common compatibility helpers, see the source docstrings.