diff env/lib/python3.9/site-packages/networkx/readwrite/nx_yaml.py @ 0:4f3585e2f14b draft default tip

"planemo upload commit 60cee0fc7c0cda8592644e1aad72851dec82c959"

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/env/lib/python3.9/site-packages/networkx/readwrite/nx_yaml.py	Mon Mar 22 18:12:50 2021 +0000
@@ -0,0 +1,92 @@
+"""
+****
+YAML
+****
+Read and write NetworkX graphs in YAML format.
+
+"YAML is a data serialization format designed for human readability
+and interaction with scripting languages."
+See http://www.yaml.org for documentation.
+
+Format
+------
+http://pyyaml.org/wiki/PyYAML
+
+"""
+
+__all__ = ["read_yaml", "write_yaml"]
+
+from networkx.utils import open_file
+
+
+@open_file(1, mode="w")
+def write_yaml(G_to_be_yaml, path_for_yaml_output, **kwds):
+    """Write graph G in YAML format to path.
+
+    YAML is a data serialization format designed for human readability
+    and interaction with scripting languages [1]_.
+
+    Parameters
+    ----------
+    G : graph
+       A NetworkX graph
+    path : file or string
+       File or filename to write.
+       Filenames ending in .gz or .bz2 will be compressed.
+
+    Notes
+    -----
+    To use encoding on the output file include e.g. `encoding='utf-8'`
+    in the keyword arguments.
+
+    Examples
+    --------
+    >>> G = nx.path_graph(4)
+    >>> nx.write_yaml(G, "test.yaml")
+
+    References
+    ----------
+    .. [1] http://www.yaml.org
+    """
+    try:
+        import yaml
+    except ImportError as e:
+        raise ImportError("write_yaml() requires PyYAML: http://pyyaml.org/") from e
+    yaml.dump(G_to_be_yaml, path_for_yaml_output, **kwds)
+
+
+@open_file(0, mode="r")
+def read_yaml(path):
+    """Read graph in YAML format from path.
+
+    YAML is a data serialization format designed for human readability
+    and interaction with scripting languages [1]_.
+
+    Parameters
+    ----------
+    path : file or string
+       File or filename to read.  Filenames ending in .gz or .bz2
+       will be uncompressed.
+
+    Returns
+    -------
+    G : NetworkX graph
+
+    Examples
+    --------
+    >>> G = nx.path_graph(4)
+    >>> nx.write_yaml(G, "test.yaml")
+    >>> G = nx.read_yaml("test.yaml")
+
+    References
+    ----------
+    .. [1] http://www.yaml.org
+
+    """
+    try:
+        import yaml
+    except ImportError as e:
+        raise ImportError("read_yaml() requires PyYAML: http://pyyaml.org/") from e
+
+    G = yaml.load(path, Loader=yaml.FullLoader)
+    return G