diff options
author | Randy <73545062+randallwvr90@users.noreply.github.com> | 2021-06-28 06:19:12 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-06-28 13:19:12 +0300 |
commit | df483f7749501fe5348dfe2945632ace1df98f6b (patch) | |
tree | 5dc47f43d421351d7c7d4e30de108e45358b1e36 | |
parent | 311346df0a8090831f2d07cc7bd29cebcbdf8df7 (diff) | |
download | networkx-df483f7749501fe5348dfe2945632ace1df98f6b.tar.gz |
Expand destringizer example in read_gml docstring (#4925)
-rw-r--r-- | networkx/readwrite/gml.py | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/networkx/readwrite/gml.py b/networkx/readwrite/gml.py index a2f5a0b5..153e6a0e 100644 --- a/networkx/readwrite/gml.py +++ b/networkx/readwrite/gml.py @@ -163,8 +163,20 @@ def read_gml(path, label="label", destringizer=None): -------- >>> G = nx.path_graph(4) >>> nx.write_gml(G, "test.gml") + + GML values are interpreted as strings by default: + >>> H = nx.read_gml("test.gml") - >>> I = nx.read_gml("test.gml", destringizer=int) + >>> H.nodes + NodeView(('0', '1', '2', '3')) + + When a `destringizer` is provided, GML values are converted to the provided type. + For example, integer nodes can be recovered as shown below: + + >>> J = nx.read_gml("test.gml", destringizer=int) + >>> J.nodes + NodeView((0, 1, 2, 3)) + """ def filter_lines(lines): |