nbbase.py
196 lines
| 5.9 KiB
| text/x-python
|
PythonLexer
Brian E. Granger
|
r4609 | """The basic dict based notebook format. | ||
Bernardo B. Marques
|
r4872 | The Python representation of a notebook is a nested structure of | ||
Brian E. Granger
|
r4609 | 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. | ||||
Authors: | ||||
* Brian Granger | ||||
""" | ||||
#----------------------------------------------------------------------------- | ||||
# Copyright (C) 2008-2011 The IPython Development Team | ||||
# | ||||
# Distributed under the terms of the BSD License. The full license is in | ||||
# the file COPYING, distributed as part of this software. | ||||
#----------------------------------------------------------------------------- | ||||
#----------------------------------------------------------------------------- | ||||
# Imports | ||||
#----------------------------------------------------------------------------- | ||||
Brian E. Granger
|
r4392 | |||
Brian E. Granger
|
r4401 | import pprint | ||
Brian E. Granger
|
r4392 | import uuid | ||
Brian E. Granger
|
r4401 | from IPython.utils.ipstruct import Struct | ||
Brian E. Granger
|
r4609 | #----------------------------------------------------------------------------- | ||
# Code | ||||
#----------------------------------------------------------------------------- | ||||
Brian E. Granger
|
r4401 | |||
Brian Granger
|
r6048 | # Change this when incrementing the nbformat version | ||
nbformat = 3 | ||||
Brian E. Granger
|
r4401 | class NotebookNode(Struct): | ||
pass | ||||
Brian E. Granger
|
r4392 | |||
Brian E. Granger
|
r4406 | def from_dict(d): | ||
if isinstance(d, dict): | ||||
newd = NotebookNode() | ||||
for k,v in d.items(): | ||||
newd[k] = from_dict(v) | ||||
return newd | ||||
elif isinstance(d, (tuple, list)): | ||||
return [from_dict(i) for i in d] | ||||
else: | ||||
return d | ||||
Brian E. Granger
|
r4402 | def new_output(output_type=None, output_text=None, output_png=None, | ||
Bernardo B. Marques
|
r4872 | output_html=None, output_svg=None, output_latex=None, output_json=None, | ||
Brian E. Granger
|
r4540 | output_javascript=None, output_jpeg=None, prompt_number=None, | ||
etype=None, evalue=None, traceback=None): | ||||
Brian E. Granger
|
r4392 | """Create a new code cell with input and output""" | ||
Brian E. Granger
|
r4401 | output = NotebookNode() | ||
Brian E. Granger
|
r4402 | if output_type is not None: | ||
output.output_type = unicode(output_type) | ||||
Brian E. Granger
|
r4540 | |||
if output_type != 'pyerr': | ||||
if output_text is not None: | ||||
output.text = unicode(output_text) | ||||
if output_png is not None: | ||||
output.png = bytes(output_png) | ||||
if output_jpeg is not None: | ||||
output.jpeg = bytes(output_jpeg) | ||||
if output_html is not None: | ||||
output.html = unicode(output_html) | ||||
if output_svg is not None: | ||||
output.svg = unicode(output_svg) | ||||
if output_latex is not None: | ||||
output.latex = unicode(output_latex) | ||||
if output_json is not None: | ||||
output.json = unicode(output_json) | ||||
if output_javascript is not None: | ||||
output.javascript = unicode(output_javascript) | ||||
if output_type == u'pyout': | ||||
if prompt_number is not None: | ||||
output.prompt_number = int(prompt_number) | ||||
if output_type == u'pyerr': | ||||
if etype is not None: | ||||
output.etype = unicode(etype) | ||||
if evalue is not None: | ||||
output.evalue = unicode(evalue) | ||||
if traceback is not None: | ||||
output.traceback = [unicode(frame) for frame in list(traceback)] | ||||
Brian E. Granger
|
r4402 | return output | ||
Brian E. Granger
|
r4392 | |||
Brian E. Granger
|
r4533 | def new_code_cell(input=None, prompt_number=None, outputs=None, | ||
language=u'python', collapsed=False): | ||||
Brian E. Granger
|
r4402 | """Create a new code cell with input and output""" | ||
cell = NotebookNode() | ||||
cell.cell_type = u'code' | ||||
if language is not None: | ||||
cell.language = unicode(language) | ||||
if input is not None: | ||||
cell.input = unicode(input) | ||||
if prompt_number is not None: | ||||
cell.prompt_number = int(prompt_number) | ||||
if outputs is None: | ||||
cell.outputs = [] | ||||
else: | ||||
cell.outputs = outputs | ||||
Brian E. Granger
|
r4533 | if collapsed is not None: | ||
Brian E. Granger
|
r4536 | cell.collapsed = bool(collapsed) | ||
Brian E. Granger
|
r4402 | |||
return cell | ||||
Brian E. Granger
|
r4511 | def new_text_cell(cell_type, source=None, rendered=None): | ||
Brian E. Granger
|
r4392 | """Create a new text cell.""" | ||
Brian E. Granger
|
r4401 | cell = NotebookNode() | ||
Brian E. Granger
|
r4498 | if source is not None: | ||
cell.source = unicode(source) | ||||
Brian E. Granger
|
r4511 | if rendered is not None: | ||
cell.rendered = unicode(rendered) | ||||
cell.cell_type = cell_type | ||||
Brian E. Granger
|
r4392 | return cell | ||
Brian Granger
|
r6020 | def new_heading_cell(source=None, rendered=None, level=1): | ||
Brian Granger
|
r6016 | """Create a new section cell with a given integer level.""" | ||
cell = NotebookNode() | ||||
cell.cell_type = u'heading' | ||||
if source is not None: | ||||
cell.source = unicode(source) | ||||
Brian Granger
|
r6020 | if rendered is not None: | ||
cell.rendered = unicode(rendered) | ||||
Brian Granger
|
r6016 | cell.level = int(level) | ||
return cell | ||||
Brian E. Granger
|
r4392 | def new_worksheet(name=None, cells=None): | ||
"""Create a worksheet by name with with a list of cells.""" | ||||
Brian E. Granger
|
r4401 | ws = NotebookNode() | ||
Brian E. Granger
|
r4392 | if name is not None: | ||
Brian E. Granger
|
r4401 | ws.name = unicode(name) | ||
Brian E. Granger
|
r4392 | if cells is None: | ||
Brian E. Granger
|
r4401 | ws.cells = [] | ||
Brian E. Granger
|
r4392 | else: | ||
Brian E. Granger
|
r4401 | ws.cells = list(cells) | ||
Brian E. Granger
|
r4392 | return ws | ||
MinRK
|
r6207 | def new_notebook(name=None, metadata=None, worksheets=None): | ||
Brian E. Granger
|
r4392 | """Create a notebook by name, id and a list of worksheets.""" | ||
Brian E. Granger
|
r4401 | nb = NotebookNode() | ||
Brian Granger
|
r6048 | nb.nbformat = nbformat | ||
Brian E. Granger
|
r4392 | if worksheets is None: | ||
Brian E. Granger
|
r4401 | nb.worksheets = [] | ||
Brian E. Granger
|
r4392 | else: | ||
Brian E. Granger
|
r4401 | nb.worksheets = list(worksheets) | ||
Brian E. Granger
|
r4637 | if metadata is None: | ||
nb.metadata = new_metadata() | ||||
else: | ||||
nb.metadata = NotebookNode(metadata) | ||||
MinRK
|
r6207 | if name is not None: | ||
nb.metadata.name = unicode(name) | ||||
Brian E. Granger
|
r4637 | return nb | ||
def new_metadata(name=None, authors=None, license=None, created=None, | ||||
modified=None, gistid=None): | ||||
"""Create a new metadata node.""" | ||||
metadata = NotebookNode() | ||||
if name is not None: | ||||
metadata.name = unicode(name) | ||||
if authors is not None: | ||||
metadata.authors = list(authors) | ||||
Brian E. Granger
|
r4536 | if created is not None: | ||
Brian E. Granger
|
r4637 | metadata.created = unicode(created) | ||
if modified is not None: | ||||
metadata.modified = unicode(modified) | ||||
Brian E. Granger
|
r4536 | if license is not None: | ||
Brian E. Granger
|
r4637 | metadata.license = unicode(license) | ||
if gistid is not None: | ||||
metadata.gistid = unicode(gistid) | ||||
return metadata | ||||
def new_author(name=None, email=None, affiliation=None, url=None): | ||||
"""Create a new author.""" | ||||
author = NotebookNode() | ||||
if name is not None: | ||||
author.name = unicode(name) | ||||
if email is not None: | ||||
author.email = unicode(email) | ||||
if affiliation is not None: | ||||
author.affiliation = unicode(affiliation) | ||||
if url is not None: | ||||
author.url = unicode(url) | ||||
return author | ||||
Brian E. Granger
|
r4392 | |||