Merge pull request #7027 from takluyver/svg2pdf-test-fix

Fix svg2pdf nbconvert preprocessor

IPython/nbconvert/preprocessors/convertfigures.py

@@ -1,64 +1,58 b''
 """Module containing a preprocessor that converts outputs in the notebook from 
 one format to another.
 """
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 from .base import Preprocessor
 from IPython.utils.traitlets import Unicode
 
 #-----------------------------------------------------------------------------
 # Classes
 #-----------------------------------------------------------------------------
 
 class ConvertFiguresPreprocessor(Preprocessor):
     """
     Converts all of the outputs in a notebook from one format to another.
     """
 
     from_format = Unicode(config=True, help='Format the converter accepts')
     to_format = Unicode(config=True, help='Format the converter writes')
 
     def __init__(self, **kw):
         """
         Public constructor
         """
         super(ConvertFiguresPreprocessor, self).__init__(**kw)
 
 
     def convert_figure(self, data_format, data):
         raise NotImplementedError()
 
 
     def preprocess_cell(self, cell, resources, cell_index):
         """
         Apply a transformation on each cell,
         
         See base.py
         """
 
         # Loop through all of the datatypes of the outputs in the cell.
-        for index, cell_out in enumerate(cell.get('outputs', [])):
-            for data_type, data in list(cell_out.items()):
-                # this must run *before* extract outputs,
-                # so figure_name and filename do not exist
-                self._convert_figure(cell_out, resources, data_type, data)
-        return cell, resources
+        for output in cell.get('outputs', []):
+            if output.output_type in {'execute_result', 'display_data'} \
+                    and self.from_format in output.data \
+                    and self.to_format not in output.data:
 
+                output.data[self.to_format] = self.convert_figure(
+                            self.from_format, output.data[self.from_format])
 
-    def _convert_figure(self, cell_out, resources, data_type, data):
-        """
-        Convert a figure and output the results to the cell output
-        """
-        if not self.to_format in cell_out and data_type == self.from_format:
-            data = self.convert_figure(data_type, data)
-            cell_out[self.to_format] = data
+        return cell, resources

IPython/nbconvert/preprocessors/svg2pdf.py

@@ -1,82 +1,82 b''
 """Module containing a preprocessor that converts outputs in the notebook from 
 one format to another.
 """
 
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
 
 import base64
 import io
 import os
 import sys
 import subprocess
 
 from IPython.utils.tempdir import TemporaryDirectory
 from IPython.utils.traitlets import Unicode
 
 from .convertfigures import ConvertFiguresPreprocessor
 
 
 INKSCAPE_APP = '/Applications/Inkscape.app/Contents/Resources/bin/inkscape'
 
 
 class SVG2PDFPreprocessor(ConvertFiguresPreprocessor):
     """
     Converts all of the outputs in a notebook from SVG to PDF.
     """
     
     def _from_format_default(self):
         return 'image/svg+xml'
     def _to_format_default(self):
         return 'application/pdf'
     
     command = Unicode(config=True,
         help="""The command to use for converting SVG to PDF
         
         This string is a template, which will be formatted with the keys
         to_filename and from_filename.
         
         The conversion call must read the SVG from {from_flename},
         and write a PDF to {to_filename}.
         """)
     
     def _command_default(self):
         return self.inkscape + \
                ' --without-gui --export-pdf="{to_filename}" "{from_filename}"'
     
     inkscape = Unicode(config=True, help="The path to Inkscape, if necessary")
     def _inkscape_default(self):
         if sys.platform == "darwin":
             if os.path.isfile(INKSCAPE_APP):
                 return INKSCAPE_APP
         return "inkscape"
 
 
     def convert_figure(self, data_format, data):
         """
         Convert a single SVG figure to PDF.  Returns converted data.
         """
 
         #Work in a temporary directory
         with TemporaryDirectory() as tmpdir:
             
             #Write fig to temp file
-            input_filename = os.path.join(tmpdir, 'figure.' + data_format)
+            input_filename = os.path.join(tmpdir, 'figure.svg')
             # SVG data is unicode text
             with io.open(input_filename, 'w', encoding='utf8') as f:
                 f.write(data)
 
             #Call conversion application
             output_filename = os.path.join(tmpdir, 'figure.pdf')
             shell = self.command.format(from_filename=input_filename, 
                                    to_filename=output_filename)
             subprocess.call(shell, shell=True) #Shell=True okay since input is trusted.
 
             #Read output from drive
             # return value expects a filename
             if os.path.isfile(output_filename):
                 with open(output_filename, 'rb') as f:
                     # PDF is a nb supported binary, data type, so base64 encode.
                     return base64.encodestring(f.read())
             else:
                 raise TypeError("Inkscape svg to pdf conversion failed")

IPython/nbconvert/preprocessors/tests/test_svg2pdf.py

@@ -1,74 +1,73 b''
 """Tests for the svg2pdf preprocessor"""
 
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
 
 from IPython.testing import decorators as dec
 from IPython.nbformat import v4 as nbformat
 
 from .base import PreprocessorTestsBase
 from ..svg2pdf import SVG2PDFPreprocessor
 
 
 class Testsvg2pdf(PreprocessorTestsBase):
     """Contains test functions for svg2pdf.py"""
 
     simple_svg = """<?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <!-- Created with Inkscape (http://www.inkscape.org/) -->
 <svg
    xmlns:svg="http://www.w3.org/2000/svg"
    xmlns="http://www.w3.org/2000/svg"
    version="1.0"
    x="0.00000000"
    y="0.00000000"
    width="500.00000"
    height="500.00000"
    id="svg2">
   <defs
      id="defs4" />
   <g
      id="layer1">
     <rect
        width="300.00000"
        height="300.00000"
        x="100.00000"
        y="100.00000"
        style="opacity:1.0000000;fill:none;fill-opacity:1.0000000;fill-rule:evenodd;stroke:#000000;stroke-width:8.0000000;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4.0000000;stroke-dasharray:none;stroke-dashoffset:0.00000000;stroke-opacity:1.0000000"
        id="rect5719" />
   </g>
 </svg>"""
 
     def build_notebook(self):
         """Build a reveal slides notebook in memory for use with tests.
         Overrides base in PreprocessorTestsBase"""
 
-        outputs = [nbformat.new_output(output_type="image/svg+xml", output_svg=self.simple_svg)]
-        
-        slide_metadata = {'slideshow' : {'slide_type': 'slide'}}
-        subslide_metadata = {'slideshow' : {'slide_type': 'subslide'}}
+        outputs = [nbformat.new_output(output_type='display_data',
+                                       data={'image/svg+xml':self.simple_svg})
+                  ]
 
         cells=[nbformat.new_code_cell(source="", execution_count=1, outputs=outputs)]
 
         return nbformat.new_notebook(cells=cells)
 
 
     def build_preprocessor(self):
         """Make an instance of a preprocessor"""
         preprocessor = SVG2PDFPreprocessor()
         preprocessor.enabled = True
         return preprocessor
 
 
     def test_constructor(self):
         """Can a SVG2PDFPreprocessor be constructed?"""
         self.build_preprocessor()
 
 
     @dec.onlyif_cmds_exist('inkscape')
     def test_output(self):
         """Test the output of the SVG2PDFPreprocessor"""
         nb = self.build_notebook()
         res = self.build_resources()
         preprocessor = self.build_preprocessor()
         nb, res = preprocessor(nb, res)
-        self.assertIn('application/pdf', nb.cells[0].outputs[0])
+        self.assertIn('application/pdf', nb.cells[0].outputs[0].data)