Usage

Create a yaml file:

from node.ext.yaml import YamlFile

class MyYamlFile(YamlFile):

    @property
    def fs_path(self):
        return '/path/to/file.yaml'

file = MyYamlFile()
file['child'] = 'Value'

# write file to disk
file()

Define factories for child nodes:

from node.ext.yaml import YamlNode

class SpecificChild(YamlNode):
    pass

class DefaultChild(YamlNode):
    pass

class MyYamlFile(YamlFile):
    factories = {
        'child': SpecificChild,
        '*': DefaultChild
    }

Define a schema for node members:

from node import schema
from node.behaviors import SchemaAsAttributes
from plumber import plumbing

@plumbing(SchemaAsAttributes)
class MyYamlFile(YamlFile):
    schema = {
        'int_member': schema.Int(),
        'str_member': schema.Str()
    }

file = MyYamlFile()
file.attr['int_member'] = 1
file.attr['str_member'] = u'String'

Schema members can be defined directly on class.

Note: Be careful not to override existing API members.

from node.behaviors import SchemaProperties

@plumbing(SchemaProperties)
class MyYamlFile(YamlFile):
    int_member = schema.Int()
    str_member = schema.Str()

file = MyYamlFile()
file.int_member = 1
file.str_member = u'String'

2.0.1 (2026-10-31)

• Sort the imports with ruff (one per line, from imports first, no sections) and format the code with ruff format (90 characters per line, single quotes). [rnix]

• Add qa.ruff domain to Makefile and pin the ruff configuration in pyproject.toml, make check runs ruff check. [rnix]

2.0.0 (2026-02-03)

• Refactor package layout to use pyproject.toml and implicit namespace packages. [rnix]

0.4 (2025-10-25)

• Pin upper versions of dependencies. [rnix]

0.3 (2022-12-21)

• node.ext.yaml.behaviors.YamlSequenceStorage implements now __contains__, which compares the storage values directly. This is needed to make containment checks work because yaml child nodes are not cached on __getitem__. [rnix]

• node.ext.yaml.behaviors.YamlMember provides now default_mapping_factory and default_sequence_factory settings. [rnix]

• node.ext.yaml.behaviors.YamlMember inherits from node.behaviors.WildcardFactory now. [rnix]

• Use node.behaviors.SequenceAdopt and node.behaviors.SequenceOrder behaviors on node.ext.yaml.YamlSequence. [rnix]

• Use node.behaviors.MappingOrder behavior in favor of node.behaviors.Order as introduced in node 1.2 on node.ext.yaml.YamlMapping and node.ext.yaml.YamlFile. [rnix]

0.2 (2022-10-06)

• Inherit YamlRootStorage from node.ext.fs.FSLocation, which provides fs_path property. Note that fs_path is handled as list now. [rnix]

• Inherit IYamlRoot from node.ext.fs.interfaces.IFile. [rnix]

• Package depends on node.ext.fs now. [rnix]

• Replace deprecated use of Adopt by MappingAdopt. [rnix]

• node.ext.yaml.YamlNode and node.ext.yaml.YamlFile not provides a default child factory any more. [rnix]

0.1 (2021-11-22)

• Initial work [rnix]