Merge pull request #73 from jbweston/feature/disable-stderr

make stderr a warning and not an exception by default

Author: akhmerov

jupyter_sphinx/execute.py

@@ -379,8 +379,8 @@ def apply(self):
                           if output['output_type'] == 'stream'
                              and output['name'] == 'stderr']
                 if stderr and not node.attributes['stderr']:
-                    raise ExtensionError('Cell printed to stderr:\n{}'
-                                         .format(stderr[0]['text']))
+                    logger.warning('Cell printed to stderr:\n{}'
+                                   .format(stderr[0]['text']))
 
             try:
                 lexer = notebook.metadata.language_info.pygments_lexer
@@ -407,6 +407,7 @@ def apply(self):
                 output_nodes = cell_output_to_nodes(
                     cell,
                     self.config.jupyter_execute_data_priority,
+                    bool(node.attributes["stderr"]),
                     sphinx_abs_dir(self.env),
                     thebe_config
                 )
@@ -463,14 +464,16 @@ def count(x):
     return (list(x) for _, x in groupby(it, count))
 
 
-def cell_output_to_nodes(cell, data_priority, dir, thebe_config):
+def cell_output_to_nodes(cell, data_priority, write_stderr, dir, thebe_config):
     """Convert a jupyter cell with outputs and filenames to doctree nodes.
 
     Parameters
     ----------
     cell : jupyter cell
     data_priority : list of mime types
         Which media types to prioritize.
+    write_stderr : bool
+        If True include stderr in cell output
     dir : string
         Sphinx "absolute path" to the output folder, so it is a relative path
         to the source folder prefixed with ``/``.
@@ -483,6 +486,8 @@ def cell_output_to_nodes(cell, data_priority, dir, thebe_config):
         if (
             output_type == 'stream'
         ):
+            if not write_stderr and output["name"] == "stderr":
+                continue
             to_add.append(docutils.nodes.literal_block(
                 text=output['text'],
                 rawsource=output['text'],

tests/test_execute.py

@@ -26,20 +26,27 @@ def doctree():
     apps = []
     syspath = sys.path[:]
 
-    def doctree(source, config=None):
+    def doctree(source, config=None, return_warnings=False):
         src_dir = tempfile.mkdtemp()
         source_trees.append(src_dir)
         with open(os.path.join(src_dir, 'conf.py'), 'w') as f:
             f.write("extensions = ['jupyter_sphinx.execute']")
             if config is not None:
                 f.write('\n' + config)
-        with open(os.path.join(src_dir, 'index.rst'), 'w') as f:
+        with open(os.path.join(src_dir, 'contents.rst'), 'w') as f:
             f.write(source)
+        warnings = StringIO()
         app = SphinxTestApp(srcdir=path(src_dir), status=StringIO(),
-                            warning=StringIO())
+                            warning=warnings)
         apps.append(app)
         app.build()
-        return app.env.get_doctree('index')
+
+        doctree = app.env.get_doctree("contents")
+
+        if return_warnings:
+            return doctree, warnings.getvalue()
+        else:
+            return doctree
 
     yield doctree
 
@@ -217,8 +224,11 @@ def test_stderr(doctree):
         import sys
         print('hello world', file=sys.stderr)
     """
-    with pytest.raises(ExtensionError):
-        tree = doctree(source)
+
+    tree, warnings = doctree(source, return_warnings=True)
+    assert "hello world" in warnings
+    cell, = tree.traverse(JupyterCellNode)
+    assert len(cell.children) == 1  # no output
 
     source = """
     .. jupyter-execute::