iframe-proxy | Sunbelt Computer Software

221 lines (171 loc) · 6.07 KB
"""The official API for working with notebooks in the current format version.
* 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.
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
from __future__ import print_function
import json
from xml.etree import ElementTree as ET
from IPython.nbformat import v3
from IPython.nbformat import v2
from IPython.nbformat import v1
from IPython.nbformat.v3 import (
    NotebookNode,
    new_code_cell, new_text_cell, new_notebook, new_output, new_worksheet,
    parse_filename, new_metadata, new_author, new_heading_cell, nbformat,
    nbformat_minor,
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
current_nbformat = nbformat
current_nbformat_minor = nbformat_minor
class NBFormatError(Exception):
def parse_json(s, **kwargs):
    """Parse a string into a (nbformat, dict) tuple."""
    d = json.loads(s, **kwargs)
    nbf = d.get('nbformat', 1)
    nbm = d.get('nbformat_minor', 0)
    return nbf, nbm, d
def parse_py(s, **kwargs):
    """Parse a string into a (nbformat, string) tuple."""
    nbf = current_nbformat
    nbm = current_nbformat_minor
    pattern = r'# <nbformat>(?P<nbformat>\d+[\.\d+]*)</nbformat>'
    m = re.search(pattern,s)
    if m is not None:
        digits = m.group('nbformat').split('.')
        nbf = int(digits[0])
        if len(digits) > 1:
            nbm = int(digits[1])
    return nbf, nbm, s
def reads_json(s, **kwargs):
    """Read a JSON notebook from a string and return the NotebookNode object."""
    nbf, minor, d = parse_json(s, **kwargs)
    if nbf == 1:
        nb = v1.to_notebook_json(d, **kwargs)
        nb = v3.convert_to_this_nbformat(nb, orig_version=1)
    elif nbf == 2:
        nb = v2.to_notebook_json(d, **kwargs)
        nb = v3.convert_to_this_nbformat(nb, orig_version=2)
    elif nbf == 3:
        nb = v3.to_notebook_json(d, **kwargs)
        nb = v3.convert_to_this_nbformat(nb, orig_version=3, orig_minor=minor)
        raise NBFormatError('Unsupported JSON nbformat version: %i' % nbf)
    return nb
def writes_json(nb, **kwargs):
    return v3.writes_json(nb, **kwargs)
def reads_py(s, **kwargs):
    """Read a .py notebook from a string and return the NotebookNode object."""
    nbf, nbm, s = parse_py(s, **kwargs)
    if nbf == 2:
        nb = v2.to_notebook_py(s, **kwargs)
    elif nbf == 3:
        nb = v3.to_notebook_py(s, **kwargs)
        raise NBFormatError('Unsupported PY nbformat version: %i' % nbf)
    return nb
def writes_py(nb, **kwargs):
    return v3.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
    ----------
    s : unicode
        The raw unicode string to read the notebook from.
    format : (u'json', u'ipynb', u'py')
        The format that the string is in.
    Returns
    -------
    nb : NotebookNode
        The notebook that was read.
    format = unicode(format)
    if format == u'json' or format == u'ipynb':
        return reads_json(s, **kwargs)
    elif format == u'py':
        return reads_py(s, **kwargs)
        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.
    format : (u'json', u'ipynb', u'py')
        The format to write the notebook in.
    Returns
    -------
    s : unicode
        The notebook string.
    format = unicode(format)
    if format == u'json' or format == u'ipynb':
        return writes_json(nb, **kwargs)
    elif format == u'py':
        return writes_py(nb, **kwargs)
        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.
    format : (u'json', u'ipynb', u'py')
        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.
    format : (u'json', u'ipynb', u'py')
        The format to write the notebook in.
    Returns
    -------
    s : unicode
        The notebook string.
    return fp.write(writes(nb, format, **kwargs))
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')
Sunbelt Computer Software

PL/B Language Development and Support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sunbelt Computer Software

PL/B Language Development and Support

FilesExpand file tree

current.py

Latest commit

History

current.py

File metadata and controls
