New .py notebook format implemented.

IPython/nbformat/v2/nbbase.py

@@ -66,7 +66,7 def new_code_cell(input=None, prompt_number=None, outputs=None,
     else:
         cell.outputs = outputs
     if collapsed is not None:
-        cell.collapsed = collapsed
+        cell.collapsed = bool(collapsed)
 
     return cell
 
@@ -93,7 +93,8 def new_worksheet(name=None, cells=None):
     return ws
 
 
-def new_notebook(name=None, id=None, worksheets=None):
+def new_notebook(name=None, id=None, worksheets=None, author=None, email=None,
+    created=None, saved=None, license=None):
     """Create a notebook by name, id and a list of worksheets."""
     nb = NotebookNode()
     nb.nbformat = 2
@@ -107,5 +108,15 def new_notebook(name=None, id=None, worksheets=None):
         nb.worksheets = []
     else:
         nb.worksheets = list(worksheets)
+    if author is not None:
+        nb.author = unicode(author)
+    if email is not None:
+        nb.email = unicode(email)
+    if created is not None:
+        nb.created = unicode(created)
+    if saved is not None:
+        nb.saved = unicode(saved)
+    if license is not None:
+        nb.license = unicode(license)
     return nb
 

IPython/nbformat/v2/nbpy.py

@@ -1,7 +1,7
 """Read and write notebooks as regular .py files."""
 
 from .rwbase import NotebookReader, NotebookWriter
-from .nbbase import new_code_cell, new_worksheet, new_notebook
+from .nbbase import new_code_cell, new_text_cell, new_worksheet, new_notebook
 
 
 class PyReaderError(Exception):
@@ -17,39 +17,64 class PyReader(NotebookReader):
         lines = s.splitlines()
         cells = []
         cell_lines = []
-        code_cell = False
+        state = u'codecell'
         for line in lines:
             if line.startswith(u'# <nbformat>'):
                 pass
             elif line.startswith(u'# <codecell>'):
-                if code_cell:
-                    raise PyReaderError('Unexpected <codecell>')
-                # We can't use the ast to split blocks because there can be
-                # IPython syntax in the files.
-                # if cell_lines:
-                #     for block in self.split_lines_into_blocks(cell_lines):
-                #         cells.append(new_code_cell(input=block))
+                cell = self.new_cell(state, cell_lines)
+                if cell is not None:
+                    cells.append(cell)
+                state = u'codecell'
+                cell_lines = []
+            elif line.startswith(u'# <htmlcell>'):                
+                cell = self.new_cell(state, cell_lines)
+                if cell is not None:
+                    cells.append(cell)
+                state = u'htmlcell'
+                cell_lines = []
+            elif line.startswith(u'# <markdowncell>'):
+                cell = self.new_cell(state, cell_lines)
+                if cell is not None:
+                    cells.append(cell)
+                state = u'markdowncell'
                 cell_lines = []
-                code_cell = True
-            elif line.startswith(u'# </codecell>'):
-                if not code_cell:
-                    raise PyReaderError('Unexpected </codecell>')
-                code = u'\n'.join(cell_lines)
-                code = code.strip(u'\n')
-                if code:
-                    cells.append(new_code_cell(input=code))
-                code_cell = False
             else:
                 cell_lines.append(line)
-        # We can't use the ast to split blocks because there can be
-        # IPython syntax in the files.
-        # if cell_lines:
-        #     for block in self.split_lines_into_blocks(cell_lines):
-        #         cells.append(new_code_cell(input=block))
+        if cell_lines and state == u'codecell':
+            cell = self.new_cell(state, cell_lines)
+            if cell is not None:
+                cells.append(cell)
         ws = new_worksheet(cells=cells)
         nb = new_notebook(worksheets=[ws])
         return nb
 
+    def new_cell(self, state, lines):
+        if state == u'codecell':
+            input = u'\n'.join(lines)
+            input = input.strip(u'\n')
+            if input:
+                return new_code_cell(input=input)
+        elif state == u'htmlcell':
+            text = self._remove_comments(lines)
+            if text:
+                return new_text_cell(u'html',source=text)
+        elif state == u'markdowncell':
+            text = self._remove_comments(lines)
+            if text:
+                return new_text_cell(u'markdown',source=text)
+
+    def _remove_comments(self, lines):
+        new_lines = []
+        for line in lines:
+            if line.startswith(u'#'):
+                new_lines.append(line[2:])
+            else:
+                new_lines.append(line)
+        text = u'\n'.join(new_lines)
+        text = text.strip(u'\n')
+        return text
+
     def split_lines_into_blocks(self, lines):
         if len(lines) == 1:
             yield lines[0]
@@ -67,15 +92,27 class PyWriter(NotebookWriter):
 
     def writes(self, nb, **kwargs):
         lines = []
-        lines.extend(['# <nbformat>2</nbformat>',''])
+        lines.extend([u'# <nbformat>2</nbformat>',''])
         for ws in nb.worksheets:
             for cell in ws.cells:
-                if cell.cell_type == 'code':
-                    input = cell.get('input')
+                if cell.cell_type == u'code':
+                    input = cell.get(u'input')
                     if input is not None:
                         lines.extend([u'# <codecell>',u''])
                         lines.extend(input.splitlines())
-                        lines.extend([u'',u'# </codecell>'])
+                        lines.append(u'')
+                elif cell.cell_type == u'html':
+                    input = cell.get(u'source')
+                    if input is not None:
+                        lines.extend([u'# <htmlcell>',u''])
+                        lines.extend([u'# ' + line for line in input.splitlines()])
+                        lines.append(u'')
+                elif cell.cell_type == u'markdown':
+                    input = cell.get(u'source')
+                    if input is not None:
+                        lines.extend([u'# <markdowncell>',u''])
+                        lines.extend([u'# ' + line for line in input.splitlines()])
+                        lines.append(u'')
         lines.append('')
         return unicode('\n'.join(lines))
 

IPython/nbformat/v2/nbxml.py

@@ -92,6 +92,11 class XMLReader(NotebookReader):
     def to_notebook(self, root, **kwargs):
         nbname = _get_text(root,'name')
         nbid = _get_text(root,'id')
+        nbauthor = _get_text(root,'author')
+        nbemail = _get_text(root,'email')
+        nblicense = _get_text(root,'license')
+        nbcreated = _get_text(root,'created')
+        nbsaved = _get_text(root,'saved')
         
         worksheets = []
         for ws_e in root.find('worksheets').getiterator('worksheet'):
@@ -136,7 +141,8 class XMLReader(NotebookReader):
             ws = new_worksheet(name=wsname,cells=cells)
             worksheets.append(ws)
 
-        nb = new_notebook(name=nbname,id=nbid,worksheets=worksheets)
+        nb = new_notebook(name=nbname,id=nbid,worksheets=worksheets,author=nbauthor,
+            email=nbemail,license=nblicense,saved=nbsaved,created=nbcreated)
         return nb
 
 
@@ -146,6 +152,11 class XMLWriter(NotebookWriter):
         nb_e = ET.Element('notebook')
         _set_text(nb,'name',nb_e,'name')
         _set_text(nb,'id',nb_e,'id')
+        _set_text(nb,'author',nb_e,'author')
+        _set_text(nb,'email',nb_e,'email')
+        _set_text(nb,'license',nb_e,'license')
+        _set_text(nb,'created',nb_e,'created')
+        _set_text(nb,'saved',nb_e,'saved')
         _set_int(nb,'nbformat',nb_e,'nbformat')
         wss_e = ET.SubElement(nb_e,'worksheets')
         for ws in nb.worksheets:

IPython/nbformat/v2/tests/nbexamples.py

@@ -22,8 +22,8 ws.cells.append(new_code_cell(
 
 ws.cells.append(new_text_cell(
     u'markdown',
-    source='Some NumPy Examples',
-    rendered='Some NumPy Examples'
+    source='A random array',
+    rendered='A random array'
 ))
 
 ws.cells.append(new_code_cell(
@@ -63,26 +63,36 ws.cells.append(new_code_cell(
 
 nb0 = new_notebook(
     name='nb0',
-    worksheets=[ws, new_worksheet(name='worksheet2')]
+    worksheets=[ws, new_worksheet(name='worksheet2')],
+    author='Bart Simpson',
+    email='[e-mail]',
+    saved='ISO8601_goes_here',
+    created='ISO8601_goes_here',
+    license='BSD'
 )
 
 nb0_py = """# <nbformat>2</nbformat>
 
+# <htmlcell>
+
+# Some NumPy Examples
+
 # <codecell>
 
 import numpy
 
-# </codecell>
+# <markdowncell>
+
+# A random array
+
 # <codecell>
 
 a = numpy.random.rand(100)
 
-# </codecell>
 # <codecell>
 
 print a
 
-# </codecell>
 """