use custom renderer for sphinx-gallery

Author: emmanuelle

examples/plot_plotly.py

@@ -31,6 +31,6 @@
     name='Below',
 )
 
-data = [trace_0, trace_1]
-res = plotly.offline.plot(data)
+fig = go.Figure(data=[trace_0, trace_1])
+plotly.io.show(fig)
 

examples/plot_plotly_3d.py

@@ -28,4 +28,4 @@
     )
 )
 fig = go.Figure(data=data, layout=layout)
-plotly.offline.plot(fig)
+plotly.io.show(fig)

plotly/io/_base_renderers.py

@@ -6,10 +6,12 @@
 import os
 
 import six
-from plotly.io import to_json, to_image
+from plotly.io import to_json, to_image, write_image
 from plotly import utils, optional_imports
 from plotly.io._orca import ensure_server
 from plotly.offline.offline import _get_jconfig, get_plotlyjs
+from plotly.offline import plot
+from plotly.tools import return_figure_from_figure_or_data 
 
 ipython_display = optional_imports.get_module('IPython.display')
 IPython = optional_imports.get_module('IPython')
@@ -631,3 +633,21 @@ def render(self, fig_dict):
             default_height='100%',
         )
         open_html_in_browser(html, self.using, self.new, self.autoraise)
+
+
+class SphinxGalleryRenderer(ExternalRenderer):
+
+    def render(self, fig_dict):
+        stack = inspect.stack()
+        # Name of script from which plot function was called is retrieved
+        try:
+            filename = stack[3].filename # let's hope this is robust...
+        except: #python 2
+            filename = stack[3][1]
+        filename_root, _ = os.path.splitext(filename)
+        filename_html = filename_root + '.html'
+        filename_png = filename_root + '.png'
+        figure = return_figure_from_figure_or_data(fig_dict, True)
+        _ = plot(fig_dict, auto_open=False,
+                 filename=filename_html)
+        write_image(figure, filename_png)

plotly/io/_renderers.py

@@ -12,7 +12,8 @@
 from plotly.io._base_renderers import (
     MimetypeRenderer, ExternalRenderer, PlotlyRenderer, NotebookRenderer,
     KaggleRenderer, ColabRenderer, JsonRenderer, PngRenderer, JpegRenderer,
-    SvgRenderer, PdfRenderer, BrowserRenderer, IFrameRenderer)
+    SvgRenderer, PdfRenderer, BrowserRenderer, IFrameRenderer,
+    SphinxGalleryRenderer)
 from plotly.io._utils import validate_coerce_fig_to_dict
 
 ipython = optional_imports.get_module('IPython')
@@ -394,6 +395,7 @@ def show(fig, renderer=None, validate=True, **kwargs):
 renderers['chrome'] = BrowserRenderer(config=config, using='chrome')
 renderers['chromium'] = BrowserRenderer(config=config, using='chromium')
 renderers['iframe'] = IFrameRenderer(config=config)
+renderers['sphinx'] = SphinxGalleryRenderer()
 
 # Set default renderer
 # --------------------

plotly/io/_sg_scraper.py

@@ -6,32 +6,10 @@
 import inspect, os
 
 import plotly
-plotly_plot = plotly.offline.plot
 from glob import glob
 import shutil
 
-def _patched_plotly_plot(*args, **kwargs):
-    """
-    Monkey-patched version of plotly.offline.plot, in order to save
-    html file with the same name as python script. Also, a static
-    png file is saved.
-    """
-    stack = inspect.stack()
-    # Name of script from which plot function was called is retrieved
-    try:
-        filename = stack[1].filename # let's hope this is robust...
-    except: #python 2
-        filename = stack[1][1]
-    filename_root, _ = os.path.splitext(filename)
-    filename_html = filename_root + '.html'
-    filename_png = filename_root + '.png'
-    figure = plotly.tools.return_figure_from_figure_or_data(args[0], True)
-    res = plotly_plot(*args, auto_open=False,
-		    filename=filename_html)
-    plotly.io.write_image(figure, filename_png)
-    return res
-
-plotly.offline.plot = _patched_plotly_plot
+plotly.io.renderers.default = 'sphinx' 
 
 
 def plotly_sg_scraper(block, block_vars, gallery_conf, **kwargs):

plotly/tests/test_orca/test_sg_scraper.py

@@ -1,5 +1,4 @@
 import plotly
-plotly_plot = plotly.offline.plot
 import os
 import shutil
 import pytest
@@ -39,25 +38,23 @@ def execute_plotly_example():
         name='Above',
     )
 
-    data = [trace_0]
-    res = plotly.offline.plot(data)
+    fig = go.Figure(data=[trace_0])
+    plotly.io.show(fig)
 
 
-def test_monkey_patching():
+def test_scraper():
     from plotly.io._sg_scraper import plotly_sg_scraper
     # test that monkey-patching worked ok
-    assert plotly_plot != plotly.offline.plot
+    assert plotly.io.renderers.default == 'sphinx'
     # Use dummy values for arguments of plotly_sg_scraper
     block = '' # we don't need actually code
     import tempfile
     tempdir = tempfile.mkdtemp()
     gallery_conf = {'src_dir':tempdir,
-                    'examples_dirs':'plotly/tests/test_io'}
+                    'examples_dirs':'plotly/tests/test_orca'}
     names = iter(['0', '1', '2'])
     block_vars = {'image_path_iterator':names}
     execute_plotly_example()
     res = plotly_sg_scraper(block, block_vars, gallery_conf)
     shutil.rmtree(tempdir)
     assert ".. raw:: html" in res
-    plotly.offline.plot = plotly_plot
-    assert plotly_plot == plotly.offline.plot