Dynamic YAML

2.0.0 · active · verified Mon Apr 13

Dynamic-yaml (version 2.0.0) is a Python library that enhances standard YAML with self-referential and dynamic string resolution capabilities, allowing YAML entries to reference other parts of the configuration tree using Python's string formatting syntax. It is actively maintained with releases driven by feature development, with the latest major version released on April 9, 2024.

Warnings

gotcha String scalars containing curly braces (`{`, `}`) must be explicitly quoted if they are not intended for dynamic resolution. Without quotes, `dynamic-yaml` might attempt to resolve them, or standard YAML parsing might interpret them as mapping objects, leading to unexpected behavior.
Fix: Enclose any literal strings that contain curly braces with single or double quotes (e.g., `my_literal: '{not_a_variable}'`).
gotcha When accessing keys that share names with built-in dictionary attributes (e.g., 'items', 'keys', 'values'), attribute access (`config.items`) will not work as expected. These values must be accessed using item notation (`config['items']`).
Fix: Use `config['key_name']` for keys that might clash with standard dictionary methods or attributes.

Install

pip install dynamic-yaml Install stable version

Imports

DynamicYaml
```
from dynamic_yaml import DynamicYaml
```
Main class for working with dynamic YAML objects.
load
```
from dynamic_yaml import load
```
Function to load YAML content with dynamic resolution.

Quickstart

Demonstrates loading a YAML string with self-referential keys and accessing the dynamically resolved values. It also shows how updating a referenced parameter automatically re-resolves dependent values, a feature introduced in v1.1.0.

import os
import yaml
from dynamic_yaml import DynamicYaml, load

# Simulate a YAML file content
yaml_content = """
project_name: hello-world
dirs:
  home: /home/user
  venv: "{dirs.home}/venvs/{project_name}"
  bin: "{dirs.venv}/bin"
output: "{dirs.venv}/output-{parameters.parameter1}"
parameters:
  parameter1: test_value
"""

# Load the YAML content, enabling dynamic resolution
config = load(yaml_content)

# Access resolved values using attribute access
print(f"Project Name: {config.project_name}")
print(f"Virtual Environment Path: {config.dirs.venv}")
print(f"Output Path: {config.output}")

# Demonstrate changing a parameter and re-resolving (dynamic update)
config.parameters.parameter1 = "new_test"
print(f"Updated Output Path after parameter change: {config.output}")

view raw JSON →