##// END OF EJS Templates
zmqterminal subclasses TerminalInteractiveShell/IPApp...
zmqterminal subclasses TerminalInteractiveShell/IPApp this does a lot of the boiler plate for us, so Omar's communication code is used in place of run_cell / complete. Now colors, prompts, indentation, cl-args, etc. are all inherited from regular existing code. keyboard interrupts don't work yet, the kernel just dies...

File last commit:

r4637:d919e2ec
r5600:8360d3a9
Show More
current.py
230 lines | 6.3 KiB | text/x-python | PythonLexer
Brian E. Granger
More review changes....
r4609 """The official API for working with notebooks in the current format version.
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
Implemented metadata for notebook format.
r4637 from __future__ import print_function
Brian E. Granger
Full versioning added to nbformat.
r4406 import json
from xml.etree import ElementTree as ET
import re
from IPython.nbformat import v2
from IPython.nbformat import v1
Brian E. Granger
Massive work on the notebook document format....
r4484 from IPython.nbformat.v2 import (
NotebookNode,
Brian E. Granger
Created new notebook magic that can export/convert notebooks....
r4520 new_code_cell, new_text_cell, new_notebook, new_output, new_worksheet,
Brian E. Granger
Implemented metadata for notebook format.
r4637 parse_filename, new_metadata, new_author
Brian E. Granger
Massive work on the notebook document format....
r4484 )
Brian E. Granger
More review changes....
r4609 #-----------------------------------------------------------------------------
# Code
#-----------------------------------------------------------------------------
Brian E. Granger
Full versioning added to nbformat.
r4406
current_nbformat = 2
class NBFormatError(Exception):
pass
def parse_json(s, **kwargs):
"""Parse a string into a (nbformat, dict) tuple."""
d = json.loads(s, **kwargs)
nbformat = d.get('nbformat',1)
return nbformat, d
def parse_xml(s, **kwargs):
"""Parse a string into a (nbformat, etree) tuple."""
root = ET.fromstring(s)
nbformat_e = root.find('nbformat')
if nbformat_e is not None:
nbformat = int(nbformat_e.text)
else:
raise NBFormatError('No nbformat version found')
return nbformat, root
def parse_py(s, **kwargs):
"""Parse a string into a (nbformat, string) tuple."""
pattern = r'# <nbformat>(?P<nbformat>\d+)</nbformat>'
m = re.search(pattern,s)
if m is not None:
nbformat = int(m.group('nbformat'))
else:
Brian E. Granger
Improvements to file uploaded, mime types and .py reader....
r4493 nbformat = 2
Brian E. Granger
Full versioning added to nbformat.
r4406 return nbformat, s
def reads_json(s, **kwargs):
"""Read a JSON notebook from a string and return the NotebookNode object."""
nbformat, d = parse_json(s, **kwargs)
if nbformat == 1:
nb = v1.to_notebook_json(d, **kwargs)
nb = v2.convert_to_this_nbformat(nb, orig_version=1)
elif nbformat == 2:
nb = v2.to_notebook_json(d, **kwargs)
else:
raise NBFormatError('Unsupported JSON nbformat version: %i' % nbformat)
return nb
def writes_json(nb, **kwargs):
return v2.writes_json(nb, **kwargs)
def reads_xml(s, **kwargs):
"""Read an XML notebook from a string and return the NotebookNode object."""
nbformat, root = parse_xml(s, **kwargs)
if nbformat == 2:
nb = v2.to_notebook_xml(root, **kwargs)
else:
raise NBFormatError('Unsupported XML nbformat version: %i' % nbformat)
return nb
def reads_py(s, **kwargs):
"""Read a .py notebook from a string and return the NotebookNode object."""
nbformat, s = parse_py(s, **kwargs)
if nbformat == 2:
nb = v2.to_notebook_py(s, **kwargs)
else:
raise NBFormatError('Unsupported PY nbformat version: %i' % nbformat)
return nb
def writes_py(nb, **kwargs):
return v2.writes_py(nb, **kwargs)
# High level API
def reads(s, format, **kwargs):
"""Read a notebook from a string and return the NotebookNode object.
This function properly handles notebooks of any version. The notebook
returned will always be in the current version's format.
Parameters
----------
Brian E. Granger
Implemented metadata for notebook format.
r4637 s : unicode
The raw unicode string to read the notebook from.
format : (u'json', u'ipynb', u'py')
Brian E. Granger
Full versioning added to nbformat.
r4406 The format that the string is in.
Returns
-------
nb : NotebookNode
The notebook that was read.
"""
Brian E. Granger
Implemented metadata for notebook format.
r4637 format = unicode(format)
if format == u'xml':
Brian E. Granger
Full versioning added to nbformat.
r4406 return reads_xml(s, **kwargs)
Brian E. Granger
Implemented metadata for notebook format.
r4637 elif format == u'json' or format == u'ipynb':
Brian E. Granger
Full versioning added to nbformat.
r4406 return reads_json(s, **kwargs)
Brian E. Granger
Implemented metadata for notebook format.
r4637 elif format == u'py':
Brian E. Granger
Full versioning added to nbformat.
r4406 return reads_py(s, **kwargs)
else:
raise NBFormatError('Unsupported format: %s' % format)
def writes(nb, format, **kwargs):
"""Write a notebook to a string in a given format in the current nbformat version.
This function always writes the notebook in the current nbformat version.
Parameters
----------
nb : NotebookNode
The notebook to write.
Brian E. Granger
Implemented metadata for notebook format.
r4637 format : (u'json', u'ipynb', u'py')
Brian E. Granger
Full versioning added to nbformat.
r4406 The format to write the notebook in.
Returns
-------
Brian E. Granger
Implemented metadata for notebook format.
r4637 s : unicode
Brian E. Granger
Full versioning added to nbformat.
r4406 The notebook string.
"""
Brian E. Granger
Implemented metadata for notebook format.
r4637 format = unicode(format)
if format == u'xml':
raise NotImplementedError('Write to XML files is not implemented.')
elif format == u'json' or format == u'ipynb':
Brian E. Granger
Full versioning added to nbformat.
r4406 return writes_json(nb, **kwargs)
Brian E. Granger
Implemented metadata for notebook format.
r4637 elif format == u'py':
Brian E. Granger
Full versioning added to nbformat.
r4406 return writes_py(nb, **kwargs)
else:
raise NBFormatError('Unsupported format: %s' % format)
def read(fp, format, **kwargs):
"""Read a notebook from a file and return the NotebookNode object.
This function properly handles notebooks of any version. The notebook
returned will always be in the current version's format.
Parameters
----------
fp : file
Any file-like object with a read method.
Brian E. Granger
Implemented metadata for notebook format.
r4637 format : (u'json', u'ipynb', u'py')
Brian E. Granger
Full versioning added to nbformat.
r4406 The format that the string is in.
Returns
-------
nb : NotebookNode
The notebook that was read.
"""
return reads(fp.read(), format, **kwargs)
def write(nb, fp, format, **kwargs):
"""Write a notebook to a file in a given format in the current nbformat version.
This function always writes the notebook in the current nbformat version.
Parameters
----------
nb : NotebookNode
The notebook to write.
fp : file
Any file-like object with a write method.
Brian E. Granger
Implemented metadata for notebook format.
r4637 format : (u'json', u'ipynb', u'py')
Brian E. Granger
Full versioning added to nbformat.
r4406 The format to write the notebook in.
Returns
-------
Brian E. Granger
Implemented metadata for notebook format.
r4637 s : unicode
Brian E. Granger
Full versioning added to nbformat.
r4406 The notebook string.
"""
return fp.write(writes(nb, format, **kwargs))
Brian E. Granger
Implemented metadata for notebook format.
r4637 def _convert_to_metadata():
"""Convert to a notebook having notebook metadata."""
import glob
for fname in glob.glob('*.ipynb'):
print('Converting file:',fname)
with open(fname,'r') as f:
nb = read(f,u'json')
md = new_metadata()
if u'name' in nb:
md.name = nb.name
del nb[u'name']
nb.metadata = md
with open(fname,'w') as f:
write(nb, f, u'json')
Brian E. Granger
Full versioning added to nbformat.
r4406