Skip to content

Generate Yaml

hexa.generate_yaml

Summary

Generate YAML spec (nested mapping form) from a hexa PortNode tree.

Classes

Functions

generate_yaml 

1
2
3
generate_yaml(
    node: PortNode, out_path: str | Path | None = None
) -> str

Generate YAML source from a :class:PortNode tree.

Parameters:

Name Type Description Default
node PortNode

The root of the tree.

 required
out_path str | Path | None

Optional file path to write the generated source to.

 None

Returns:

Name Type Description
str str

The generated YAML source.