Merge pull request #5636 from jvns/clear-output-preprocessor

Add preprocessor that clears cell outputs

IPython/nbconvert/preprocessors/clearoutput.py

@@ -0,0 +1,27
+"""Module containing a preprocessor that removes the outputs from code cells"""
+
+# Copyright (c) IPython Development Team.
+# Distributed under the terms of the Modified BSD License.
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
+
+from .base import Preprocessor
+
+
+#-----------------------------------------------------------------------------
+# Classes
+#-----------------------------------------------------------------------------
+class ClearOutputPreprocessor(Preprocessor):
+    """
+    Removes the output from all code cells in a notebook.
+    """
+
+    def preprocess_cell(self, cell, resources, cell_index):
+        """
+        Apply a transformation on each cell. See base.py for details.
+        """
+        if cell.cell_type == 'code':
+            cell.outputs = []
+        return cell, resources

IPython/nbconvert/preprocessors/tests/test_clearoutput.py

@@ -0,0 +1,41
+"""
+Module with tests for the clearoutput preprocessor.
+"""
+
+# Copyright (c) IPython Development Team.
+# Distributed under the terms of the Modified BSD License.
+
+#-----------------------------------------------------------------------------
+# Imports
+#-----------------------------------------------------------------------------
+from IPython.nbformat import current as nbformat
+
+from .base import PreprocessorTestsBase
+from ..clearoutput import ClearOutputPreprocessor
+
+
+#-----------------------------------------------------------------------------
+# Class
+#-----------------------------------------------------------------------------
+
+class TestClearOutput(PreprocessorTestsBase):
+    """Contains test functions for clearoutput.py"""
+
+
+    def build_preprocessor(self):
+        """Make an instance of a preprocessor"""
+        preprocessor = ClearOutputPreprocessor()
+        preprocessor.enabled = True
+        return preprocessor
+
+    def test_constructor(self):
+        """Can a ClearOutputPreprocessor be constructed?"""
+        self.build_preprocessor()
+
+    def test_output(self):
+        """Test the output of the ClearOutputPreprocessor"""
+        nb = self.build_notebook()
+        res = self.build_resources()
+        preprocessor = self.build_preprocessor()
+        nb, res = preprocessor(nb, res)
+        assert nb.worksheets[0].cells[0].outputs == []

docs/source/whatsnew/pr/clear-output-preprocessor

@@ -0,0 +1,1
+Adds an optional preprocessor step to `nbconvert` called `ClearOutputPreprocessor`. This clears the output from IPython notebooks.

IPython/nbconvert/exporters/exporter.py

@@ -70,6 +70,7 class Exporter(LoggingConfigurable):
                                   'IPython.nbconvert.preprocessors.CSSHTMLHeaderPreprocessor',
                                   'IPython.nbconvert.preprocessors.RevealHelpPreprocessor',
                                   'IPython.nbconvert.preprocessors.LatexPreprocessor',
+                                  'IPython.nbconvert.preprocessors.ClearOutputPreprocessor',
                                   'IPython.nbconvert.preprocessors.HighlightMagicsPreprocessor'],
         config=True,
         help="""List of preprocessors available by default, by name, namespace, 

IPython/nbconvert/preprocessors/__init__.py

@@ -7,6 +7,7 from .revealhelp import RevealHelpPreprocessor
 from .latex import LatexPreprocessor
 from .csshtmlheader import CSSHTMLHeaderPreprocessor
 from .highlightmagics import HighlightMagicsPreprocessor
+from .clearoutput import ClearOutputPreprocessor
 
 # decorated function Preprocessors
 from .coalescestreams import coalesce_streams