Module: nbformat.v3.nbbase — IPython 2.3.1 documentation

### Navigation

- index
- modules |
- modules |
- next |
- previous |
- home|
- search|
- documentation »
- The IPython API »

# Module: `nbformat.v3.nbbase`

The basic dict based notebook format.

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.

## 1 Class

class `IPython.nbformat.v3.nbbase.` `NotebookNode`(*args, **kw)

  Bases: `IPython.utils.ipstruct.Struct`

## 9 Functions

`IPython.nbformat.v3.nbbase.` `from_dict`(d)

`IPython.nbformat.v3.nbbase.` `new_output`(output_type, output_text=None, output_png=None, output_html=None, output_svg=None, output_latex=None, output_json=None, output_javascript=None, output_jpeg=None, prompt_number=None, ename=None, evalue=None, traceback=None, stream=None, metadata=None)

  Create a new output, to go in the `cell.outputs` list of a code cell.

`IPython.nbformat.v3.nbbase.` `new_code_cell`(input=None, prompt_number=None, outputs=None, language=u'python', collapsed=False, metadata=None)

  Create a new code cell with input and output

`IPython.nbformat.v3.nbbase.` `new_text_cell`(cell_type, source=None, rendered=None, metadata=None)

  Create a new text cell.

`IPython.nbformat.v3.nbbase.` `new_heading_cell`(source=None, rendered=None, level=1, metadata=None)

  Create a new section cell with a given integer level.

`IPython.nbformat.v3.nbbase.` `new_worksheet`(name=None, cells=None, metadata=None)

  Create a worksheet by name with with a list of cells.

`IPython.nbformat.v3.nbbase.` `new_notebook`(name=None, metadata=None, worksheets=None)

  Create a notebook by name, id and a list of worksheets.

`IPython.nbformat.v3.nbbase.` `new_metadata`(name=None, authors=None, license=None, created=None, modified=None, gistid=None)

  Create a new metadata node.

`IPython.nbformat.v3.nbbase.` `new_author`(name=None, email=None, affiliation=None, url=None)

  Create a new author.

### Navigation

- index
- modules |
- modules |
- next |
- previous |
- home|
- search|
- documentation »
- The IPython API »