Updates to basic notebook format.

* The format now handles multiple output blocks.
* XML now as worksheets, cells and outputs tags.

IPython/nbformat/nbbase.py

@@ -1,79 +1,90 b''
 """The basic dict based notebook format."""
 
 import pprint
 import uuid
 
 from IPython.utils.ipstruct import Struct
 
 
 class NotebookNode(Struct):
     pass
 
 
-def new_code_cell(input=None, prompt_number=None, output_text=None, output_png=None,
+def new_output(output_type=None, output_text=None, output_png=None,
     output_html=None, output_svg=None, output_latex=None, output_json=None, 
     output_javascript=None):
     """Create a new code cell with input and output"""
-    cell = NotebookNode()
-    cell.cell_type = 'code'
-    if input is not None:
-        cell.input = unicode(input)
-    if prompt_number is not None:
-        cell.prompt_number = int(prompt_number)
-
     output = NotebookNode()
+    if output_type is not None:
+        output.output_type = unicode(output_type)
     if output_text is not None:
         output.text = unicode(output_text)
     if output_png is not None:
         output.png = bytes(output_png)
     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)
 
-    cell.output = output
-    return cell
+    return output
 
 
+def new_code_cell(input=None, prompt_number=None, outputs=None, language=u'python'):
+    """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
+
+    return cell
+
 def new_text_cell(text=None):
     """Create a new text cell."""
     cell = NotebookNode()
     if text is not None:
         cell.text = unicode(text)
-    cell.cell_type = 'text'
+    cell.cell_type = u'text'
     return cell
 
 
 def new_worksheet(name=None, cells=None):
     """Create a worksheet by name with with a list of cells."""
     ws = NotebookNode()
     if name is not None:
         ws.name = unicode(name)
     if cells is None:
         ws.cells = []
     else:
         ws.cells = list(cells)
     return ws
 
 
 def new_notebook(name=None, id=None, worksheets=None):
     """Create a notebook by name, id and a list of worksheets."""
     nb = NotebookNode()
     if name is not None:
         nb.name = unicode(name)
     if id is None:
         nb.id = unicode(uuid.uuid4())
     else:
         nb.id = unicode(id)
     if worksheets is None:
         nb.worksheets = []
     else:
         nb.worksheets = list(worksheets)
     return nb
 

IPython/nbformat/nbxml.py

@@ -1,141 +1,145 b''
 """Read and write notebook files as XML."""
 
 from xml.etree import ElementTree as ET
 
 from .rwbase import NotebookReader, NotebookWriter
-from .nbbase import new_code_cell, new_text_cell, new_worksheet, new_notebook
-
+from .nbbase import (
+    new_code_cell, new_text_cell, new_worksheet, new_notebook, new_output
+)
 
 def indent(elem, level=0):
     i = "\n" + level*"  "
     if len(elem):
         if not elem.text or not elem.text.strip():
             elem.text = i + "  "
         if not elem.tail or not elem.tail.strip():
             elem.tail = i
         for elem in elem:
             indent(elem, level+1)
         if not elem.tail or not elem.tail.strip():
             elem.tail = i
     else:
         if level and (not elem.tail or not elem.tail.strip()):
             elem.tail = i
 
 
 def _get_text(e, tag):
     sub_e = e.find(tag)
     if sub_e is None:
         return None
     else:
         return sub_e.text
 
 
+def _set_text(nbnode, attr, parent, tag):
+    if attr in nbnode:
+        e = ET.SubElement(parent, tag)
+        e.text = nbnode[attr]
+
+
+def _get_int(e, tag):
+    sub_e = e.find(tag)
+    if sub_e is None:
+        return None
+    else:
+        return int(sub_e.text)
+
+
+def _set_int(nbnode, attr, parent, tag):
+    if attr in nbnode:
+        e = ET.SubElement(parent, tag)
+        e.text = unicode(nbnode[attr])
+
+
 class XMLReader(NotebookReader):
 
     def reads(self, s, **kwargs):
         root = ET.fromstring(s)
 
         nbname = _get_text(root,'name')
         nbid = _get_text(root,'id')
         
         worksheets = []
-        for ws_e in root.getiterator('worksheet'):
+        for ws_e in root.find('worksheets').getiterator('worksheet'):
             wsname = _get_text(ws_e,'name')
             cells = []
-            for cell_e in ws_e.getiterator():
+            for cell_e in ws_e.find('cells').getiterator():
                 if cell_e.tag == 'codecell':
                     input = _get_text(cell_e,'input')
-                    output_e = cell_e.find('output')
-                    if output_e is not None:
+                    prompt_number = _get_int(cell_e,'prompt_number')
+                    language = _get_text(cell_e,'language')
+                    outputs = []
+                    for output_e in cell_e.find('outputs').getiterator('output'):
+                        output_type = _get_text(output_e,'output_type')
                         output_text = _get_text(output_e,'text')
                         output_png = _get_text(output_e,'png')
                         output_svg = _get_text(output_e,'svg')
                         output_html = _get_text(output_e,'html')
                         output_latex = _get_text(output_e,'latex')
                         output_json = _get_text(output_e,'json')
                         output_javascript = _get_text(output_e,'javascript')
-                    cc = new_code_cell(input=input,output_png=output_png,
-                        output_text=output_text,output_svg=output_svg,
-                        output_html=output_html,output_latex=output_latex,
-                        output_json=output_json,output_javascript=output_javascript
-                    )
+                        output = new_output(output_type=output_type,output_png=output_png,
+                            output_text=output_text,output_svg=output_svg,
+                            output_html=output_html,output_latex=output_latex,
+                            output_json=output_json,output_javascript=output_javascript
+                        )
+                        outputs.append(output)
+                    cc = new_code_cell(input=input,prompt_number=prompt_number,
+                                       language=language,outputs=outputs)
                     cells.append(cc)
                 if cell_e.tag == 'textcell':
                     text = _get_text(cell_e,'text')
                     cells.append(new_text_cell(text=text))
             ws = new_worksheet(name=wsname,cells=cells)
             worksheets.append(ws)
 
         nb = new_notebook(name=nbname,id=nbid,worksheets=worksheets)
         return nb
 
 
 class XMLWriter(NotebookWriter):
 
     def writes(self, nb, **kwargs):
         nb_e = ET.Element('notebook')
-        if 'name' in nb:
-            name_e = ET.SubElement(nb_e, 'name')
-            name_e.text = nb.name
-        if 'id' in nb:
-            id_e = ET.SubElement(nb_e, 'id')
-            id_e.text = nb.id
+        _set_text(nb,'name',nb_e,'name')
+        _set_text(nb,'id',nb_e,'id')
+        wss_e = ET.SubElement(nb_e,'worksheets')
         for ws in nb.worksheets:
-            ws_e = ET.SubElement(nb_e, 'worksheet')
-            if 'name' in ws:
-                ws_name_e = ET.SubElement(ws_e, 'name')
-                ws_name_e.text = ws.name
+            ws_e = ET.SubElement(wss_e, 'worksheet')
+            _set_text(ws,'name',ws_e,'name')
+            cells_e = ET.SubElement(ws_e,'cells')
             for cell in ws.cells:
                 cell_type = cell.cell_type
                 if cell_type == 'code':
-                    output = cell.output
-                    cell_e = ET.SubElement(ws_e, 'codecell')
-                    output_e = ET.SubElement(cell_e, 'output')
-
-                    if 'input' in cell:
-                        input_e = ET.SubElement(cell_e, 'input')
-                        input_e.text = cell.input
-                    if 'prompt_number' in cell:
-                        prompt_number_e = ET.SubElement(cell_e, 'prompt_number')
-                        input_e.text = cell.prompt_number
-
-                    if 'text' in output:
-                        text_e = ET.SubElement(output_e, 'text')
-                        text_e.text = output.text
-                    if 'png' in output:
-                        png_e = ET.SubElement(output_e, 'png')
-                        png_e.text = output.png
-                    if 'html' in output:
-                        html_e = ET.SubElement(output_e, 'html')
-                        html_e.text = output.html
-                    if 'svg' in output:
-                        svg_e = ET.SubElement(output_e, 'svg')
-                        svg_e.text = output.svg
-                    if 'latex' in output:
-                        latex_e = ET.SubElement(output_e, 'latex')
-                        latex_e.text = output.latex
-                    if 'json' in output:
-                        json_e = ET.SubElement(output_e, 'json')
-                        json_e.text = output.json
-                    if 'javascript' in output:
-                        javascript_e = ET.SubElement(output_e, 'javascript')
-                        javascript_e.text = output.javascript
+                    cell_e = ET.SubElement(cells_e, 'codecell')
+                    _set_text(cell,'input',cell_e,'input')
+                    _set_text(cell,'language',cell_e,'language')
+                    _set_int(cell,'prompt_number',cell_e,'prompt_number')
+                    outputs_e = ET.SubElement(cell_e, 'outputs')
+                    for output in cell.outputs:
+                        output_e = ET.SubElement(outputs_e, 'output')
+                        _set_text(output,'output_type',output_e,'output_type')
+                        _set_text(output,'text',output_e,'text')
+                        _set_text(output,'png',output_e,'png')
+                        _set_text(output,'html',output_e,'html')
+                        _set_text(output,'svg',output_e,'svg')
+                        _set_text(output,'latex',output_e,'latex')
+                        _set_text(output,'json',output_e,'json')
+                        _set_text(output,'javascript',output_e,'javascript')
                 elif cell_type == 'text':
-                    cell_e = ET.SubElement(ws_e, 'textcell')
-                    if 'text' in cell:
-                        cell_text_e = ET.SubElement(cell_e, 'text')
-                        cell_text_e.text = cell.text
+                    cell_e = ET.SubElement(cells_e, 'textcell')
+                    _set_text(cell,'text',cell_e,'text')
 
         indent(nb_e)
         txt = ET.tostring(nb_e, encoding="utf-8")
         txt = '<?xml version="1.0" encoding="utf-8"?>\n' + txt
         return txt
         
                     
 _reader = XMLReader()
 _writer = XMLWriter()
 
 reads = _reader.reads
 read = _reader.read
 write = _writer.write
 writes = _writer.writes

IPython/nbformat/tests/nbexamples.py

@@ -1,52 +1,67 b''
 from IPython.nbformat.nbbase import (
     NotebookNode,
-    new_code_cell, new_text_cell, new_worksheet, new_notebook
+    new_code_cell, new_text_cell, new_worksheet, new_notebook, new_output
 )
 
 
 
 ws = new_worksheet(name='worksheet1')
 
 ws.cells.append(new_text_cell(
     text='Some NumPy Examples'
 ))
 
 
 ws.cells.append(new_code_cell(
-    input='import numpy'
+    input='import numpy',
+    prompt_number=1
 ))
 
 ws.cells.append(new_code_cell(
-    input='a = numpy.random.rand(100)'
+    input='a = numpy.random.rand(100)',
+    prompt_number=2
 ))
 
 ws.cells.append(new_code_cell(
     input='print a',
-    output_text='<array a>',
-    output_html='The HTML rep',
-    output_latex='$a$',
-    output_png=b'data',
-    output_svg='<svg>',
-    output_json='json data',
-    output_javascript='var i=0;'
+    prompt_number=3,
+    outputs=[new_output(
+        output_type=u'pyout',
+        output_text=u'<array a>',
+        output_html=u'The HTML rep',
+        output_latex=u'$a$',
+        output_png=b'data',
+        output_svg=u'<svg>',
+        output_json=u'json data',
+        output_javascript=u'var i=0;'
+    ),new_output(
+        output_type=u'display_data',
+        output_text=u'<array a>',
+        output_html=u'The HTML rep',
+        output_latex=u'$a$',
+        output_png=b'data',
+        output_svg=u'<svg>',
+        output_json=u'json data',
+        output_javascript=u'var i=0;'
+    )]
 ))
 
 nb0 = new_notebook(
     name='nb0',
     worksheets=[ws, new_worksheet(name='worksheet2')]
 )
 
 nb0_py = """# <codecell>
 
 import numpy
 
 # <codecell>
 
 a = numpy.random.rand(100)
 
 # <codecell>
 
 print a
 """
 
 

IPython/nbformat/tests/test_nbbase.py

@@ -1,60 +1,62 b''
 from unittest import TestCase
 
 from IPython.nbformat.nbbase import (
     NotebookNode,
-    new_code_cell, new_text_cell, new_worksheet, new_notebook
+    new_code_cell, new_text_cell, new_worksheet, new_notebook, new_output
 )
 
 class TestCell(TestCase):
 
     def test_empty_code_cell(self):
         cc = new_code_cell()
         self.assertEquals(cc.cell_type,'code')
         self.assertEquals('input' not in cc, True)
         self.assertEquals('prompt_number' not in cc, True)
-        self.assertEquals(cc.output, NotebookNode())
+        self.assertEquals(cc.outputs, [])
 
     def test_code_cell(self):
-        cc = new_code_cell(input='a=10', prompt_number=0, output_svg='foo', output_text='10')
+        cc = new_code_cell(input='a=10', prompt_number=0)
+        cc.outputs = [new_output(output_type='pyout',output_svg='foo',output_text='10')]
         self.assertEquals(cc.input, u'a=10')
         self.assertEquals(cc.prompt_number, 0)
-        self.assertEquals(cc.output.svg, u'foo')
-        self.assertEquals(cc.output.text, u'10')
+        self.assertEquals(cc.language, u'python')
+        self.assertEquals(cc.outputs[0].svg, u'foo')
+        self.assertEquals(cc.outputs[0].text, u'10')
 
     def test_empty_text_cell(self):
         tc = new_text_cell()
         self.assertEquals(tc.cell_type, 'text')
         self.assertEquals('text' not in tc, True)
 
     def test_text_cell(self):
         tc = new_text_cell('hi')
         self.assertEquals(tc.text, u'hi')
 
 
 class TestWorksheet(TestCase):
 
     def test_empty_worksheet(self):
         ws = new_worksheet()
         self.assertEquals(ws.cells,[])
         self.assertEquals('name' not in ws, True)
 
     def test_worksheet(self):
         cells = [new_code_cell(), new_text_cell()]
         ws = new_worksheet(cells=cells,name='foo')
         self.assertEquals(ws.cells,cells)
         self.assertEquals(ws.name,u'foo')
 
 class TestNotebook(TestCase):
 
     def test_empty_notebook(self):
         nb = new_notebook()
         self.assertEquals('id' in nb, True)
         self.assertEquals(nb.worksheets, [])
         self.assertEquals('name' not in nb, True)
 
     def test_notebooke(self):
         worksheets = [new_worksheet(),new_worksheet()]
         nb = new_notebook(name='foo',worksheets=worksheets)
         self.assertEquals(nb.name,u'foo')
         self.assertEquals(nb.worksheets,worksheets)
 

IPython/nbformat/tests/test_xml.py

@@ -1,12 +1,18 b''
 from unittest import TestCase
 
 from IPython.nbformat.nbxml import reads, writes
 from IPython.nbformat.tests.nbexamples import nb0
-
+import pprint
 
 class TestXML(TestCase):
 
     def test_roundtrip(self):
         s = writes(nb0)
+#        print
+#        print pprint.pformat(nb0,indent=2)
+#        print
+#        print pprint.pformat(reads(s),indent=2)
+#        print
+#        print s
         self.assertEquals(reads(s),nb0)
 

IPython/testing/iptest.py

@@ -1,443 +1,443 b''
 # -*- coding: utf-8 -*-
 """IPython Test Suite Runner.
 
 This module provides a main entry point to a user script to test IPython
 itself from the command line. There are two ways of running this script:
 
 1. With the syntax `iptest all`.  This runs our entire test suite by
    calling this script (with different arguments) recursively.  This
    causes modules and package to be tested in different processes, using nose
    or trial where appropriate.
 2. With the regular nose syntax, like `iptest -vvs IPython`.  In this form
    the script simply calls nose, but with special command line flags and
    plugins loaded.
 
 """
 
 #-----------------------------------------------------------------------------
 #  Copyright (C) 2009  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
 #-----------------------------------------------------------------------------
 
 # Stdlib
 import os
 import os.path as path
 import signal
 import sys
 import subprocess
 import tempfile
 import time
 import warnings
 
 # Note: monkeypatch!
 # We need to monkeypatch a small problem in nose itself first, before importing
 # it for actual use.  This should get into nose upstream, but its release cycle
 # is slow and we need it for our parametric tests to work correctly.
 from IPython.testing import nosepatch
 # Now, proceed to import nose itself
 import nose.plugins.builtin
 from nose.core import TestProgram
 
 # Our own imports
 from IPython.utils.path import get_ipython_module_path
 from IPython.utils.process import find_cmd, pycmd2argv
 from IPython.utils.sysinfo import sys_info
 
 from IPython.testing import globalipapp
 from IPython.testing.plugin.ipdoctest import IPythonDoctest
 from IPython.external.decorators import KnownFailure
 
 pjoin = path.join
 
 
 #-----------------------------------------------------------------------------
 # Globals
 #-----------------------------------------------------------------------------
 
 
 #-----------------------------------------------------------------------------
 # Warnings control
 #-----------------------------------------------------------------------------
 
 # Twisted generates annoying warnings with Python 2.6, as will do other code
 # that imports 'sets' as of today
 warnings.filterwarnings('ignore', 'the sets module is deprecated',
                         DeprecationWarning )
 
 # This one also comes from Twisted
 warnings.filterwarnings('ignore', 'the sha module is deprecated',
                         DeprecationWarning)
 
 # Wx on Fedora11 spits these out
 warnings.filterwarnings('ignore', 'wxPython/wxWidgets release number mismatch',
                         UserWarning)
 
 #-----------------------------------------------------------------------------
 # Logic for skipping doctests
 #-----------------------------------------------------------------------------
 
 def test_for(mod, min_version=None):
     """Test to see if mod is importable."""
     try:
         __import__(mod)
     except (ImportError, RuntimeError):
         # GTK reports Runtime error if it can't be initialized even if  it's
         # importable.
         return False
     else:
         if min_version:
             return sys.modules[mod].__version__ >= min_version
         else:
             return True
 
 # Global dict where we can store information on what we have and what we don't
 # have available at test run time
 have = {}
 
 have['curses'] = test_for('_curses')
 have['matplotlib'] = test_for('matplotlib')
 have['pexpect'] = test_for('pexpect')
 have['pymongo'] = test_for('pymongo')
 have['wx'] = test_for('wx')
 have['wx.aui'] = test_for('wx.aui')
 if os.name == 'nt':
     have['zmq'] = test_for('zmq', '2.1.7')
 else:
     have['zmq'] = test_for('zmq', '2.1.4')
 have['qt'] = test_for('IPython.external.qt')
 
 #-----------------------------------------------------------------------------
 # Functions and classes
 #-----------------------------------------------------------------------------
 
 def report():
     """Return a string with a summary report of test-related variables."""
 
     out = [ sys_info(), '\n']
 
     avail = []
     not_avail = []
     
     for k, is_avail in have.items():
         if is_avail:
             avail.append(k)
         else:
             not_avail.append(k)
 
     if avail:
         out.append('\nTools and libraries available at test time:\n')
         avail.sort()
         out.append('   ' + ' '.join(avail)+'\n')
 
     if not_avail:
         out.append('\nTools and libraries NOT available at test time:\n')
         not_avail.sort()
         out.append('   ' + ' '.join(not_avail)+'\n')
         
     return ''.join(out)
 
 
 def make_exclude():
     """Make patterns of modules and packages to exclude from testing.
 
     For the IPythonDoctest plugin, we need to exclude certain patterns that
     cause testing problems.  We should strive to minimize the number of
     skipped modules, since this means untested code.
 
     These modules and packages will NOT get scanned by nose at all for tests.
     """
     # Simple utility to make IPython paths more readably, we need a lot of
     # these below
     ipjoin = lambda *paths: pjoin('IPython', *paths)
     
     exclusions = [ipjoin('external'),
                   pjoin('IPython_doctest_plugin'),
                   ipjoin('quarantine'),
                   ipjoin('deathrow'),
                   ipjoin('testing', 'attic'),
                   # This guy is probably attic material
                   ipjoin('testing', 'mkdoctests'),
                   # Testing inputhook will need a lot of thought, to figure out
                   # how to have tests that don't lock up with the gui event
                   # loops in the picture
                   ipjoin('lib', 'inputhook'),
                   # Config files aren't really importable stand-alone
                   ipjoin('config', 'default'),
                   ipjoin('config', 'profile'),
                   ]
 
     if not have['wx']:
         exclusions.append(ipjoin('lib', 'inputhookwx'))
         
     # We do this unconditionally, so that the test suite doesn't import
     # gtk, changing the default encoding and masking some unicode bugs.
     exclusions.append(ipjoin('lib', 'inputhookgtk'))
 
     # These have to be skipped on win32 because the use echo, rm, cd, etc.
     # See ticket https://github.com/ipython/ipython/issues/87
     if sys.platform == 'win32':
         exclusions.append(ipjoin('testing', 'plugin', 'test_exampleip'))
         exclusions.append(ipjoin('testing', 'plugin', 'dtexample'))
 
     if not have['pexpect']:
         exclusions.extend([ipjoin('scripts', 'irunner'),
                            ipjoin('lib', 'irunner'),
                            ipjoin('lib', 'tests', 'test_irunner')])
 
     if not have['zmq']:
         exclusions.append(ipjoin('zmq'))
         exclusions.append(ipjoin('frontend', 'qt'))
         exclusions.append(ipjoin('parallel'))
     elif not have['qt']:
         exclusions.append(ipjoin('frontend', 'qt'))
     
     if not have['pymongo']:
         exclusions.append(ipjoin('parallel', 'controller', 'mongodb'))
         exclusions.append(ipjoin('parallel', 'tests', 'test_mongodb'))
 
     if not have['matplotlib']:
         exclusions.extend([ipjoin('lib', 'pylabtools'),
                            ipjoin('lib', 'tests', 'test_pylabtools')])
 
     # This is needed for the reg-exp to match on win32 in the ipdoctest plugin.
     if sys.platform == 'win32':
         exclusions = [s.replace('\\','\\\\') for s in exclusions]
 
     return exclusions
 
 
 class IPTester(object):
     """Call that calls iptest or trial in a subprocess.
     """
     #: string, name of test runner that will be called
     runner = None
     #: list, parameters for test runner
     params = None
     #: list, arguments of system call to be made to call test runner
     call_args = None
     #: list, process ids of subprocesses we start (for cleanup)
     pids = None
     
     def __init__(self, runner='iptest', params=None):
         """Create new test runner."""
         p = os.path
         if runner == 'iptest':
             iptest_app = get_ipython_module_path('IPython.testing.iptest')
             self.runner = pycmd2argv(iptest_app) + sys.argv[1:]
         else:
             raise Exception('Not a valid test runner: %s' % repr(runner))
         if params is None:
             params = []
         if isinstance(params, str):
             params = [params]
         self.params = params
 
         # Assemble call
         self.call_args = self.runner+self.params
 
         # Store pids of anything we start to clean up on deletion, if possible
         # (on posix only, since win32 has no os.kill)
         self.pids = []
 
     if sys.platform == 'win32':
         def _run_cmd(self):
             # On Windows, use os.system instead of subprocess.call, because I
             # was having problems with subprocess and I just don't know enough
             # about win32 to debug this reliably.  Os.system may be the 'old
             # fashioned' way to do it, but it works just fine.  If someone
             # later can clean this up that's fine, as long as the tests run
             # reliably in win32.
             # What types of problems are you having. They may be related to
             # running Python in unboffered mode. BG.
             return os.system(' '.join(self.call_args))
     else:
         def _run_cmd(self):
             # print >> sys.stderr, '*** CMD:', ' '.join(self.call_args) # dbg
             subp = subprocess.Popen(self.call_args)
             self.pids.append(subp.pid)
             # If this fails, the pid will be left in self.pids and cleaned up
             # later, but if the wait call succeeds, then we can clear the
             # stored pid.
             retcode = subp.wait()
             self.pids.pop()
             return retcode
         
     def run(self):
         """Run the stored commands"""
         try:
             return self._run_cmd()
         except:
             import traceback
             traceback.print_exc()
             return 1  # signal failure
 
     def __del__(self):
         """Cleanup on exit by killing any leftover processes."""
 
         if not hasattr(os, 'kill'):
             return
         
         for pid in self.pids:
             try:
                 print 'Cleaning stale PID:', pid
                 os.kill(pid, signal.SIGKILL)
             except OSError:
                 # This is just a best effort, if we fail or the process was
                 # really gone, ignore it.
                 pass     
 
 
 def make_runners():
     """Define the top-level packages that need to be tested.
     """
 
     # Packages to be tested via nose, that only depend on the stdlib
     nose_pkg_names = ['config', 'core', 'extensions', 'frontend', 'lib',
-                     'scripts', 'testing', 'utils' ]
+                     'scripts', 'testing', 'utils', 'nbformat' ]
     
     if have['zmq']:
         nose_pkg_names.append('parallel')
     
     # For debugging this code, only load quick stuff
     #nose_pkg_names = ['core', 'extensions']  # dbg
 
     # Make fully qualified package names prepending 'IPython.' to our name lists
     nose_packages = ['IPython.%s' % m for m in nose_pkg_names ]
 
     # Make runners
     runners = [ (v, IPTester('iptest', params=v)) for v in nose_packages ]
     
     return runners
 
 
 def run_iptest():
     """Run the IPython test suite using nose.
     
     This function is called when this script is **not** called with the form
     `iptest all`.  It simply calls nose with appropriate command line flags
     and accepts all of the standard nose arguments.
     """
 
     warnings.filterwarnings('ignore', 
         'This will be removed soon.  Use IPython.testing.util instead')
 
     argv = sys.argv + [ '--detailed-errors',  # extra info in tracebacks
                                                 
                         # Loading ipdoctest causes problems with Twisted, but
                         # our test suite runner now separates things and runs
                         # all Twisted tests with trial.
                         '--with-ipdoctest',
                         '--ipdoctest-tests','--ipdoctest-extension=txt',
                         
                         # We add --exe because of setuptools' imbecility (it
                         # blindly does chmod +x on ALL files).  Nose does the
                         # right thing and it tries to avoid executables,
                         # setuptools unfortunately forces our hand here.  This
                         # has been discussed on the distutils list and the
                         # setuptools devs refuse to fix this problem!
                         '--exe',
                         ]
 
     if nose.__version__ >= '0.11':
         # I don't fully understand why we need this one, but depending on what
         # directory the test suite is run from, if we don't give it, 0 tests
         # get run.  Specifically, if the test suite is run from the source dir
         # with an argument (like 'iptest.py IPython.core', 0 tests are run,
         # even if the same call done in this directory works fine).  It appears
         # that if the requested package is in the current dir, nose bails early
         # by default.  Since it's otherwise harmless, leave it in by default
         # for nose >= 0.11, though unfortunately nose 0.10 doesn't support it.
         argv.append('--traverse-namespace')
 
     # Construct list of plugins, omitting the existing doctest plugin, which
     # ours replaces (and extends).
     plugins = [IPythonDoctest(make_exclude()), KnownFailure()]
     for p in nose.plugins.builtin.plugins:
         plug = p()
         if plug.name == 'doctest':
             continue
         plugins.append(plug)
 
     # We need a global ipython running in this process
     globalipapp.start_ipython()
     # Now nose can run
     TestProgram(argv=argv, plugins=plugins)
 
 
 def run_iptestall():
     """Run the entire IPython test suite by calling nose and trial.
     
     This function constructs :class:`IPTester` instances for all IPython
     modules and package and then runs each of them.  This causes the modules
     and packages of IPython to be tested each in their own subprocess using
     nose or twisted.trial appropriately.
     """
 
     runners = make_runners()
 
     # Run the test runners in a temporary dir so we can nuke it when finished
     # to clean up any junk files left over by accident.  This also makes it
     # robust against being run in non-writeable directories by mistake, as the
     # temp dir will always be user-writeable.
     curdir = os.getcwdu()
     testdir = tempfile.gettempdir()
     os.chdir(testdir)
 
     # Run all test runners, tracking execution time
     failed = []
     t_start = time.time()
     try:
         for (name, runner) in runners:
             print '*'*70
             print 'IPython test group:',name
             res = runner.run()
             if res:
                 failed.append( (name, runner) )
     finally:
         os.chdir(curdir)
     t_end = time.time()
     t_tests = t_end - t_start
     nrunners = len(runners)
     nfail = len(failed)
     # summarize results
     print
     print '*'*70
     print 'Test suite completed for system with the following information:'
     print report()
     print 'Ran %s test groups in %.3fs' % (nrunners, t_tests)
     print
     print 'Status:'
     if not failed:
         print 'OK'
     else:
         # If anything went wrong, point out what command to rerun manually to
         # see the actual errors and individual summary
         print 'ERROR - %s out of %s test groups failed.' % (nfail, nrunners)
         for name, failed_runner in failed:
             print '-'*40
             print 'Runner failed:',name
             print 'You may wish to rerun this one individually, with:'
             print ' '.join(failed_runner.call_args)
             print
         # Ensure that our exit code indicates failure
         sys.exit(1)
 
 
 def main():
     for arg in sys.argv[1:]:
         if arg.startswith('IPython'):
             # This is in-process
             run_iptest()
     else:
         # This starts subprocesses
         run_iptestall()
 
 
 if __name__ == '__main__':
     main()

setupbase.py

@@ -1,401 +1,402 b''
 # encoding: utf-8
 """
 This module defines the things that are used in setup.py for building IPython
 
 This includes:
 
     * The basic arguments to setup
     * Functions for finding things like packages, package data, etc.
     * A function for checking dependencies.
 """
 from __future__ import print_function
 
 #-------------------------------------------------------------------------------
 #  Copyright (C) 2008  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
 #-------------------------------------------------------------------------------
 import os
 import sys
 
 from ConfigParser import ConfigParser
 from distutils.command.build_py import build_py
 from glob import glob
 
 from setupext import install_data_ext
 
 #-------------------------------------------------------------------------------
 # Useful globals and utility functions
 #-------------------------------------------------------------------------------
 
 # A few handy globals
 isfile = os.path.isfile
 pjoin = os.path.join
 
 def oscmd(s):
     print(">", s)
     os.system(s)
 
 # A little utility we'll need below, since glob() does NOT allow you to do
 # exclusion on multiple endings!
 def file_doesnt_endwith(test,endings):
     """Return true if test is a file and its name does NOT end with any
     of the strings listed in endings."""
     if not isfile(test):
         return False
     for e in endings:
         if test.endswith(e):
             return False
     return True
 
 #---------------------------------------------------------------------------
 # Basic project information
 #---------------------------------------------------------------------------
 
 # release.py contains version, authors, license, url, keywords, etc.
 execfile(pjoin('IPython','core','release.py'))
 
 # Create a dict with the basic information
 # This dict is eventually passed to setup after additional keys are added.
 setup_args = dict(
       name             = name,
       version          = version,
       description      = description,
       long_description = long_description,
       author           = author,
       author_email     = author_email,
       url              = url,
       download_url     = download_url,
       license          = license,
       platforms        = platforms,
       keywords         = keywords,
       cmdclass         = {'install_data': install_data_ext},
       )
 
 
 #---------------------------------------------------------------------------
 # Find packages
 #---------------------------------------------------------------------------
 
 def add_package(packages,pname,config=False,tests=False,scripts=False,
                 others=None):
     """
     Add a package to the list of packages, including certain subpackages.
     """
     packages.append('.'.join(['IPython',pname]))
     if config:
         packages.append('.'.join(['IPython',pname,'config']))
     if tests:
         packages.append('.'.join(['IPython',pname,'tests']))
     if scripts:
         packages.append('.'.join(['IPython',pname,'scripts']))
     if others is not None:
         for o in others:
             packages.append('.'.join(['IPython',pname,o]))
 
 def find_packages():
     """
     Find all of IPython's packages.
     """
     packages = ['IPython']
     add_package(packages, 'config', tests=True, others=['profile'])
     add_package(packages, 'core', tests=True)
     add_package(packages, 'extensions')
     add_package(packages, 'external')
     add_package(packages, 'external.argparse')
     add_package(packages, 'external.decorator')
     add_package(packages, 'external.decorators')
     add_package(packages, 'external.guid')
     add_package(packages, 'external.Itpl')
     add_package(packages, 'external.mglob')
     add_package(packages, 'external.path')
     add_package(packages, 'external.pexpect')
     add_package(packages, 'external.pyparsing')
     add_package(packages, 'external.simplegeneric')
     add_package(packages, 'external.ssh')
     add_package(packages, 'kernel')
     add_package(packages, 'frontend')
     add_package(packages, 'frontend.html')
     add_package(packages, 'frontend.html.notebook')
     add_package(packages, 'frontend.qt')
     add_package(packages, 'frontend.qt.console', tests=True)
     add_package(packages, 'frontend.terminal', tests=True)
     add_package(packages, 'lib', tests=True)
+    add_package(packages, 'nbformat', tests=True)
     add_package(packages, 'parallel', tests=True, scripts=True, 
                                     others=['apps','engine','client','controller'])
     add_package(packages, 'quarantine', tests=True)
     add_package(packages, 'scripts')
     add_package(packages, 'testing', tests=True)
     add_package(packages, 'testing.plugin', tests=False)
     add_package(packages, 'utils', tests=True)
     add_package(packages, 'zmq')
     add_package(packages, 'zmq.pylab')
     add_package(packages, 'zmq.gui')
     return packages
 
 #---------------------------------------------------------------------------
 # Find package data
 #---------------------------------------------------------------------------
 
 def find_package_data():
     """
     Find IPython's package_data.
     """
     # This is not enough for these things to appear in an sdist.
     # We need to muck with the MANIFEST to get this to work
     
     # walk notebook resources:
     cwd = os.getcwd()
     os.chdir(os.path.join('IPython', 'frontend', 'html', 'notebook'))
     static_walk = list(os.walk('static'))
     os.chdir(cwd)
     static_data = []
     for parent, dirs, files in static_walk:
         for f in files:
             static_data.append(os.path.join(parent, f))
     
     package_data = {
         'IPython.config.profile' : ['README', '*/*.py'],
         'IPython.testing' : ['*.txt'],
         'IPython.frontend.html.notebook' : ['templates/*']+static_data
     }
     return package_data
 
 
 #---------------------------------------------------------------------------
 # Find data files
 #---------------------------------------------------------------------------
 
 def make_dir_struct(tag,base,out_base):
     """Make the directory structure of all files below a starting dir.
 
     This is just a convenience routine to help build a nested directory
     hierarchy because distutils is too stupid to do this by itself.
 
     XXX - this needs a proper docstring!
     """
     
     # we'll use these a lot below
     lbase = len(base)
     pathsep = os.path.sep
     lpathsep = len(pathsep)
     
     out = []
     for (dirpath,dirnames,filenames) in os.walk(base):
         # we need to strip out the dirpath from the base to map it to the
         # output (installation) path.  This requires possibly stripping the
         # path separator, because otherwise pjoin will not work correctly
         # (pjoin('foo/','/bar') returns '/bar').
         
         dp_eff = dirpath[lbase:]
         if dp_eff.startswith(pathsep):
             dp_eff = dp_eff[lpathsep:]
         # The output path must be anchored at the out_base marker    
         out_path = pjoin(out_base,dp_eff)
         # Now we can generate the final filenames. Since os.walk only produces
         # filenames, we must join back with the dirpath to get full valid file
         # paths:
         pfiles = [pjoin(dirpath,f) for f in filenames]
         # Finally, generate the entry we need, which is a pari of (output
         # path, files) for use as a data_files parameter in install_data.
         out.append((out_path, pfiles))
 
     return out
     
 
 def find_data_files():
     """
     Find IPython's data_files.
 
     Most of these are docs.
     """
     
     docdirbase  = pjoin('share', 'doc', 'ipython')
     manpagebase = pjoin('share', 'man', 'man1')
     
     # Simple file lists can be made by hand
     manpages  = filter(isfile, glob(pjoin('docs','man','*.1.gz')))
     igridhelpfiles = filter(isfile,
                             glob(pjoin('IPython','extensions','igrid_help.*')))
 
     # For nested structures, use the utility above
     example_files = make_dir_struct(
         'data',
         pjoin('docs','examples'),
         pjoin(docdirbase,'examples')
     )
     manual_files = make_dir_struct(
         'data',
         pjoin('docs','dist'),
         pjoin(docdirbase,'manual')
     )
 
     # And assemble the entire output list
     data_files = [ (manpagebase, manpages),
                    (pjoin(docdirbase, 'extensions'), igridhelpfiles),
                    ] + manual_files + example_files
 
     return data_files
 
 
 def make_man_update_target(manpage):
     """Return a target_update-compliant tuple for the given manpage.
 
     Parameters
     ----------
     manpage : string
       Name of the manpage, must include the section number (trailing number).
 
     Example
     -------
 
     >>> make_man_update_target('ipython.1') #doctest: +NORMALIZE_WHITESPACE
     ('docs/man/ipython.1.gz',
      ['docs/man/ipython.1'],
      'cd docs/man && gzip -9c ipython.1 > ipython.1.gz')
     """
     man_dir = pjoin('docs', 'man')
     manpage_gz = manpage + '.gz'
     manpath = pjoin(man_dir, manpage)
     manpath_gz = pjoin(man_dir, manpage_gz)
     gz_cmd = ( "cd %(man_dir)s && gzip -9c %(manpage)s > %(manpage_gz)s" %
                locals() )
     return (manpath_gz, [manpath], gz_cmd)
     
 #---------------------------------------------------------------------------
 # Find scripts
 #---------------------------------------------------------------------------
 
 def find_scripts(entry_points=False):
     """Find IPython's scripts.
     
     if entry_points is True:
         return setuptools entry_point-style definitions
     else:
         return file paths of plain scripts [default]
     """
     if entry_points:
         console_scripts = [
             'ipython = IPython.frontend.terminal.ipapp:launch_new_instance',
             'ipython-notebook = IPython.frontend.html.notebook.notebookapp:launch_new_instance',
             'pycolor = IPython.utils.PyColorize:main',
             'ipcontroller = IPython.parallel.apps.ipcontrollerapp:launch_new_instance',
             'ipengine = IPython.parallel.apps.ipengineapp:launch_new_instance',
             'iplogger = IPython.parallel.apps.iploggerapp:launch_new_instance',
             'ipcluster = IPython.parallel.apps.ipclusterapp:launch_new_instance',
             'iptest = IPython.testing.iptest:main',
             'irunner = IPython.lib.irunner:main'
         ]
         gui_scripts = [
             'ipython-qtconsole = IPython.frontend.qt.console.qtconsoleapp:main',
         ]
         scripts = dict(console_scripts=console_scripts, gui_scripts=gui_scripts)
     else:
         parallel_scripts = pjoin('IPython','parallel','scripts')
         main_scripts = pjoin('IPython','scripts')
         scripts = [
                    pjoin(parallel_scripts, 'ipengine'),
                    pjoin(parallel_scripts, 'ipcontroller'),
                    pjoin(parallel_scripts, 'ipcluster'),
                    pjoin(parallel_scripts, 'iplogger'),
                    pjoin(main_scripts, 'ipython'),
                    pjoin(main_scripts, 'ipython-notebook'),
                    pjoin(main_scripts, 'pycolor'),
                    pjoin(main_scripts, 'irunner'),
                    pjoin(main_scripts, 'iptest')
         ]
     return scripts
 
 #---------------------------------------------------------------------------
 # Verify all dependencies
 #---------------------------------------------------------------------------
 
 def check_for_dependencies():
     """Check for IPython's dependencies.
     
     This function should NOT be called if running under setuptools!
     """
     from setupext.setupext import (
         print_line, print_raw, print_status,
         check_for_sphinx, check_for_pygments,
         check_for_nose, check_for_pexpect,
         check_for_pyzmq, check_for_readline
     )
     print_line()
     print_raw("BUILDING IPYTHON")
     print_status('python', sys.version)
     print_status('platform', sys.platform)
     if sys.platform == 'win32':
         print_status('Windows version', sys.getwindowsversion())
     
     print_raw("")
     print_raw("OPTIONAL DEPENDENCIES")
 
     check_for_sphinx()
     check_for_pygments()
     check_for_nose()
     check_for_pexpect()
     check_for_pyzmq()
     check_for_readline()
 
 def record_commit_info(pkg_dir, build_cmd=build_py):
     """ Return extended build command class for recording commit
 
     The extended command tries to run git to find the current commit, getting
     the empty string if it fails.  It then writes the commit hash into a file
     in the `pkg_dir` path, named ``.git_commit_info.ini``.
 
     In due course this information can be used by the package after it is
     installed, to tell you what commit it was installed from if known.
 
     To make use of this system, you need a package with a .git_commit_info.ini
     file - e.g. ``myproject/.git_commit_info.ini`` - that might well look like
     this::
 
         # This is an ini file that may contain information about the code state
         [commit hash]
         # The line below may contain a valid hash if it has been substituted
         # during 'git archive'
         archive_subst_hash=$Format:%h$
         # This line may be modified by the install process
         install_hash=
 
     The .git_commit_info file above is also designed to be used with git
     substitution - so you probably also want a ``.gitattributes`` file in the
     root directory of your working tree that contains something like this::
 
        myproject/.git_commit_info.ini export-subst
 
     That will cause the ``.git_commit_info.ini`` file to get filled in by ``git
     archive`` - useful in case someone makes such an archive - for example with
     via the github 'download source' button.
 
     Although all the above will work as is, you might consider having something
     like a ``get_info()`` function in your package to display the commit
     information at the terminal.  See the ``pkg_info.py`` module in the nipy
     package for an example.
     """
     class MyBuildPy(build_cmd):
         ''' Subclass to write commit data into installation tree '''
         def run(self):
             build_py.run(self)
             import subprocess
             proc = subprocess.Popen('git rev-parse --short HEAD',
                                     stdout=subprocess.PIPE,
                                     stderr=subprocess.PIPE,
                                     shell=True)
             repo_commit, _ = proc.communicate()
             # We write the installation commit even if it's empty
             cfg_parser = ConfigParser()
             cfg_parser.read(pjoin(pkg_dir, '.git_commit_info.ini'))
             cfg_parser.set('commit hash', 'install_hash', repo_commit)
             out_pth = pjoin(self.build_lib, pkg_dir, '.git_commit_info.ini')
             out_file = open(out_pth, 'wt')
             cfg_parser.write(out_file)
             out_file.close()
     return MyBuildPy