upstream/ipython Commit - r6261:0e8f2cf0

Add argument parsing, and ability to convert an HTML file from command line

Anton I. Sipos -

r6261:0e8f2cf0

parent child

README.rst

0 +5 0

                 $ curl http://docutils.svn.sourceforge.net/viewvc/docutils/trunk/docutils/?view=tar > docutils.gz
                 $ pip install -U docutils.gz
+            For conversion to HTML, pygments is also required
+            ::
+                $ pip install pygments
             Running Tests
             =============
             ::

nbconvert.py

0 +38 -21

             import os
             import subprocess
             import sys
+            import argparse
             from IPython.nbformat import current as nbformat
             from IPython.utils.text import indent
             # Converters for parts of a cell.
             class ConversionException(Exception):
                 pass
             class Converter(object):
                 default_encoding = 'utf-8'
-                def __init__(self, fname):
+                def __init__(self, infile):
-                    self.fname = fname
+                    self.infile = infile
-                    self.dirpath = os.path.dirname(fname)
+                    self.dirpath = os.path.dirname(infile)
                 @property
                 def extension(self):
                     return '\n'.join(lines)
                 def render(self):
-                    "read, convert, and save self.fname"
+                    "read, convert, and save self.infile"
                     self.read()
                     self.output = self.convert()
                     return self.save()
                 def read(self):
                     "read and parse notebook into NotebookNode called self.nb"
-                    with open(self.fname) as f:
+                    with open(self.infile) as f:
                         self.nb = nbformat.read(f, 'json')
-                def save(self, fname=None, encoding=None):
+                def save(self, infile=None, encoding=None):
                     "read and parse notebook into self.nb"
-                    if fname is None:
+                    if infile is None:
-                        fname = os.path.splitext(self.fname)[0] + '.' + self.extension
+                        infile = os.path.splitext(self.infile)[0] + '.' + self.extension
                     if encoding is None:
                         encoding = self.default_encoding
-                    with open(fname, 'w') as f:
+                    with open(infile, 'w') as f:
                         f.write(self.output.encode(encoding))
-                    return fname
+                    return infile
                 def render_heading(self, cell):
                     raise NotImplementedError
                     lines = []
                     if 'png' in output:
-                        fname = 'nb_figure_%s.png' % self.figures_counter
+                        infile = 'nb_figure_%s.png' % self.figures_counter
-                        fullname = os.path.join(self.dirpath, fname)
+                        fullname = os.path.join(self.dirpath, infile)
                         with open(fullname, 'w') as f:
                             f.write(output.png.decode('base64'))
                         self.figures_counter += 1
-                        lines.append('.. image:: %s' % fname)
+                        lines.append('.. image:: %s' % infile)
                         lines.append('')
                     return lines
                     return lines
-            def rst2simplehtml(fname):
+            def rst2simplehtml(infile):
                 """Convert a rst file to simplified html suitable for blogger.
                 This just runs rst2html with certain parameters to produce really simple
                                 "--no-toc-backlinks --no-section-numbering "
                                 "--strip-comments ")
-                cmd = "%s %s" % (cmd_template, fname)
+                cmd = "%s %s" % (cmd_template, infile)
                 proc = subprocess.Popen(cmd,
                                         stdout=subprocess.PIPE,
                                         stderr=subprocess.PIPE,
                     if line.startswith('<body>'):
                         break
-                newfname = os.path.splitext(fname)[0] + '.html'
+                newfname = os.path.splitext(infile)[0] + '.html'
                 with open(newfname, 'w') as f:
                     for line in walker:
                         if line.startswith('</body>'):
                 return newfname
-            def main(fname):
+            def main(infile, format='rst'):
                 """Convert a notebook to html in one step"""
-                converter = ConverterRST(fname)
+                if format == 'rst':
-                converter.render()
+                    converter = ConverterRST(infile)
+                    converter.render()
+                elif format == 'html':
+                    #Currently, conversion to html is a 2 step process, nb->rst->html
+                    converter = ConverterRST(infile)
+                    rstfname = converter.render()
+                    rst2simplehtml(rstfname)
             if __name__ == '__main__':
-                main(sys.argv[1])
+                parser = argparse.ArgumentParser(description='nbconvert: Convert IPython notebooks to other formats')
+                # TODO: consider passing file like object around, rather than filenames
+                # would allow us to process stdin, or even http streams
+                #parser.add_argument('infile', nargs='?', type=argparse.FileType('r'), default=sys.stdin)
+                #Require a filename as a positional argument
+                parser.add_argument('infile', nargs=1)
+                parser.add_argument('-f', '--format', default='rst')
+                args = parser.parse_args()
+                main(infile=args.infile[0], format=args.format)

tests/test_simple.py

0 +19 -6

                 "Remove .rst files created during conversion"
                 map(os.remove, glob.glob("./tests/*.rst"))
                 map(os.remove, glob.glob("./tests/*.png"))
+                map(os.remove, glob.glob("./tests/*.html"))
             @nt.with_setup(clean_dir, clean_dir)
             def test_simple():
                 f = c.render()
                 nt.assert_true('rst' in f, 'changed file extension to rst')
             @nt.with_setup(clean_dir, clean_dir)
             def test_main():
                 """
                 main(fname)
                 nt.assert_true(os.path.exists(out_fname))
             def test_render_heading():
                 """ Unit test for cell type "heading" """
                 # Generate and test heading cells level 1-6
-                for level in xrange(1,7):
+                for level in xrange(1, 7):
                     cell = {
                         'cell_type': 'heading',
                         'level'    : level,
                         'source'   :  ['Test for heading type H{0}'.format(level)]
                         }
                     # Convert cell dictionaries to NotebookNode
                     cell_nb = nbformat.NotebookNode(cell)
                     # Render to rst
                     c = ConverterRST('')
                     rst_list = c.render_heading(cell_nb)
-                    nt.assert_true(isinstance(rst_list,list)) # render should return a list
+                    nt.assert_true(isinstance(rst_list, list))  # render should return a list
                     rst_str = "".join(rst_list)
                     # Confirm rst content
-                    heading_level = {1:'=', 2:'-', 3:'`', 4:'\'', 5:'.',6:'~'}
+                    heading_level = {1: '=', 2: '-', 3: '`', 4: '\'', 5: '.', 6: '~'}
                     chk_str = "Test for heading type H{0}\n{1}\n".format(
-                         level,heading_level[level]*24)
+                         level, heading_level[level] * 24)
-                    nt.assert_equal(rst_str,chk_str)
+                    nt.assert_equal(rst_str, chk_str)
+            @nt.with_setup(clean_dir, clean_dir)
+            def test_main_html():
+                """
+                Test main entry point
+                """
+                main(fname, format='html')
+                nt.assert_true(os.path.exists('tests/test.html'))

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages