ragraph.io.yaml#

YAML dump/load module.

Module Contents#

Functions#

from_yaml(→ ragraph.graph.Graph)

Decode YAML file or string into a Graph.

to_yaml(→ Optional[str])

Encode Graph to YAML file or string.

Attributes#

yaml

ragraph.io.yaml.yaml#
ragraph.io.yaml.from_yaml(path: Optional[Union[str, pathlib.Path]] = None, enc: Optional[str] = None) → ragraph.graph.Graph#

Decode YAML file or string into a Graph.

Parameters:

  • path – YAML file path.

  • enc – YAML encoded string.

Returns:

Graph object.

ragraph.io.yaml.to_yaml(graph: ragraph.graph.Graph, path: Optional[Union[str, pathlib.Path]] = None) → Optional[str]#

Encode Graph to YAML file or string.

Parameters:

path – Optional file path to write YAML to.

Returns:

YAML string.