<!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>Module: nbformat.v3.nbbase — IPython 2.3.0 documentation</title> <link rel="stylesheet" href="../../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../../', VERSION: '2.3.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </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="top" title="IPython 2.3.0 documentation" href="../../index.html" /> <link rel="up" title="The IPython API" href="../index.html" /> <link rel="next" title="Module: nbformat.v3.nbjson" href="IPython.nbformat.v3.nbjson.html" /> <link rel="prev" title="Module: nbformat.v3.convert" href="IPython.nbformat.v3.convert.html" /> </head> <body> <div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px"> <a href="http://ipython.org/"><img src="../../_static/logo.png" border="0" alt="IPython Documentation"/></a> </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="IPython.nbformat.v3.nbjson.html" title="Module: nbformat.v3.nbjson" accesskey="N">next</a> |</li> <li class="right" > <a href="IPython.nbformat.v3.convert.html" title="Module: nbformat.v3.convert" accesskey="P">previous</a> |</li> <li><a href="http://ipython.org">home</a>| </li> <li><a href="../../search.html">search</a>| </li> <li><a href="../../index.html">documentation </a> »</li> <li><a href="../index.html" accesskey="U">The IPython API</a> »</li> </ul> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3><a href="../../index.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">Module: <tt class="docutils literal"><span class="pre">nbformat.v3.nbbase</span></tt></a><ul> <li><a class="reference internal" href="#class">1 Class</a></li> <li><a class="reference internal" href="#functions">9 Functions</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="IPython.nbformat.v3.convert.html" title="previous chapter">Module: <tt class="docutils literal"><span class="pre">nbformat.v3.convert</span></tt></a></p> <h4>Next topic</h4> <p class="topless"><a href="IPython.nbformat.v3.nbjson.html" title="next chapter">Module: <tt class="docutils literal"><span class="pre">nbformat.v3.nbjson</span></tt></a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../../_sources/api/generated/IPython.nbformat.v3.nbbase.txt" rel="nofollow">Show Source</a></li> </ul> <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="module-IPython.nbformat.v3.nbbase"> <span id="module-nbformat-v3-nbbase"></span><h1>Module: <tt class="xref py py-mod docutils literal"><span class="pre">nbformat.v3.nbbase</span></tt><a class="headerlink" href="#module-IPython.nbformat.v3.nbbase" title="Permalink to this headline">¶</a></h1> <p>The basic dict based notebook format.</p> <p>The Python representation of a notebook is a nested structure of dictionary subclasses that support attribute access (IPython.utils.ipstruct.Struct). The functions in this module are merely helpers to build the structs in the right form.</p> <div class="section" id="class"> <h2>1 Class<a class="headerlink" href="#class" title="Permalink to this headline">¶</a></h2> <dl class="class"> <dt id="IPython.nbformat.v3.nbbase.NotebookNode"> <em class="property">class </em><tt class="descclassname">IPython.nbformat.v3.nbbase.</tt><tt class="descname">NotebookNode</tt><big>(</big><em>*args</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#IPython.nbformat.v3.nbbase.NotebookNode" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="IPython.utils.ipstruct.html#IPython.utils.ipstruct.Struct" title="IPython.utils.ipstruct.Struct"><tt class="xref py py-class docutils literal"><span class="pre">IPython.utils.ipstruct.Struct</span></tt></a></p> </dd></dl> </div> <div class="section" id="functions"> <h2>9 Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h2> <dl class="function"> <dt id="IPython.nbformat.v3.nbbase.from_dict"> <tt class="descclassname">IPython.nbformat.v3.nbbase.</tt><tt class="descname">from_dict</tt><big>(</big><em>d</em><big>)</big><a class="headerlink" href="#IPython.nbformat.v3.nbbase.from_dict" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="function"> <dt id="IPython.nbformat.v3.nbbase.new_output"> <tt class="descclassname">IPython.nbformat.v3.nbbase.</tt><tt class="descname">new_output</tt><big>(</big><em>output_type</em>, <em>output_text=None</em>, <em>output_png=None</em>, <em>output_html=None</em>, <em>output_svg=None</em>, <em>output_latex=None</em>, <em>output_json=None</em>, <em>output_javascript=None</em>, <em>output_jpeg=None</em>, <em>prompt_number=None</em>, <em>ename=None</em>, <em>evalue=None</em>, <em>traceback=None</em>, <em>stream=None</em>, <em>metadata=None</em><big>)</big><a class="headerlink" href="#IPython.nbformat.v3.nbbase.new_output" title="Permalink to this definition">¶</a></dt> <dd><p>Create a new output, to go in the <tt class="docutils literal"><span class="pre">cell.outputs</span></tt> list of a code cell.</p> </dd></dl> <dl class="function"> <dt id="IPython.nbformat.v3.nbbase.new_code_cell"> <tt class="descclassname">IPython.nbformat.v3.nbbase.</tt><tt class="descname">new_code_cell</tt><big>(</big><em>input=None</em>, <em>prompt_number=None</em>, <em>outputs=None</em>, <em>language=u'python'</em>, <em>collapsed=False</em>, <em>metadata=None</em><big>)</big><a class="headerlink" href="#IPython.nbformat.v3.nbbase.new_code_cell" title="Permalink to this definition">¶</a></dt> <dd><p>Create a new code cell with input and output</p> </dd></dl> <dl class="function"> <dt id="IPython.nbformat.v3.nbbase.new_text_cell"> <tt class="descclassname">IPython.nbformat.v3.nbbase.</tt><tt class="descname">new_text_cell</tt><big>(</big><em>cell_type</em>, <em>source=None</em>, <em>rendered=None</em>, <em>metadata=None</em><big>)</big><a class="headerlink" href="#IPython.nbformat.v3.nbbase.new_text_cell" title="Permalink to this definition">¶</a></dt> <dd><p>Create a new text cell.</p> </dd></dl> <dl class="function"> <dt id="IPython.nbformat.v3.nbbase.new_heading_cell"> <tt class="descclassname">IPython.nbformat.v3.nbbase.</tt><tt class="descname">new_heading_cell</tt><big>(</big><em>source=None</em>, <em>rendered=None</em>, <em>level=1</em>, <em>metadata=None</em><big>)</big><a class="headerlink" href="#IPython.nbformat.v3.nbbase.new_heading_cell" title="Permalink to this definition">¶</a></dt> <dd><p>Create a new section cell with a given integer level.</p> </dd></dl> <dl class="function"> <dt id="IPython.nbformat.v3.nbbase.new_worksheet"> <tt class="descclassname">IPython.nbformat.v3.nbbase.</tt><tt class="descname">new_worksheet</tt><big>(</big><em>name=None</em>, <em>cells=None</em>, <em>metadata=None</em><big>)</big><a class="headerlink" href="#IPython.nbformat.v3.nbbase.new_worksheet" title="Permalink to this definition">¶</a></dt> <dd><p>Create a worksheet by name with with a list of cells.</p> </dd></dl> <dl class="function"> <dt id="IPython.nbformat.v3.nbbase.new_notebook"> <tt class="descclassname">IPython.nbformat.v3.nbbase.</tt><tt class="descname">new_notebook</tt><big>(</big><em>name=None</em>, <em>metadata=None</em>, <em>worksheets=None</em><big>)</big><a class="headerlink" href="#IPython.nbformat.v3.nbbase.new_notebook" title="Permalink to this definition">¶</a></dt> <dd><p>Create a notebook by name, id and a list of worksheets.</p> </dd></dl> <dl class="function"> <dt id="IPython.nbformat.v3.nbbase.new_metadata"> <tt class="descclassname">IPython.nbformat.v3.nbbase.</tt><tt class="descname">new_metadata</tt><big>(</big><em>name=None</em>, <em>authors=None</em>, <em>license=None</em>, <em>created=None</em>, <em>modified=None</em>, <em>gistid=None</em><big>)</big><a class="headerlink" href="#IPython.nbformat.v3.nbbase.new_metadata" title="Permalink to this definition">¶</a></dt> <dd><p>Create a new metadata node.</p> </dd></dl> <dl class="function"> <dt id="IPython.nbformat.v3.nbbase.new_author"> <tt class="descclassname">IPython.nbformat.v3.nbbase.</tt><tt class="descname">new_author</tt><big>(</big><em>name=None</em>, <em>email=None</em>, <em>affiliation=None</em>, <em>url=None</em><big>)</big><a class="headerlink" href="#IPython.nbformat.v3.nbbase.new_author" title="Permalink to this definition">¶</a></dt> <dd><p>Create a new author.</p> </dd></dl> </div> </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="IPython.nbformat.v3.nbjson.html" title="Module: nbformat.v3.nbjson" >next</a> |</li> <li class="right" > <a href="IPython.nbformat.v3.convert.html" title="Module: nbformat.v3.convert" >previous</a> |</li> <li><a href="http://ipython.org">home</a>| </li> <li><a href="../../search.html">search</a>| </li> <li><a href="../../index.html">documentation </a> »</li> <li><a href="../index.html" >The IPython API</a> »</li> </ul> </div> <div class="footer"> © Copyright The IPython Development Team. Last updated on Jul 14, 2015. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3. </div> </body> </html>