<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>read_multiline_adjlist — NetworkX 1.8.1 documentation</title> <link rel="stylesheet" href="../../_static/networkx.css" type="text/css" /> <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../../', VERSION: '1.8.1', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: false }; </script> <script type="text/javascript" src="../../_static/jquery.js"></script> <script type="text/javascript" src="../../_static/underscore.js"></script> <script type="text/javascript" src="../../_static/doctools.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within NetworkX 1.8.1 documentation" href="../../_static/opensearch.xml"/> <link rel="top" title="NetworkX 1.8.1 documentation" href="../../index.html" /> <link rel="up" title="Multiline Adjacency List" href="../readwrite.multiline_adjlist.html" /> <link rel="next" title="write_multiline_adjlist" href="networkx.readwrite.multiline_adjlist.write_multiline_adjlist.html" /> <link rel="prev" title="generate_multiline_adjlist" href="networkx.readwrite.multiline_adjlist.generate_multiline_adjlist.html" /> </head> <body> <div style="color: black;background-color: white; font-size: 3.2em; text-align: left; padding: 15px 10px 10px 15px"> NetworkX </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="networkx.readwrite.multiline_adjlist.write_multiline_adjlist.html" title="write_multiline_adjlist" accesskey="N">next</a> |</li> <li class="right" > <a href="networkx.readwrite.multiline_adjlist.generate_multiline_adjlist.html" title="generate_multiline_adjlist" accesskey="P">previous</a> |</li> <li><a href="http://networkx.github.com/">NetworkX Home </a> | </li> <li><a href="http://networkx.github.com/documentation.html">Documentation </a>| </li> <li><a href="http://networkx.github.com/download.html">Download </a> | </li> <li><a href="http://github.com/networkx">Developer (Github)</a></li> <li><a href="../index.html" >Reference</a> »</li> <li><a href="../pdf_reference.html" >Reference</a> »</li> <li><a href="../readwrite.html" >Reading and writing graphs</a> »</li> <li><a href="../readwrite.multiline_adjlist.html" accesskey="U">Multiline Adjacency List</a> »</li> </ul> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h4>Previous topic</h4> <p class="topless"><a href="networkx.readwrite.multiline_adjlist.generate_multiline_adjlist.html" title="previous chapter">generate_multiline_adjlist</a></p> <h4>Next topic</h4> <p class="topless"><a href="networkx.readwrite.multiline_adjlist.write_multiline_adjlist.html" title="next chapter">write_multiline_adjlist</a></p> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="read-multiline-adjlist"> <h1>read_multiline_adjlist<a class="headerlink" href="#read-multiline-adjlist" title="Permalink to this headline">¶</a></h1> <dl class="function"> <dt id="networkx.readwrite.multiline_adjlist.read_multiline_adjlist"> <tt class="descname">read_multiline_adjlist</tt><big>(</big><em>path</em>, <em>comments='#'</em>, <em>delimiter=None</em>, <em>create_using=None</em>, <em>nodetype=None</em>, <em>edgetype=None</em>, <em>encoding='utf-8'</em><big>)</big><a class="reference internal" href="../../_modules/networkx/readwrite/multiline_adjlist.html#read_multiline_adjlist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#networkx.readwrite.multiline_adjlist.read_multiline_adjlist" title="Permalink to this definition">¶</a></dt> <dd><p>Read graph in multi-line adjacency list format from path.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters :</th><td class="field-body"><p class="first"><strong>path</strong> : string or file</p> <blockquote> <div><p>Filename or file handle to read. Filenames ending in .gz or .bz2 will be uncompressed.</p> </div></blockquote> <p><strong>create_using: NetworkX graph container</strong> :</p> <blockquote> <div><p>Use given NetworkX graph for holding nodes or edges.</p> </div></blockquote> <p><strong>nodetype</strong> : Python type, optional</p> <blockquote> <div><p>Convert nodes to this type.</p> </div></blockquote> <p><strong>edgetype</strong> : Python type, optional</p> <blockquote> <div><p>Convert edge data to this type.</p> </div></blockquote> <p><strong>comments</strong> : string, optional</p> <blockquote> <div><p>Marker for comment lines</p> </div></blockquote> <p><strong>delimiter</strong> : string, optional</p> <blockquote> <div><p>Separator for node labels. The default is whitespace.</p> </div></blockquote> <p><strong>create_using: NetworkX graph container</strong> :</p> <blockquote> <div><p>Use given NetworkX graph for holding nodes or edges.</p> </div></blockquote> </td> </tr> <tr class="field-even field"><th class="field-name">Returns :</th><td class="field-body"><p class="first last"><strong>G: NetworkX graph</strong> :</p> </td> </tr> </tbody> </table> <div class="admonition-see-also admonition seealso"> <p class="first admonition-title">See also</p> <p class="last"><a class="reference internal" href="networkx.readwrite.multiline_adjlist.write_multiline_adjlist.html#networkx.readwrite.multiline_adjlist.write_multiline_adjlist" title="networkx.readwrite.multiline_adjlist.write_multiline_adjlist"><tt class="xref py py-obj docutils literal"><span class="pre">write_multiline_adjlist</span></tt></a></p> </div> <p class="rubric">Notes</p> <p>This format does not store graph, node, or edge data.</p> <p class="rubric">Examples</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">G</span><span class="o">=</span><span class="n">nx</span><span class="o">.</span><span class="n">path_graph</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">nx</span><span class="o">.</span><span class="n">write_multiline_adjlist</span><span class="p">(</span><span class="n">G</span><span class="p">,</span><span class="s">"test.adjlist"</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">G</span><span class="o">=</span><span class="n">nx</span><span class="o">.</span><span class="n">read_multiline_adjlist</span><span class="p">(</span><span class="s">"test.adjlist"</span><span class="p">)</span> </pre></div> </div> <p>The path can be a file or a string with the name of the file. If a file s provided, it has to be opened in ‘rb’ mode.</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">fh</span><span class="o">=</span><span class="nb">open</span><span class="p">(</span><span class="s">"test.adjlist"</span><span class="p">,</span> <span class="s">'rb'</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">G</span><span class="o">=</span><span class="n">nx</span><span class="o">.</span><span class="n">read_multiline_adjlist</span><span class="p">(</span><span class="n">fh</span><span class="p">)</span> </pre></div> </div> <p>Filenames ending in .gz or .bz2 will be compressed.</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">nx</span><span class="o">.</span><span class="n">write_multiline_adjlist</span><span class="p">(</span><span class="n">G</span><span class="p">,</span><span class="s">"test.adjlist.gz"</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">G</span><span class="o">=</span><span class="n">nx</span><span class="o">.</span><span class="n">read_multiline_adjlist</span><span class="p">(</span><span class="s">"test.adjlist.gz"</span><span class="p">)</span> </pre></div> </div> <p>The optional nodetype is a function to convert node strings to nodetype.</p> <p>For example</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">G</span><span class="o">=</span><span class="n">nx</span><span class="o">.</span><span class="n">read_multiline_adjlist</span><span class="p">(</span><span class="s">"test.adjlist"</span><span class="p">,</span> <span class="n">nodetype</span><span class="o">=</span><span class="nb">int</span><span class="p">)</span> </pre></div> </div> <p>will attempt to convert all nodes to integer type.</p> <p>The optional edgetype is a function to convert edge data strings to edgetype.</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">G</span><span class="o">=</span><span class="n">nx</span><span class="o">.</span><span class="n">read_multiline_adjlist</span><span class="p">(</span><span class="s">"test.adjlist"</span><span class="p">)</span> </pre></div> </div> <p>The optional create_using parameter is a NetworkX graph container. The default is Graph(), an undirected graph. To read the data as a directed graph use</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">G</span><span class="o">=</span><span class="n">nx</span><span class="o">.</span><span class="n">read_multiline_adjlist</span><span class="p">(</span><span class="s">"test.adjlist"</span><span class="p">,</span> <span class="n">create_using</span><span class="o">=</span><span class="n">nx</span><span class="o">.</span><span class="n">DiGraph</span><span class="p">())</span> </pre></div> </div> </dd></dl> </div> </div> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="networkx.readwrite.multiline_adjlist.write_multiline_adjlist.html" title="write_multiline_adjlist" >next</a> |</li> <li class="right" > <a href="networkx.readwrite.multiline_adjlist.generate_multiline_adjlist.html" title="generate_multiline_adjlist" >previous</a> |</li> <li><a href="http://networkx.github.com/">NetworkX Home </a> | </li> <li><a href="http://networkx.github.com/documentation.html">Documentation </a>| </li> <li><a href="http://networkx.github.com/download.html">Download </a> | </li> <li><a href="http://github.com/networkx">Developer (Github)</a></li> <li><a href="../index.html" >Reference</a> »</li> <li><a href="../pdf_reference.html" >Reference</a> »</li> <li><a href="../readwrite.html" >Reading and writing graphs</a> »</li> <li><a href="../readwrite.multiline_adjlist.html" >Multiline Adjacency List</a> »</li> </ul> </div> <div class="footer"> © Copyright 2013, NetworkX Developers. Last updated on Oct 23, 2013. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>