first complete pass on v4

tests passing, notebooks validating

IPython/nbformat/v4/compose.py

@@ -0,0 +1,78 b''
+"""Python API for composing notebook elements
+
+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.
+"""
+
+# Copyright (c) IPython Development Team.
+# Distributed under the terms of the Modified BSD License.
+
+import pprint
+import uuid
+
+from IPython.utils.ipstruct import Struct
+from IPython.utils.py3compat import cast_unicode, unicode_type
+
+from .validator import isvalid, validate
+from .nbbase import nbformat, nbformat_minor, from_dict, NotebookNode
+
+def new_output(output_type, mime_bundle=None, **kwargs):
+    """Create a new output, to go in the ``cell.outputs`` list of a code cell."""
+    output = NotebookNode(output_type=output_type, **kwargs)
+    if mime_bundle:
+        output.update(mime_bundle)
+    # populate defaults:
+    output.setdefault('metadata', NotebookNode())
+    if output_type == 'stream':
+        output.setdefault('stream', 'stdout')
+        output.setdefault('text', '')
+    validate(output, output_type)
+    return output
+
+def new_code_cell(source='', **kwargs):
+    """Create a new code cell"""
+    cell = NotebookNode(cell_type='code', source=source, **kwargs)
+    cell.setdefault('metadata', NotebookNode())
+    cell.setdefault('source', '')
+    cell.setdefault('prompt_number', None)
+    cell.setdefault('outputs', [])
+
+    validate(cell, 'code_cell')
+    return cell
+
+def new_markdown_cell(source='', **kwargs):
+    """Create a new markdown cell"""
+    cell = NotebookNode(cell_type='markdown', source=source, **kwargs)
+    cell.setdefault('metadata', NotebookNode())
+
+    validate(cell, 'markdown_cell')
+    return cell
+
+def new_heading_cell(source='', **kwargs):
+    """Create a new heading cell"""
+    cell = NotebookNode(cell_type='heading', source=source, **kwargs)
+    cell.setdefault('metadata', NotebookNode())
+    cell.setdefault('level', 1)
+
+    validate(cell, 'heading_cell')
+    return cell
+
+def new_raw_cell(source='', **kwargs):
+    """Create a new raw cell"""
+    cell = NotebookNode(cell_type='raw', source=source, **kwargs)
+    cell.setdefault('metadata', NotebookNode())
+
+    validate(cell, 'raw_cell')
+    return cell
+
+def new_notebook(**kwargs):
+    """Create a new notebook"""
+    nb = NotebookNode(**kwargs)
+    nb.nbformat = nbformat
+    nb.nbformat_minor = nbformat_minor
+    nb.setdefault('cells', [])
+    nb.setdefault('metadata', NotebookNode())
+    validate(nb)
+    return nb

IPython/nbformat/v4/tests/test_compose.py

@@ -0,0 +1,105 b''
+# coding: utf-8
+"""Tests for the Python API for composing notebook elements"""
+
+import nose.tools as nt
+
+from ..validator import isvalid, validate, ValidationError
+from ..compose import (
+    NotebookNode, nbformat,
+    new_code_cell, new_heading_cell, new_markdown_cell, new_notebook,
+    new_output, new_raw_cell,
+)
+
+def test_empty_notebook():
+    nb = new_notebook()
+    nt.assert_equal(nb.cells, [])
+    nt.assert_equal(nb.metadata, NotebookNode())
+    nt.assert_equal(nb.nbformat, nbformat)
+
+def test_empty_markdown_cell():
+    cell = new_markdown_cell()
+    nt.assert_equal(cell.cell_type, 'markdown')
+    nt.assert_equal(cell.source, '')
+
+def test_markdown_cell():
+    cell = new_markdown_cell(u'* Søme markdown')
+    nt.assert_equal(cell.source, u'* Søme markdown')
+
+def test_empty_raw_cell():
+    cell = new_raw_cell()
+    nt.assert_equal(cell.cell_type, u'raw')
+    nt.assert_equal(cell.source, '')
+
+def test_raw_cell():
+    cell = new_raw_cell('hi')
+    nt.assert_equal(cell.source, u'hi')
+
+def test_empty_heading_cell():
+    cell = new_heading_cell()
+    nt.assert_equal(cell.cell_type, u'heading')
+    nt.assert_equal(cell.source, '')
+    nt.assert_equal(cell.level, 1)
+
+def test_heading_cell():
+    cell = new_heading_cell(u'hi', level=2)
+    nt.assert_equal(cell.source, u'hi')
+    nt.assert_equal(cell.level, 2)
+
+def test_empty_code_cell():
+    cell = new_code_cell('hi')
+    nt.assert_equal(cell.cell_type, 'code')
+    nt.assert_equal(cell.source, u'hi')
+
+def test_empty_display_data():
+    output = new_output('display_data')
+    nt.assert_equal(output.output_type, 'display_data')
+
+def test_empty_stream():
+    output = new_output('stream', stream='stdout', text='')
+    nt.assert_equal(output.output_type, 'stream')
+
+def test_empty_execute_result():
+    output = new_output('execute_result', prompt_number=1)
+    nt.assert_equal(output.output_type, 'execute_result')
+
+mimebundle = {
+    'text/plain': "some text",
+    "application/json": {
+        "key": "value"
+    },
+    "image/svg+xml": 'ABCDEF',
+    "application/octet-stream": 'ABC-123',
+    "application/vnd.foo+bar": "Some other stuff",
+}
+
+def test_display_data():
+    output = new_output('display_data', mimebundle)
+    for key, expected in mimebundle.items():
+        nt.assert_equal(output[key], expected)
+
+def test_execute_result():
+    output = new_output('execute_result', mimebundle, prompt_number=10)
+    nt.assert_equal(output.prompt_number, 10)
+    for key, expected in mimebundle.items():
+        nt.assert_equal(output[key], expected)
+
+def test_error():
+    o = new_output(output_type=u'error', ename=u'NameError',
+        evalue=u'Name not found', traceback=[u'frame 0', u'frame 1', u'frame 2']
+    )
+    nt.assert_equal(o.output_type, u'error')
+    nt.assert_equal(o.ename, u'NameError')
+    nt.assert_equal(o.evalue, u'Name not found')
+    nt.assert_equal(o.traceback, [u'frame 0', u'frame 1', u'frame 2'])
+
+def test_code_cell_with_outputs():
+    cell = new_code_cell(prompt_number=10, outputs=[
+        new_output('display_data', mimebundle),
+        new_output('stream', text='hello'),
+        new_output('execute_result', mimebundle, prompt_number=10),
+    ])
+    nt.assert_equal(cell.prompt_number, 10)
+    nt.assert_equal(len(cell.outputs), 3)
+    er = cell.outputs[-1]
+    nt.assert_equal(er.prompt_number, 10)
+    nt.assert_equal(er['output_type'], 'execute_result')

IPython/nbformat/v4/tests/test_validate.py

@@ -0,0 +1,126 b''
+"""Tests for nbformat validation"""
+
+# Copyright (c) IPython Development Team.
+# Distributed under the terms of the Modified BSD License.
+
+import io
+import os
+
+import nose.tools as nt
+
+from ..validator import isvalid, validate, ValidationError
+from ..nbjson import reads
+from ..compose import (
+    new_code_cell, new_heading_cell, new_markdown_cell, new_notebook,
+    new_output, new_raw_cell,
+)
+
+def test_valid_code_cell():
+    cell = new_code_cell()
+    validate(cell, 'code_cell')
+
+def test_invalid_code_cell():
+    cell = new_code_cell()
+
+    cell['source'] = 5
+    with nt.assert_raises(ValidationError):
+        validate(cell, 'code_cell')
+
+    cell = new_code_cell()
+    del cell['metadata']
+
+    with nt.assert_raises(ValidationError):
+        validate(cell, 'code_cell')
+
+    cell = new_code_cell()
+    del cell['source']
+
+    with nt.assert_raises(ValidationError):
+        validate(cell, 'code_cell')
+
+    cell = new_code_cell()
+    del cell['cell_type']
+
+    with nt.assert_raises(ValidationError):
+        validate(cell, 'code_cell')
+
+def test_invalid_markdown_cell():
+    cell = new_markdown_cell()
+
+    cell['source'] = 5
+    with nt.assert_raises(ValidationError):
+        validate(cell, 'markdown_cell')
+
+    cell = new_markdown_cell()
+    del cell['metadata']
+
+    with nt.assert_raises(ValidationError):
+        validate(cell, 'markdown_cell')
+
+    cell = new_markdown_cell()
+    del cell['source']
+
+    with nt.assert_raises(ValidationError):
+        validate(cell, 'markdown_cell')
+
+    cell = new_markdown_cell()
+    del cell['cell_type']
+
+    with nt.assert_raises(ValidationError):
+        validate(cell, 'markdown_cell')
+
+def test_invalid_heading_cell():
+    cell = new_heading_cell()
+
+    cell['source'] = 5
+    with nt.assert_raises(ValidationError):
+        validate(cell, 'heading_cell')
+
+    cell = new_heading_cell()
+    del cell['metadata']
+
+    with nt.assert_raises(ValidationError):
+        validate(cell, 'heading_cell')
+
+    cell = new_heading_cell()
+    del cell['source']
+
+    with nt.assert_raises(ValidationError):
+        validate(cell, 'heading_cell')
+
+    cell = new_heading_cell()
+    del cell['cell_type']
+
+    with nt.assert_raises(ValidationError):
+        validate(cell, 'heading_cell')
+
+def test_invalid_raw_cell():
+    cell = new_raw_cell()
+
+    cell['source'] = 5
+    with nt.assert_raises(ValidationError):
+        validate(cell, 'raw_cell')
+
+    cell = new_raw_cell()
+    del cell['metadata']
+
+    with nt.assert_raises(ValidationError):
+        validate(cell, 'raw_cell')
+
+    cell = new_raw_cell()
+    del cell['source']
+
+    with nt.assert_raises(ValidationError):
+        validate(cell, 'raw_cell')
+
+    cell = new_raw_cell()
+    del cell['cell_type']
+
+    with nt.assert_raises(ValidationError):
+        validate(cell, 'raw_cell')
+
+def test_sample_notebook():
+    here = os.path.dirname(__file__)
+    with io.open(os.path.join(here, "v4-test.ipynb"), encoding='utf-8') as f:
+        nb = reads(f.read())
+    validate(nb)

IPython/nbformat/v4/tests/v4-test.ipynb

@@ -0,0 +1,155 b''
+{
+    "metadata": {
+        "cell_tags": ["<None>", null],
+        "name": "",
+        "kernel_info": {
+            "name": "python",
+            "language": "python"
+        }
+    },
+    "nbformat": 4,
+    "nbformat_minor": 0,
+    "cells": [
+        {
+            "cell_type": "heading",
+            "level": 1,
+            "metadata": {},
+            "source": [
+                "nbconvert latex test"
+            ]
+        },
+        {
+            "cell_type": "markdown",
+            "metadata": {},
+            "source": [
+                "**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus bibendum felis dictum sodales. Ut suscipit, orci ut interdum imperdiet, purus ligula mollis *justo*, non malesuada nisl augue eget lorem. Donec bibendum, erat sit amet porttitor aliquam, urna lorem ornare libero, in vehicula diam diam ut ante. Nam non urna rhoncus, accumsan elit sit amet, mollis tellus. Vestibulum nec tellus metus. Vestibulum tempor, ligula et vehicula rhoncus, sapien turpis faucibus lorem, id dapibus turpis mauris ac orci. Sed volutpat vestibulum venenatis."
+            ]
+        },
+        {
+            "cell_type": "heading",
+            "level": 2,
+            "metadata": {},
+            "source": [
+                "Printed Using Python"
+            ]
+        },
+        {
+            "cell_type": "code",
+            "source": [
+                "print(\"hello\")"
+            ],
+            "metadata": {
+                "collapsed": false,
+                "autoscroll": false
+            },
+            "outputs": [
+                {
+                    "output_type": "stream",
+                    "metadata": {},
+                    "stream": "stdout",
+                    "text": [
+                        "hello\n"
+                    ]
+                }
+            ],
+            "prompt_number": 1
+        },
+        {
+            "cell_type": "heading",
+            "level": 2,
+            "metadata": {},
+            "source": [
+                "Pyout"
+            ]
+        },
+        {
+            "cell_type": "code",
+            "source": [
+                "from IPython.display import HTML\n",
+                "HTML(\"\"\"\n",
+                "<script>\n",
+                "console.log(\"hello\");\n",
+                "</script>\n",
+                "<b>HTML</b>\n",
+                "\"\"\")"
+            ],
+            "metadata": {
+                "collapsed": false,
+                "autoscroll": false
+            },
+            "outputs": [
+                {
+                    "text/html": [
+                        "\n",
+                        "<script>\n",
+                        "console.log(\"hello\");\n",
+                        "</script>\n",
+                        "<b>HTML</b>\n"
+                    ],
+                    "metadata": {},
+                    "output_type": "execute_result",
+                    "prompt_number": 3,
+                    "text/plain": [
+                        "<IPython.core.display.HTML at 0x1112757d0>"
+                    ]
+                }
+            ],
+            "prompt_number": 3
+        },
+        {
+            "cell_type": "code",
+            "source": [
+                "%%javascript\n",
+                "console.log(\"hi\");"
+            ],
+            "metadata": {
+                "collapsed": false,
+                "autoscroll": false
+            },
+            "outputs": [
+                {
+                    "text/javascript": [
+                        "console.log(\"hi\");"
+                    ],
+                    "metadata": {},
+                    "output_type": "display_data",
+                    "text/plain": [
+                        "<IPython.core.display.Javascript at 0x1112b4b50>"
+                    ]
+                }
+            ],
+            "prompt_number": 7
+        },
+        {
+            "cell_type": "heading",
+            "level": 3,
+            "metadata": {},
+            "source": [
+                "Image"
+            ]
+        },
+        {
+            "cell_type": "code",
+            "source": [
+                "from IPython.display import Image\n",
+                "Image(\"http://ipython.org/_static/IPy_header.png\")"
+            ],
+            "metadata": {
+                "collapsed": false,
+                "autoscroll": false
+            },
+            "outputs": [
+                {
+                    "metadata": {},
+                    "output_type": "execute_result",
+                    "image/png": "iVBORw0KGgoAAAANSUhEUgAAAggAAABDCAYAAAD5/P3lAAAABHNCSVQICAgIfAhkiAAAAAlwSFlz\nAAAH3AAAB9wBYvxo6AAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAACAASURB\nVHic7Z15uBxF1bjfugkJhCWBsCSAJGACNg4QCI3RT1lEAVE+UEBNOmwCDcjHT1wQgU+WD3dFxA1o\nCAikAZFFVlnCjizpsCUjHQjBIAkQlpCFJGS79fvjdGf69vTsc2fuza33eeaZmeqq6jM9vZw6dc4p\nBUwC+tE+fqW1fqmRDpRSHjCggS40sBxYDCxKvL8KzNBaL21EPoPB0DPIWVY/4NlE0ffzYfhgu+Qx\nGHoy/YFjaK+CcB3QkIIAHAWs3wRZsuhUSs0CXgQeBm7UWi/spn0Z+jA5yxpEfYruqnwYllRic5a1\nMaWv8U5gaT4M19Sx396IAnZLfB/SLkEMhp5O/3YL0AvoAHaKXl8HLlZK3QZcpbWe0lbJDOsaHuDU\n0e4u4JAy2wPk/C1JzrKWArOQ0fUtwH35MOysQxaDwbCO0NFuAXoh6wPjgQeUUvcqpUa0WyCDoQls\nCIwBjgfuAV7KWdY+7RWpmJxlXZezrEdylvXxdstiMKzrGAtCYxwI/EspdZbW+g/tFsbQ67kQuBHY\nFNgseh9FV6vCbUAeWBC9PgBeq2EfS6J2MQOBrRDTe5KdgAdzlvW1fBjeUUP/3UbOsoYBE6OvG7VT\nFoOhL9Af+BUwFLkZpV+DaY6V4UPkRpb1+ncT+m8nGwK/V0oN01qf025hDL2XfBi+DLycLMtZVo6u\nCsKfGnSq8/NheEpqHwOBEcDBwJnAsGhTP2ByzrJG5cPwnQb22Sy+0G4BDIa+RH+t9dmlNiqlFKIk\nJJWGi+jq5JPmq8BbJJQArfXqpkncczlbKbVQa/3rdgtiMNRCPgxXAK8Ar+Qs63LgXmDvaPPGwPeA\nH7VJvCRfbLcABkNfouwUg9ZaAwuj178BlFLvVejzgR4WFviM1npcuQpKqf6IyXIjxLS7GzAWuUnu\nXsO+fqWUellr3ZBJdq/jr9+BDn1uve07O9Rz0y6f8PtGZGgWe53oT6SBkZ/q1/nHZy47aloTRTKU\nIR+Gy3OWNR6Zxtg0Kv4KRkEwGPocxgcBiCwcsSI0F5iOhF+ilPok8C3gVGS+thK/VErdrbWuO2ys\ns/+aLZTuOKbe9krrIUCPUBB0B+PQ1P1bdKe6EzAKQgvJh+GbOct6gkJkxM45y+qXDIWMHBhjBWJe\nPgyDWvaRs6zPIVObAG/nw/DpEvUGAp8E9gGGJzbtl7Os7cvs4skqp0V0Yl8jgcOBjyMDhbmIZeWl\nfBg+UUVfReQsayhwELAnsAXi6/E28BxwTz4MP6iyn92RaSCA+/NhuCwqXx9R4MYhU0MfRTK/AjyW\nD8MFGd0ZDFVhFIQKaK3/BXxfKXUlklTq0xWafAI4Driyu2UzGLqRlygoCArYHJif2H4gcFb0+Z2c\nZW2bD8NV1XScs6yNgH8g/jsAPwCeTmzfFPgjYsnbiez71MUVdnMQcF8V4nyUs6whwB8QX4+0s2Ys\n0yPAt/NhGFbRZ/wbzgO+DaxXotqqnGX9GbigCkXhf5CBCsDngYdzljURGQhsWqLN+znL+iFwdT4M\ndYk6BkNJTJhjlWitQ2Bf4P4qqv848t8wGHor6Yd9+ruHJFkC2BI4rIa+D6egHKwmstYlGAxMQCwH\nrRjEPI5ER5S7ZvcFXsxZ1phKneUsawSi8HyH0soB0bbvAM9Ebaplt5xlnYkct1LKAYiFZhJwSQ19\nGwxrMRaEGtBar1RKfRX4JxIzXortou3PN1mE+YgJsSwaeoLHOQCqUy3QSr9eqZ6G/gq2aYVMhqrY\nOfF5FeJwvJZ8GM7JWdY/gC9HRS7wtyr7Pjrx+e6MqYC3KLbU7Qhck/h+FJIKvRRVjfSREXicU8EH\npgAvIIqLBZwGfC7avl5Uf29KkLOsTZCMq8npj9sQx89no37HIlaAODplNPBIzrJ2z4dhNVlaT0HC\nXwFmIkrAC4if2PaIz8/3KCgn385Z1pX5MJxeRd8Gw1qMglAjWutlSqnTgUcqVP0SzVYQtP5mcMXE\nSvvtUUy9YsK5QEWHy7EnTB6lOtSsFohkqEDOsgYAdqJoagkT9Z8pKAj75yzr4/kwnF2h748ho/GY\nq9J1oqiKLj4JOctKK8Yz8mH4Yrl9VcnHkXVYTsyHoZ8WJWdZNyPThbF5/3M5yzowH4alpi9+T0E5\nWA18Nx+Gf0zVeRG4KmdZ90R9bwCMRKwyX69C5h2j91uA4/JhuCSxbTYwJWdZtwNPIFbifsAFSISZ\nwVA1ZoqhDrTWjyIjjXIc3ApZDIZu4ELgY4nvt5Wody8wJ/qsgBOr6HsihfvOfCRrY7v5dYZyAECk\nGP0ISEZmZYZ55yxrB8SyEXNxhnKQ7Pt64H8TRUfmLGuXKmWeC4xPKQfJvp9CLCJlZTYYymEUhPq5\ntcL2XVsihcHQJHKWtU3Osi5GnAZj5iKWgiKitRouTxQdl7OscnPu0HV64dp8GLY7R8pyxEGxJPkw\nfBcZ9ceUSvN8IoV76upK/UZcgawcG3NKqYopfleFU+gDic/b5SzLWIwNNWFOmPqp5CG9sVJqPa11\nVZ7dBkOL2D1nWcmcBkOR8MFtgM/QdTXJZcCR+TBcXqa/SYj5egAFZ8VMX4ScZe2FRPnEXF2z9M3n\n3nwYVsrtAmK6/0z0uVR4ZXLtivvzYfhGpU7zYbgkZ1k3ACdHRQdWIQsUO3ZmkUzB3Q/xjaolLbeh\nj2MUhDrRWr+mlFpJ+eV5hyIxz4YWs98Fj/Rf8uZbozo0/ZYt7D8rf9ORK9stUw/hU9GrEnMAp1R+\ngph8GL4bzdNPiIpOorSzYtJ68FS1IYPdTLWp3hcnPm+Q3pizrA7E+TCmFn+aZN0dcpY1LB+G5e4b\ny6rM8bA49X39GmQyGMwUQ4NUGnkMrbDd0A3sdeLk4z6cN+89pTtDTWd+gyErF+7pTv5eu+XqJbyK\nTDHsmg/DJ6tsc2ni8+dzljUqXSGaevhmoqjIObFNVBzlV8kQug4W5tbQNl13WGatAv+poW+DoW6M\nBaExPgC2LrO9nHWhpSilDqI4NPMhrfXUJvS9M/DfqeJXtdY3N9p3rex50uQ9lFKT6BrTvoFCXbTX\nyZNfmnrZxHtbLVMP4xng74nvK5DzeD7wfIWRayb5MHwiZ1kzgF0oOCuemar2ZQoK8zLgr7Xup5t4\ns0n9DEl9b0RBSPeV5q0a+jYY6sYoCI1RacnZ91siRXUMAH6eKnsYicdulDOAY1NlpzWh35pRqG9R\nIuGN7uw4AfG878s8nw/DX3RDv5dScGY8NmdZP86HYXJaJzm9cHMp7/s2UHdK9BTpKaxBNbRN163k\nt9Rux05DH8FMMTTGZhW2v9sSKarjbopNk/sqpUY30qlSahCSGS/JCuD6RvqtF6UpMm/HaHTJbYaG\nmQzED/0umRVzlrUZhXwJ0HOmF5pJOlXyxzJrZbNt6rtZP8HQIzAKQp0opTZAlsItxTKtdTnv75YS\nLR7lpYqrjV0vx2EUH4fbtdZtucnpMqOrDjPy6jYii8DkRFHSYnAEhem22cBjrZKrVeTDcCldTf/p\nh345ksrEGprnF2EwNIRREOrnMxW2z2uJFLVxJcXmy2OVUo34ShydUda+EaIq7T2u0SZTY/eSdFY8\nMGdZm0efk86J6/LCQUnFp5pIkZjkcvQz8mH4YZPkMRgawigI9VNp7v7BlkhRA1rr+RQneNqC2hba\nWYtSajiS9z3JXLomaGktq/VllLIUdKqSWe0MjZMPwxlIel8Q/6Zv5CxrGIX8AJ10XU+hFtIRQ+UW\nKWoXyYyTu+Qsa79KDXKWNRpJyx5zZ9OlMhjqxCgIdaCU6g98o0K1npBCNotLM8rcOvuagCRgSXKN\n1rozq3IrCCZNfFkrfRjotWsCaJinUBODK51/tkuuPkTy/DoYOIDCfeb+fBjW4t2/lqhdcmRdbUri\nVnILXS2HZ1WRvfAcCk61K4A/dYdgBkM9GAWhPr5F6XSrIBf6Qy2SpSaidSReShV/XilV7veUIj29\noOkB2fGmXT7x7sCbOGpFf7VZx4A1m0/znG2nehMyc+0bms7NFJxzxwH7J7Y1OvWUPG9/mLOsLRvs\nr6lEaaOT0TtfBB5ITLWsJWdZg3KWdRNwTKL4wnwYzu9mMQ2GqjFhjjWilBqBpJYtx51a66UV6rST\nS+maJz52VvxRdvVilFK7UbzexGNa67Kr+bWS6X+ekPYs79HkLGt34JOI+Xyz6D2d1vfMnGUdini6\nL0C851/Oh2HD+SyaQT4MV+YsaxJyLm1Gwf9gAXBHg93/JNHHtsArOcuajCztPBDYCkkytBXg5sOw\n5QmF8mF4W86yLgK+HxXtC8zKWVaALMm8CslHsicS7RFzL8VhyAZDWzEKQg0opbYE7qd8prPVdF2h\nrSdyLfALYMNE2XFKqR/XsHbEURll62L4Wiv5PuBUqPPF6JXkLuCQbpGoPi4HfohYKGMHWD9axrlu\n8mF4Z7RuwfioaDBwaonqRemQW0U+DH+Qs6xFwHnIFNwQsv+3mMnA8dHiVwZDj8FMMVSJUuow4DkK\na7GX4gqt9cstEKlutNaL6boULMho5tBq2iul+lH8IFuCmJcNfZx8GM6hOCFVU5THfBhOQHxfylkH\n3gY+asb+6iUfhhcCewC3l5BlFbJk/P75MDwqlVTKYOgRKK1rizhSSk2h67ximo1abV5XSi2n9EIk\nz2itx5XYVqnfQcjI7DiqW2XtfeCTUbRA3ex50nWfUrqjeJEcrfcLrpj4SCN9xyilxgDPp4of0Fof\nUEXbg4B/pIqv1FrXnVNh7AmTR3V0qIwwRH1E4E28pd5+De0hZ1m/Bb4bfX0+H4Z7dMM+hgGjkDwC\nS5FpjFk9bR4/Z1mDkGmF4VHR20g4Y3oxJYOhR9EXphg6lFLlVjFbH0mZvDGwCTAayCFe0ntTOZ1y\nzDLgkEaVg1ahtX5BKfUU8OlE8ReUUjtorSstCduzch8YehSR5/6ERFG3nBvRuhE9frXUfBguA6pd\n+Mpg6DH0BQXBBro7o+Ea4Bta66e6eT/N5lK6KggKOAE4u1QDpdTGFOdNmNkLf7uh+zgYcRQEMa+3\nJe22wWBoDOOD0DhLgYla67vaLUgd3ETxglLHRXkeSnEExQ5gbQ9tNPQokis5TsqHoVlbwGDohRgF\noTECYHet9Y3tFqQetNYrKDb/DqN46eYk6emF1UhUhMFAzrImUEhDvgr4VRvFMRgMDWAUhPpYAvwf\n8Bmte31+/8uQBEdJMjMrKqW2o5A2N+YfWusePw9s6F5yltWRs6zxwKRE8RXtyEVgMBiaQ1/wQWgm\neWTe/jqtdU9Zz74htNavKaXuAw5KFB+glBqptZ6Tqj6RQlrYGDO90AfJWdY5wNeQFQwHIAmetk5U\neZFCsiCDwdALMQpCed5AphEC4NF12BHvUroqCAoJ7TwvVS+d++BdJEmPoe+xKRLnn0UeODwfhm3N\nRWAwGBqjLygIbwN/LbNdI1MGH6ReL/eWkMUmcDeSeGa7RNlRSqnzdZQoQym1C7Bzqt11NWReNKxb\nzEMU6GHAesBiYCaSLOviaF0Cg8HQi+kLCsLrWuvT2y1ET0ZrvUYp5SG57mO2Bz4LPB59/2ZRQ5P7\noM+SD8OLgYvbLYfBYOg+jJOiIeZKxOs8STJiIb28daC1/lf3imQwGAyGdmEUBAMA0XTKraniI5VS\nA6O0zOnloI31wGAwGNZhjIJgSHJp6vtgJBNlehW65cANLZHIYDAYDG3BKAiGtWitHwVeShV/muLF\nuW7VWi9qjVQGg8FgaAd9wUnRUBuXAn9IfN8f+FyqTo/OfbDnSX8brDpXnqEUe2ropzQvdtDx66ev\nGN9XolIMPQDb9T8LrBd4zsPtlsXQe7Bd/0BgQeA5QbtlMQqCIc21wC+ADaPv6WWu5wAPtVKgWtjt\n6Os2XG/9jhdQjIzTQ2rFF9bQecy4E2/I9UQlwXb9LYDDK1R7K/Cc21shj6FxbNcfDjwGKNv1Rwae\n83q7ZWo2tusPBb6ELGW9BbAICX99Gngs8Jx0hlZDBWzXHwvcC6ywXX9o4DlL2ymPURAMXdBaL1ZK\n+ZRItwz8Jc6N0BMZMFB9GxiZsWnzTjrPAH7QWomqYgTF/h9pngC6RUGwXf+XwC2B50ztjv57M7br\nXwJMCjxneo1NP0SWgAfJq7LOYLv+esAFwOkUL9wWM912/d0Dz+lsnWQ9A9v1BwEXAT8PPKfWVOML\nkPVt3kNWQm0rxgfBkEWph5UG/tJCOWqnQ40ttUkrvWcrRamWwHOmAZsguSfGAi9Hmy5AUhgPAz7f\nHfu2XX8k8ENgx+7ovzdju/4uwP9D/peaCDxnCbANsF3gOYubLVu7sF1/AHAHcBaiHDwI/C+ywNsE\n4KfA68BdfVE5iNgbOBmxqtRE4Dn/BoYDnwg8Z02zBasVY0EwFKG1fkEp9RTioJjkIa11zzaVarYq\nvVFt2TpBaiN6oCwB5tiu/2FUPCvwnLTTaLM5oJv77800dGwCz1kXHXkvRNKydwI/Cjzn1+kKtuuf\ni2TX7Ks0et681yxBGsUoCIZSBBQrCL0h98EbdW7rddiuPwoYFJu/bdffFNgL2BZ4DZgWKR5ZbRWS\n2+KIqGiE7fpjUtXmlrtZRdaHscBAYDowM/CckimWbdffFfgw8JzXou/9kfUccojV5MXAcz4s0XYw\nsCsymu8PzAVmBJ7zVqn9pdoPRVKF7wSsAN4EgqzRve36HcAoZDEqgO0zjs3rged8kGo3gOJ05ADT\ns0bTkan+k9HXGaVGjNFxykVf81nH2Hb9Ich/MRJJeT291H9fL7brj6CwANfPspQDgOi3rijRx/rI\nb8kB7wPPBZ4zL6Ne/JvfCDzn/WhufhvgvsBzVkR1dgN2AR4JPGduom38P7wXeM7c6FzfCfgU4iMR\nlFLebNfPIefXzMBzikz8tusPQyx676bljmTeCfhyVLST7frp//TV9Dluu/6GwOhUvTWB58zIkjFq\nsykyNfmfwHMW2K7fLzoWeyDTFPnAc14t1T7qYwNgT+Rc/wi5ZyT/N20UBEMRSqn+wNdTxQspTqTU\n41BaP6yVOipzGzzSYnG6m6uBz0YPv7OQm3dytc35tuuflHZutF3/BuArwEaJ4p/QNdU2wGnAH9M7\njRSTG5CbS5LQdv2joymTLKYBzwHjbNc/DomW2TCxfbXt+sMCz3k/sa8RwM+Qh/X6qf5W2q4/CTit\nzMN1OPB7CopQktW2658YeM5fEvXvRKZzBiXqZaWUPha4JlW2NfB8Rt0hiANfmjWIuf5jiLPfvVm/\nAfmvbgNmB54zKrkheuD+Bjg11Wap7fpnBJ5TybelFk4E+iE+Fb+ptbHt+scg//nGqfJbgeMDz1mY\nKN4UOZYX2q7fSWHhuNdt198ZOBc4MypbbLv+5wPPeTb6PiJqe5ft+ichx3WXRN8rbdc/OfCcrGis\nR4ChiHKSlSn2f4BzkOvitMRvCKJ9DEzU9TPafwGZlkkyBvExSrKUrtdnmoOBycA5tus/iCyat3li\nu7Zd/0rk2ihS1mzXPwT4E3LulaLTKAiGLL6EaMlJbtBat91pphIjFw289t9DVh4N7Jva9EKnWnpJ\nG0RqBXcjCa08YCqy/PJE4L8A33b9HQPPeTNR/0bgvujzGchoywPSq5U+nd6R7fp7IDfRjYDrEE99\nDeyHrPb5lO364xI36zTb2q4/AUnt/SSyLHQHMvJZklQOIhYChyCLid2FWBoGIQrDfwGnAP8Gskzd\nVvSbBgPvIMdpJjLHuxdikXgg1ewa4Jbo84+BHRAFI/3gT9/QQZa+/iIy9zwccVQrSeA5nbbrX4s8\ncI6htIIQK7xdFJLIAvEEYjmYBlyP/E4LeXj92Xb94YHnnFtOjhrYJ3q/vtbpE9v1fwqcjYxUL0GO\n51bI//g1YIzt+mNTSgJIivfNEIXgBOThfx0ySv8Nct7vgzgfj0+1HQf8E5iPKM/vI+vLHA9cZbs+\nJZSEevgDBZ++3yIKzgVI1FeSrCnD6ci0zebAJxCfjmoZjxzXPPBL5By0gW8jCt3sqHwtkYL1N0RB\n/R2ymOG2yHE5CLFAHAu8ahQEQxbfyijrDdML3HTTkWvUBRfsb88bPb6TzjEK+oHKL184YHL+Jmdl\nu+XrJsYBhwaec0dcYLu+hzw0dkcu/AvjbUmLgu36DqIgPB54zuQq9nURMgI8LjnyBibZrj8z2s/l\ntuvvVcJJbWvkXDoi8JzbKu0s8JxFtut/IqXgAPzOdv0/IiPnb5KhICAjpMGIEjAhPV1iu35HWsbA\nc25ObD8ZURAeqibENBqpTYnark8FBSHiakRBOMx2/cHpB29kSv4KooSlLRYnIcrBHcBXk7/Fdv0b\ngReAM23Xvz7wnJlVyFIJK3qfXUsj2/U/jiiiq4B9ktEytuv/Fhlpfx2xEnw31XxHYLfAc6bbrv8k\ncny/Bnwz8Jy/2q6/DTLd9F8Zu94ceXAeEHhOvM7MNbbrT0UU4vNs15+c2FY3gedcm/hNP0EUhDvL\nKMrJtkuIFPboWNWiIOSAO4HDE7/Dj67FSxEn21+m2pyOWDpuCDxn7fG2Xf8e4F1EIVsceE5oohgM\nXVBKjURuSEke11qXMhv3OPR553VO9Sb407yJZwTexO8FnnNV/qYj11XlAOCfSeUA1s4D/y36mp7f\nrAvb9fdGLDMzU8pBzMXIg2wsMhLKQiFhgxWVg5gM5SDm+uh9VHqD7fr7IlaNFcAJWb4UPcHLPvCc\n2YgVZn3gyIwq30AsQg8lQ+aiefUfR1/PzlB08sD9Udusfmsi2t+Q6GutjspnIE6L16dDaSN/irMR\np8dTbddPOxK/nwgxTZr8747e30SsEkNL7PvXGQrAVYgvwggK/gK9mXMyfuON0fvWkY9Dkp2i97uT\nhYHnLKNgURsDxknRUMz5FJ8XP22DHIbqSc9pxsSOW8ObtJ89ovdXbNcvpQC8j4zcdiTbnAoy4q2b\n6Ia3CYV5/Y0zqsXOf4/WEYveaq5GQuOOQaZekhydqJNkW2BLZF2UzhL/R+xE2XAIa+A52nb9lUho\nY63hd7GD5d1ZGwPPmW27/iuIUrkLXc/n9xP13rZd/yNgVezoF8n1NjAyyyKETGGl97fGdv1/IlaL\n3h7e+06WM2PgOQtt11+GTMcNo6vVJ1aWsyK+4nvFQjAKgiGBUmoshfnOmGe11vdl1Tf0GOaUKI9v\nlqrE9lqJb6b/Hb3KsU2Zba/VslPb9bdDfA0ORLz0N62iWWxVqMkc3iZuRuawP2u7/g6JKI9RSCTR\nYoodhOP/YgNKK2Ix2zZJzjnINMN2NbaL/4uiaIUE/0EUhB3pqiCkMwl2IscjXZZFJ/B2iW1xRtWR\nZWTqDcwps63U9f8Q0TSN7fp/iK0PtuvviPjmrCHyR1qrICilNkTmHjZDLsDke/JzOtwnzY1KqXcR\nR4cFiBab9XlRT87I19dQSo1GNPz0tJOxHvR8mhrOVobB0XuAOBiWo1zmwaqdXW3X3x+4BzGVv4SM\npN9AnPEg21McxMIArTs2dRN4zoe26/8NOA6xGJwfbYqV9b8GnrM81Sz+Lz5A0qOXo2y4Ww3MoT4F\nIY4+KTfNF58TaXN4VthstVNDitLKcdxvOjKmEj0tv0M953fs87E3Eul0B2JliBflOzfwnFcA+iul\n5iEmwQFNEBaK569L0amUWggcqrXO8gg2FKHG2CdW4Uem9XvBlUflu7RUaiByU3lPa92ZKN8cSav8\nfUQBTHKr1rrqueIsxp18/eg1azrLjSYB6NfRsY3G6Is9nDjDYxh4zundvbMotvtm5N50duA5P09t\nT0faJIkfirU+zNrF1YiC4FBQECZE73/JqB//F+u14r+ImIVEOB1iu/6ZNfhwzEamp7YuU2e7RN1m\noZBnW5YVIfZ1qNWfotw51yuIph++hET0bAkcikwpTAEuCjxnSly3PzIP0a8NcnYgD6SBlSoaIhQX\nV2UtVup24LBU6S7IyG+NUuodZP52awojrTSvIjeshlij9XdQKh2jXYRRDtpGfOCruQfEpmzbdn0V\ndP9iPLsgjnEryI67Lzd/PCt6/5Tt+v3LJXAqQ/z7ut2ZO/Ccx23XfxUYZbt+7D8xCngl8Jwsa80s\nZBS8ke36O7cg4ybA5UgegJ0QE/XN5auvZRaiIMQRF12wXX8TCv9ls6eERpOtIMR+EXNS5YsRh8dS\nTo/V+CzUck21i6uR5++4wHNeKFXJRDH0PfoR5fqmtHKwDDhCa73O5JA3lCSeF04v6Z3FPRTMzBO7\nS6AE8Q12PbomgYn5Xpm29yMPhu2RUK96iKMn9q6zfa38JXo/NHoly7oQeM5K4Iro60+jKINuJVJC\nYu/439uuX805A4VkWyfbrp+V/MdFnOmeCmpfFKsSRYMc2/U/DeyG3OfSjpOx5WmfVHmcuXFcFfus\n5ZpqObbrb45EtswqpxyAcVI0FDMbOFxrXeT9a+heopvnEArzolvashT0wmbEapdgGpIU5XDb9R9F\nYqrXQyyL8wPPeTeuGHjOMtv1T0VuqldH6W//jigNmyHOcAcBgwPPcZog20xkRLcJ8DPb9S9CRqM7\nI7kDvoDE1hfdxwLPWWy7/plI7oCLbNffHXm4zUQeRtsjGRP/EXhOKSfcABkpj49i5+9G/putgHmB\n5yxIN4iSF21C14V6Rtiu/yYSW15uHv4a4P8oKAedlPcvOAv4KmItfCTKKfAS8v8NR1ILHwnsl5GA\nqF7ORdYaGA48HGWyfBqYgViDRwCfQR72PkDgOU9E2TvHI4m0TgeeRczb30DyH2iKcyA0ymrgWNv1\nFyDK1NvIQ3tStN3LCH+9HUl29UPb9echFo8BUbtLEKfJtJ9EmgA59ifbrj8bCR3cGDlvZqdTLcPa\n9NCbUMhs2GFLKvPFSAKxZl7/CxEL8pgoA+QMxD+kE3HenAHcHnjOGmNB6Dt8iGjHWSFKK4HHkcQr\nOxvloLXYrr+77fqrEIejNyiE6P0WccZbabv+lFLtG+Ry5AY/BHkYfRDtR9M79QAAA3FJREFUcwYS\nNdCFwHPuQR6a7wHfAR5GMhk+i9xcT6G6KIOKBJ6zFBn9r0GUmBlIWN9ziHf/5yjO/phsfy2yqt4i\nxOJxF3INTI9k/Q7ZoV4xv0PC5LZCci4sQm6g08kYHdquvxy5lt4DwsSmF5EENCts1//Idv3M9LbR\negJTkEx4NvBA1joFifqLIjkeR6wcfwdeQfIFTEEcjHNU79RXkShvw95Ixs5+yOj/KuSh+ATiAHcq\nxb4fxwOXRfJMQc6zlxGF6B3g4MBznmmWnBFzEUfP0xDFcCGiAG+JHKushESXIdanjRBF4l3EInAj\n8vuOqWK/5yNRGaOQFNkfIhkOX6CQgwAA2/W3jkI3V0T7ejjatAFyXb2PXP/LbVnroWGi6bbzo697\nIlaWk5Br93wkk+jztusP7o94Lna7eaoMZU0cVXIAped7eqGZfP2ZqmPFl+ptrVf3n19UpvVMYLRS\nagBywxuEjLwWAe9qrTMXV2mUzs7OP/Xrp+6qt33Hmn5Zue3XNeZTOVoky5nqKiQkrNT883Qk3WvJ\nsMLAc1bbrv9Z5AH6KWRkOB+5wRWlWo7a3Ga7/mOIomAho/GFyI30YeDREru7ELlOq07TG3jONbbr\nT0Nu9KOQm+i/gFsDz3nTdv2fI2FbpdpfHnlpH4LcnHdAlIz5yLErqXgFnvOR7fo28lDYE7lu3kKO\nTdZ9K52xrhTl7knnUVB6SqVeTsr4apQU6lDEbG4hCsFbROsRBE1ebjrwnNB2/XGIGf5gRBkYhPyv\n7yDpjR9MtVkOnGK7/vWIgrFrVPcF4O8ZKbaXIuduWkH6KfL/JbkEsWClfWK2CDzHt10/jzhXjkGO\nyzNIZEiRD00ga3ocaLv+kUh2xo8hSuVURKmIUyiXVGYCWVzKQlJD7xrJNg85b9LX8RLgF6X6SpFU\n9Cpe28gaJgORqEEAbNffDLlvHIQoAndR8NEYilwjExD/nwuUiTQ0GAwGw7qC7fqjEUvKqsBzmhWd\nt05gu/5pyNoifw48J9N5PForxQeeNFMMBoPBYDD0DWL/llvK1In9jt4zCoLBYDAYDH2DePo5MwrJ\ndv0hFPwTnjBRDAaDwWAw9A3+hPgOHRPl25iK+FhsiuR4OARx0Lwf+J1REAwGg8Fg6AMEnvNklL78\nHMRRca/E5hVINNIVwI2B56z6/3ExLRI31pXNAAAAAElFTkSuQmCC\n",
+                    "prompt_number": 6,
+                    "text/plain": [
+                        "<IPython.core.display.Image at 0x111275490>"
+                    ]
+                }
+            ],
+            "prompt_number": 6
+        }
+    ]
+}

IPython/nbformat/v4/__init__.py

@@ -1,74 +1,22 b''
-"""The main API for the v3 notebook format.
+"""The main API for the v4 notebook format."""
 
-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
-#-----------------------------------------------------------------------------
+# Copyright (c) IPython Development Team.
+# Distributed under the terms of the Modified BSD License.
 
 from .nbbase import (
     NotebookNode,
-    new_code_cell, new_text_cell, new_notebook, new_output, new_worksheet,
-    new_metadata, new_author, new_heading_cell, nbformat, nbformat_minor,
-    nbformat_schema
+    nbformat, nbformat_minor, nbformat_schema,
+)
+
+from .compose import (
+    new_code_cell, new_heading_cell, new_markdown_cell, new_notebook,
+    new_output,
 )
 
 from .nbjson import reads as reads_json, writes as writes_json
 from .nbjson import reads as read_json, writes as write_json
 from .nbjson import to_notebook as to_notebook_json
 
-from .nbpy import reads as reads_py, writes as writes_py
-from .nbpy import reads as read_py, writes as write_py
-from .nbpy import to_notebook as to_notebook_py
-
 from .convert import downgrade, upgrade
 
-#-----------------------------------------------------------------------------
-# Code
-#-----------------------------------------------------------------------------
-
-def parse_filename(fname):
-    """Parse a notebook filename.
-
-    This function takes a notebook filename and returns the notebook
-    format (json/py) and the notebook name. This logic can be
-    summarized as follows:
-
-    * notebook.ipynb -> (notebook.ipynb, notebook, json)
-    * notebook.json  -> (notebook.json, notebook, json)
-    * notebook.py    -> (notebook.py, notebook, py)
-    * notebook       -> (notebook.ipynb, notebook, json)
-
-    Parameters
-    ----------
-    fname : unicode
-        The notebook filename. The filename can use a specific filename
-        extention (.ipynb, .json, .py) or none, in which case .ipynb will
-        be assumed.
 
-    Returns
-    -------
-    (fname, name, format) : (unicode, unicode, unicode)
-        The filename, notebook name and format.
-    """
-    if fname.endswith(u'.ipynb'):
-        format = u'json'
-    elif fname.endswith(u'.json'):
-        format = u'json'
-    elif fname.endswith(u'.py'):
-        format = u'py'
-    else:
-        fname = fname + u'.ipynb'
-        format = u'json'
-    name = fname.split('.')[0]
-    return fname, name, format

IPython/nbformat/v4/convert.py

@@ -1,36 +1,20 b''
-"""Code for converting notebooks to and from the v2 format.
+"""Code for converting notebooks to and from v3."""
 
-Authors:
-
-* Brian Granger
-* Min RK
-* Jonathan Frederic
-"""
-
-#-----------------------------------------------------------------------------
-#  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
-#-----------------------------------------------------------------------------
+# Copyright (c) IPython Development Team.
+# Distributed under the terms of the Modified BSD License.
 
 from .nbbase import (
-    new_code_cell, new_text_cell, new_worksheet, new_notebook, new_output,
-    nbformat, nbformat_minor
+    nbformat, nbformat_minor,
 )
 
-from IPython.nbformat import v2
+from IPython.nbformat import v3
 
 #-----------------------------------------------------------------------------
 # Code
 #-----------------------------------------------------------------------------
 
-def upgrade(nb, from_version=2, from_minor=0):
-    """Convert a notebook to v3.
+def upgrade(nb, from_version=3, from_minor=0):
+    """Convert a notebook to v4.
 
     Parameters
     ----------
@@ -41,50 +25,135 b' def upgrade(nb, from_version=2, from_minor=0):'
     from_minor : int
         The original minor version of the notebook to convert (only relevant for v >= 3).
     """
-    if from_version == 2:
+    if from_version == 3:
         # Mark the original nbformat so consumers know it has been converted.
         nb.nbformat = nbformat
         nb.nbformat_minor = nbformat_minor
 
-        nb.orig_nbformat = 2
+        nb.orig_nbformat = 3
+        # remove worksheet(s)
+        nb['cells'] = cells = []
+        # In the unlikely event of multiple worksheets,
+        # they will be flattened
+        for ws in nb.pop('worksheets', []):
+            # upgrade each cell
+            for cell in ws['cells']:
+                cells.append(upgrade_cell(cell))
+        # upgrade metadata?
+        nb.metadata.pop('name', '')
         return nb
-    elif from_version == 3:
+    elif from_version == 4:
+        # nothing to do
         if from_minor != nbformat_minor:
             nb.orig_nbformat_minor = from_minor
         nb.nbformat_minor = nbformat_minor
         return nb
     else:
-        raise ValueError('Cannot convert a notebook directly from v%s to v3.  ' \
+        raise ValueError('Cannot convert a notebook directly from v%s to v4.  ' \
                 'Try using the IPython.nbformat.convert module.' % from_version)
 
+def upgrade_cell(cell):
+    """upgrade a cell from v3 to v4
 
-def heading_to_md(cell):
-    """turn heading cell into corresponding markdown"""
-    cell.cell_type = "markdown"
-    level = cell.pop('level', 1)
-    cell.source = '#'*level + ' ' + cell.source
-
-
-def raw_to_md(cell):
-    """let raw passthrough as markdown"""
-    cell.cell_type = "markdown"
-
+    code cell:
+        - remove language metadata
+        - cell.input -> cell.source
+        - update outputs
+    """
+    if cell.cell_type == 'code':
+        cell.metadata.pop('language', '')
+        cell.source = cell.pop('input')
+        cell.outputs = upgrade_outputs(cell)
+    return cell
+
+def downgrade_cell(cell):
+    if cell.cell_type == 'code':
+        cell.input = cell.pop('source')
+        cell.outputs = downgrade_outputs(cell)
+    return cell
+
+_mime_map = {
+    "text" : "text/plain",
+    "html" : "text/html",
+    "svg" : "image/svg+xml",
+    "png" : "image/png",
+    "jpeg" : "image/jpeg",
+    "latex" : "text/latex",
+    "json" : "application/json",
+    "javascript" : "application/javascript",
+};
+
+def to_mime_key(d):
+    """convert dict with v3 aliases to plain mime-type keys"""
+    for alias, mime in _mime_map.items():
+        if alias in d:
+            d[mime] = d.pop(alias)
+    return d
+
+def from_mime_key(d):
+    """convert dict with mime-type keys to v3 aliases"""
+    for alias, mime in _mime_map.items():
+        if mime in d:
+            d[alias] = d.pop(mime)
+    return d
+
+def upgrade_output(output):
+    """upgrade a single code cell output from v3 to v4
+
+    - pyout -> execute_result
+    - pyerr -> error
+    - mime-type keys
+    """
+    if output['output_type'] == 'pyout':
+        output['output_type'] = 'execute_result'
+        to_mime_key(output)
+        to_mime_key(output.get('metadata', {}))
+    elif output['output_type'] == 'pyerr':
+        output['output_type'] = 'error'
+    elif output['output_type'] == 'display_data':
+        to_mime_key(output)
+        to_mime_key(output.get('metadata', {}))
+    return output
+
+def downgrade_output(output):
+    """downgrade a single code cell output to v3 from v4
+
+    - pyout <- execute_result
+    - pyerr <- error
+    - un-mime-type keys
+    """
+    if output['output_type'] == 'execute_result':
+        output['output_type'] = 'pyout'
+        from_mime_key(output)
+        from_mime_key(output.get('metadata', {}))
+    elif output['output_type'] == 'error':
+        output['output_type'] = 'pyerr'
+    elif output['output_type'] == 'display_data':
+        from_mime_key(output)
+        from_mime_key(output.get('metadata', {}))
+    return output
+
+def upgrade_outputs(outputs):
+    """upgrade outputs of a code cell from v3 to v4"""
+    return [upgrade_output(op) for op in outputs]
+
+def downgrade_outputs(outputs):
+    """downgrade outputs of a code cell to v3 from v4"""
+    return [downgrade_output(op) for op in outputs]
 
 def downgrade(nb):
-    """Convert a v3 notebook to v2.
+    """Convert a v4 notebook to v3.
 
     Parameters
     ----------
     nb : NotebookNode
         The Python representation of the notebook to convert.
     """
-    if nb.nbformat != 3:
+    if nb.nbformat != 4:
         return nb
-    nb.nbformat = 2
-    for ws in nb.worksheets:
-        for cell in ws.cells:
-            if cell.cell_type == 'heading':
-                heading_to_md(cell)
-            elif cell.cell_type == 'raw':
-                raw_to_md(cell)
+    nb.nbformat = v3.nbformat
+    nb.nbformat_minor = v3.nbformat_minor
+    cells = [ downgrade_cell(cell) for cell in nb.cells ]
+    nb.worksheets = [v3.new_worksheet(cells=cells)]
+    nb.metadata.setdefault('name', '')
     return nb
  No newline at end of file

IPython/nbformat/v4/nbbase.py

@@ -15,14 +15,11 b' import uuid'
 from IPython.utils.ipstruct import Struct
 from IPython.utils.py3compat import cast_unicode, unicode_type
 
-#-----------------------------------------------------------------------------
-# Code
-#-----------------------------------------------------------------------------
 
 # Change this when incrementing the nbformat version
-nbformat = 3
+nbformat = 4
 nbformat_minor = 0
-nbformat_schema = 'v3.withref.json'
+nbformat_schema = 'v4.withref.json'
 
 class NotebookNode(Struct):
     pass
@@ -39,166 +36,3 b' def from_dict(d):'
     else:
         return d
 
-
-def 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.
-    """
-    output = NotebookNode()
-    output.output_type = unicode_type(output_type)
-
-    if metadata is None:
-        metadata = {}
-    if not isinstance(metadata, dict):
-        raise TypeError("metadata must be dict")
-    output.metadata = metadata
-
-    if output_type != 'pyerr':
-        if output_text is not None:
-            output.text = cast_unicode(output_text)
-        if output_png is not None:
-            output.png = cast_unicode(output_png)
-        if output_jpeg is not None:
-            output.jpeg = cast_unicode(output_jpeg)
-        if output_html is not None:
-            output.html = cast_unicode(output_html)
-        if output_svg is not None:
-            output.svg = cast_unicode(output_svg)
-        if output_latex is not None:
-            output.latex = cast_unicode(output_latex)
-        if output_json is not None:
-            output.json = cast_unicode(output_json)
-        if output_javascript is not None:
-            output.javascript = cast_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 ename is not None:
-            output.ename = cast_unicode(ename)
-        if evalue is not None:
-            output.evalue = cast_unicode(evalue)
-        if traceback is not None:
-            output.traceback = [cast_unicode(frame) for frame in list(traceback)]
-
-    if output_type == u'stream':
-        output.stream = 'stdout' if stream is None else cast_unicode(stream)
-
-    return output
-
-
-def 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"""
-    cell = NotebookNode()
-    cell.cell_type = u'code'
-    if language is not None:
-        cell.language = cast_unicode(language)
-    if input is not None:
-        cell.input = cast_unicode(input)
-    if prompt_number is not None:
-        cell.prompt_number = int(prompt_number)
-    if outputs is None:
-        cell.outputs = []
-    else:
-        cell.outputs = outputs
-    if collapsed is not None:
-        cell.collapsed = bool(collapsed)
-    cell.metadata = NotebookNode(metadata or {})
-
-    return cell
-
-def new_text_cell(cell_type, source=None, rendered=None, metadata=None):
-    """Create a new text cell."""
-    cell = NotebookNode()
-    # VERSIONHACK: plaintext -> raw
-    # handle never-released plaintext name for raw cells
-    if cell_type == 'plaintext':
-        cell_type = 'raw'
-    if source is not None:
-        cell.source = cast_unicode(source)
-    if rendered is not None:
-        cell.rendered = cast_unicode(rendered)
-    cell.metadata = NotebookNode(metadata or {})
-    cell.cell_type = cell_type
-    return cell
-
-
-def new_heading_cell(source=None, rendered=None, level=1, metadata=None):
-    """Create a new section cell with a given integer level."""
-    cell = NotebookNode()
-    cell.cell_type = u'heading'
-    if source is not None:
-        cell.source = cast_unicode(source)
-    if rendered is not None:
-        cell.rendered = cast_unicode(rendered)
-    cell.level = int(level)
-    cell.metadata = NotebookNode(metadata or {})
-    return cell
-
-
-def new_worksheet(name=None, cells=None, metadata=None):
-    """Create a worksheet by name with with a list of cells."""
-    ws = NotebookNode()
-    if name is not None:
-        ws.name = cast_unicode(name)
-    if cells is None:
-        ws.cells = []
-    else:
-        ws.cells = list(cells)
-    ws.metadata = NotebookNode(metadata or {})
-    return ws
-
-
-def new_notebook(name=None, metadata=None, worksheets=None):
-    """Create a notebook by name, id and a list of worksheets."""
-    nb = NotebookNode()
-    nb.nbformat = nbformat
-    nb.nbformat_minor = nbformat_minor
-    if worksheets is None:
-        nb.worksheets = []
-    else:
-        nb.worksheets = list(worksheets)
-    if metadata is None:
-        nb.metadata = new_metadata()
-    else:
-        nb.metadata = NotebookNode(metadata)
-    if name is not None:
-        nb.metadata.name = cast_unicode(name)
-    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 = cast_unicode(name)
-    if authors is not None:
-        metadata.authors = list(authors)
-    if created is not None:
-        metadata.created = cast_unicode(created)
-    if modified is not None:
-        metadata.modified = cast_unicode(modified)
-    if license is not None:
-        metadata.license = cast_unicode(license)
-    if gistid is not None:
-        metadata.gistid = cast_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 = cast_unicode(name)
-    if email is not None:
-        author.email = cast_unicode(email)
-    if affiliation is not None:
-        author.affiliation = cast_unicode(affiliation)
-    if url is not None:
-        author.url = cast_unicode(url)
-    return author

IPython/nbformat/v4/nbjson.py

@@ -1,34 +1,18 b''
-"""Read and write notebooks in JSON format.
+"""Read and write notebooks in JSON format."""
 
-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
-#-----------------------------------------------------------------------------
+# Copyright (c) IPython Development Team.
+# Distributed under the terms of the Modified BSD License.
 
 import copy
 import json
 
+from IPython.utils import py3compat
+
 from .nbbase import from_dict
 from .rwbase import (
-    NotebookReader, NotebookWriter, restore_bytes, rejoin_lines, split_lines
+    NotebookReader, NotebookWriter, rejoin_lines, split_lines
 )
 
-from IPython.utils import py3compat
-
-#-----------------------------------------------------------------------------
-# Code
-#-----------------------------------------------------------------------------
 
 class BytesEncoder(json.JSONEncoder):
     """A JSON encoder that accepts b64 (and other *ascii*) bytestrings."""

IPython/nbformat/v4/rwbase.py

@@ -1,51 +1,19 b''
-"""Base classes and utilities for readers and writers.
+"""Base classes and utilities for readers and writers."""
 
-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
-#-----------------------------------------------------------------------------
-
-from base64 import encodestring, decodestring
-import pprint
+# Copyright (c) IPython Development Team.
+# Distributed under the terms of the Modified BSD License.
 
 from IPython.utils import py3compat
-from IPython.utils.py3compat import str_to_bytes, unicode_type, string_types
-
-#-----------------------------------------------------------------------------
-# Code
-#-----------------------------------------------------------------------------
-
-def restore_bytes(nb):
-    """Restore bytes of image data from unicode-only formats.
-
-    Base64 encoding is handled elsewhere.  Bytes objects in the notebook are
-    always b64-encoded. We DO NOT encode/decode around file formats.
-
-    Note: this is never used
-    """
-    for ws in nb.worksheets:
-        for cell in ws.cells:
-            if cell.cell_type == 'code':
-                for output in cell.outputs:
-                    if 'png' in output:
-                        output.png = str_to_bytes(output.png, 'ascii')
-                    if 'jpeg' in output:
-                        output.jpeg = str_to_bytes(output.jpeg, 'ascii')
-    return nb
+from IPython.utils.py3compat import unicode_type, string_types
 
 # output keys that are likely to have multiline values
-_multiline_outputs = ['text', 'html', 'svg', 'latex', 'javascript', 'json']
+_multiline_outputs = {
+    'text/plain',
+    'text/html',
+    'image/svg+xml',
+    'text/latex',
+    'application/javascript',
+}
 
 
 # FIXME: workaround for old splitlines()
@@ -73,21 +41,15 b' def rejoin_lines(nb):'
 
     Used when reading JSON files that may have been passed through split_lines.
     """
-    for ws in nb.worksheets:
-        for cell in ws.cells:
-            if cell.cell_type == 'code':
-                if 'input' in cell and isinstance(cell.input, list):
-                    cell.input = _join_lines(cell.input)
-                for output in cell.outputs:
-                    for key in _multiline_outputs:
-                        item = output.get(key, None)
-                        if isinstance(item, list):
-                            output[key] = _join_lines(item)
-            else: # text, heading cell
-                for key in ['source', 'rendered']:
-                    item = cell.get(key, None)
+    for cell in nb.cells:
+        if 'source' in cell and isinstance(cell.source, list):
+            cell.source = _join_lines(cell.source)
+        if cell.cell_type == 'code':
+            for output in cell.outputs:
+                for key in _multiline_outputs:
+                    item = output.get(key, None)
                     if isinstance(item, list):
-                        cell[key] = _join_lines(item)
+                        output[key] = _join_lines(item)
     return nb
 
 
@@ -99,61 +61,17 b' def split_lines(nb):'
 
     Used when writing JSON files.
     """
-    for ws in nb.worksheets:
-        for cell in ws.cells:
-            if cell.cell_type == 'code':
-                if 'input' in cell and isinstance(cell.input, string_types):
-                    cell.input = cell.input.splitlines(True)
-                for output in cell.outputs:
-                    for key in _multiline_outputs:
-                        item = output.get(key, None)
-                        if isinstance(item, string_types):
-                            output[key] = item.splitlines(True)
-            else: # text, heading cell
-                for key in ['source', 'rendered']:
-                    item = cell.get(key, None)
+    for cell in nb.cells:
+        source = cell.get('source', None)
+        if isinstance(source, string_types):
+            cell['source'] = source.splitlines(True)
+
+        if cell.cell_type == 'code':
+            for output in cell.outputs:
+                for key in _multiline_outputs:
+                    item = output.get(key, None)
                     if isinstance(item, string_types):
-                        cell[key] = item.splitlines(True)
-    return nb
-
-# b64 encode/decode are never actually used, because all bytes objects in
-# the notebook are already b64-encoded, and we don't need/want to double-encode
-
-def base64_decode(nb):
-    """Restore all bytes objects in the notebook from base64-encoded strings.
-
-    Note: This is never used
-    """
-    for ws in nb.worksheets:
-        for cell in ws.cells:
-            if cell.cell_type == 'code':
-                for output in cell.outputs:
-                    if 'png' in output:
-                        if isinstance(output.png, unicode_type):
-                            output.png = output.png.encode('ascii')
-                        output.png = decodestring(output.png)
-                    if 'jpeg' in output:
-                        if isinstance(output.jpeg, unicode_type):
-                            output.jpeg = output.jpeg.encode('ascii')
-                        output.jpeg = decodestring(output.jpeg)
-    return nb
-
-
-def base64_encode(nb):
-    """Base64 encode all bytes objects in the notebook.
-
-    These will be b64-encoded unicode strings
-
-    Note: This is never used
-    """
-    for ws in nb.worksheets:
-        for cell in ws.cells:
-            if cell.cell_type == 'code':
-                for output in cell.outputs:
-                    if 'png' in output:
-                        output.png = encodestring(output.png).decode('ascii')
-                    if 'jpeg' in output:
-                        output.jpeg = encodestring(output.jpeg).decode('ascii')
+                        output[key] = item.splitlines(True)
     return nb
 
 

IPython/nbformat/v4/tests/formattest.py

@@ -6,13 +6,7 b' import tempfile'
 
 pjoin = os.path.join
 
-from ..nbbase import (
-    NotebookNode,
-    new_code_cell, new_text_cell, new_worksheet, new_notebook
-)
-
-from ..nbpy import reads, writes, read, write
-from .nbexamples import nb0, nb0_py
+from .nbexamples import nb0
 
 
 def open_utf8(fname, mode):

IPython/nbformat/v4/tests/nbexamples.py

@@ -3,150 +3,103 b''
 import os
 from base64 import encodestring
 
-from ..nbbase import (
-    NotebookNode,
-    new_code_cell, new_text_cell, new_worksheet, new_notebook, new_output,
-    new_metadata, new_author, new_heading_cell, nbformat, nbformat_minor
+from ..compose import (
+    new_code_cell, new_heading_cell, new_markdown_cell, new_notebook,
+    new_output, new_raw_cell
 )
 
 # some random base64-encoded *text*
 png = encodestring(os.urandom(5)).decode('ascii')
 jpeg = encodestring(os.urandom(6)).decode('ascii')
 
-ws = new_worksheet(name='worksheet1')
-
-ws.cells.append(new_text_cell(
-    u'html',
+cells = []
+cells.append(new_markdown_cell(
     source='Some NumPy Examples',
-    rendered='Some NumPy Examples'
 ))
 
 
-ws.cells.append(new_code_cell(
-    input='import numpy',
+cells.append(new_code_cell(
+    source='import numpy',
     prompt_number=1,
-    collapsed=False
 ))
 
-ws.cells.append(new_text_cell(
-    u'markdown',
+cells.append(new_markdown_cell(
     source='A random array',
-    rendered='A random array'
 ))
 
-ws.cells.append(new_text_cell(
-    u'raw',
+cells.append(new_raw_cell(
     source='A random array',
 ))
 
-ws.cells.append(new_heading_cell(
-    u'My Heading',
-    level=2
+cells.append(new_heading_cell(
+    source=u'My Heading',
+    level=2,
 ))
 
-ws.cells.append(new_code_cell(
-    input='a = numpy.random.rand(100)',
+cells.append(new_code_cell(
+    source='a = numpy.random.rand(100)',
     prompt_number=2,
-    collapsed=True
 ))
-ws.cells.append(new_code_cell(
-    input='a = 10\nb = 5\n',
+cells.append(new_code_cell(
+    source='a = 10\nb = 5\n',
     prompt_number=3,
 ))
-ws.cells.append(new_code_cell(
-    input='a = 10\nb = 5',
+cells.append(new_code_cell(
+    source='a = 10\nb = 5',
     prompt_number=4,
 ))
 
-ws.cells.append(new_code_cell(
-    input=u'print "ünîcødé"',
+cells.append(new_code_cell(
+    source=u'print "ünîcødé"',
     prompt_number=3,
-    collapsed=False,
     outputs=[new_output(
-        output_type=u'pyout',
-        output_text=u'<array a>',
-        output_html=u'The HTML rep',
-        output_latex=u'$a$',
-        output_png=png,
-        output_jpeg=jpeg,
-        output_svg=u'<svg>',
-        output_json=u'json data',
-        output_javascript=u'var i=0;',
+        output_type=u'execute_result',
+        mime_bundle={
+            'text/plain': u'<array a>',
+            'text/html': u'The HTML rep',
+            'text/latex': u'$a$',
+            'image/png': png,
+            'image/jpeg': jpeg,
+            'image/svg+xml': u'<svg>',
+            'application/json': {
+                'key': 'value'
+            },
+            'application/javascript': u'var i=0;'
+        },
         prompt_number=3
     ),new_output(
         output_type=u'display_data',
-        output_text=u'<array a>',
-        output_html=u'The HTML rep',
-        output_latex=u'$a$',
-        output_png=png,
-        output_jpeg=jpeg,
-        output_svg=u'<svg>',
-        output_json=u'json data',
-        output_javascript=u'var i=0;'
+        mime_bundle={
+            'text/plain': u'<array a>',
+            'text/html': u'The HTML rep',
+            'text/latex': u'$a$',
+            'image/png': png,
+            'image/jpeg': jpeg,
+            'image/svg+xml': u'<svg>',
+            'application/json': {
+                'key': 'value'
+            },
+            'application/javascript': u'var i=0;'
+        },
     ),new_output(
-        output_type=u'pyerr',
+        output_type=u'error',
         ename=u'NameError',
         evalue=u'NameError was here',
         traceback=[u'frame 0', u'frame 1', u'frame 2']
     ),new_output(
         output_type=u'stream',
-        output_text='foo\rbar\r\n'
+        text='foo\rbar\r\n'
     ),new_output(
         output_type=u'stream',
         stream='stderr',
-        output_text='\rfoo\rbar\n'
+        text='\rfoo\rbar\n'
     )]
 ))
 
-authors = [new_author(name='Bart Simpson',email='[e-mail]',
-           affiliation=u'Fox',url=u'http://www.fox.com')]
-md = new_metadata(name=u'My Notebook',license=u'BSD',created=u'8601_goes_here',
-    modified=u'8601_goes_here',gistid=u'21341231',authors=authors)
-
-nb0 = new_notebook(
-    worksheets=[ws, new_worksheet(name='worksheet2')],
-    metadata=md
+nb0 = new_notebook(cells=cells,
+    metadata={
+        'language': 'python',
+    }
 )
 
-nb0_py = u"""# -*- coding: utf-8 -*-
-# <nbformat>%i.%i</nbformat>
-
-# <htmlcell>
-
-# Some NumPy Examples
-
-# <codecell>
-
-import numpy
-
-# <markdowncell>
-
-# A random array
-
-# <rawcell>
-
-# A random array
-
-# <headingcell level=2>
-
-# My Heading
-
-# <codecell>
-
-a = numpy.random.rand(100)
-
-# <codecell>
-
-a = 10
-b = 5
-
-# <codecell>
-
-a = 10
-b = 5
-
-# <codecell>
-
-print "ünîcødé"
 
-""" % (nbformat, nbformat_minor)

IPython/nbformat/v4/tests/test_json.py

@@ -1,4 +1,3 b''
-import pprint
 from base64 import decodestring
 from unittest import TestCase
 
@@ -9,8 +8,6 b' from .nbexamples import nb0'
 
 from . import formattest
 
-from .nbexamples import nb0
-
 
 class TestJSON(formattest.NBFormatTest, TestCase):
 
@@ -36,13 +33,13 b' class TestJSON(formattest.NBFormatTest, TestCase):'
         s = writes(nb0)
         nb1 = nbjson.reads(s)
         found_png = False
-        for cell in nb1.worksheets[0].cells:
+        for cell in nb1.cells:
             if not 'outputs' in cell:
                 continue
             for output in cell.outputs:
-                if 'png' in output:
+                if 'image/png' in output:
                     found_png = True
-                    pngdata = output['png']
+                    pngdata = output['image/png']
                     self.assertEqual(type(pngdata), unicode_type)
                     # test that it is valid b64 data
                     b64bytes = pngdata.encode('ascii')
@@ -54,13 +51,13 b' class TestJSON(formattest.NBFormatTest, TestCase):'
         s = writes(nb0)
         nb1 = nbjson.reads(s)
         found_jpeg = False
-        for cell in nb1.worksheets[0].cells:
+        for cell in nb1.cells:
             if not 'outputs' in cell:
                 continue
             for output in cell.outputs:
-                if 'jpeg' in output:
+                if 'image/jpeg' in output:
                     found_jpeg = True
-                    jpegdata = output['jpeg']
+                    jpegdata = output['image/jpeg']
                     self.assertEqual(type(jpegdata), unicode_type)
                     # test that it is valid b64 data
                     b64bytes = jpegdata.encode('ascii')