Merge pull request plotly#469 from plotly/offline-fixes

V1.10.0 - Inject plotly.js into the output cell on every `init_notebook_mode` call

Author: Kevin Yan

CHANGELOG.md

@@ -4,6 +4,22 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [1.10.0] - 2016-05-19
+### Fixed
+Version 1.9.13 fixed an issue in offline mode where if you ran `init_notebook_mode`
+more than once the function would skip importing (because it saw that it had
+already imported the library) but then accidentally clear plotly.js from the DOM.
+This meant that if you ran `init_notebook_mode` more than once, your graphs would
+not appear when you refreshed the page.
+Version 1.9.13 solved this issue by injecting plotly.js with every iplot call.
+While this works, it also injects the library excessively, causing notebooks
+to have multiple versions of plotly.js inline in the DOM, potentially making
+notebooks with many `iplot` calls very large.
+Version 1.10.0 brings back the requirement to call `init_notebook_mode` before
+making an `iplot` call. It makes `init_notebook_mode` idempotent: you can call
+it multiple times without worrying about losing your plots on refresh.
+
+
 ## [1.9.13] - 2016-05-19
 ### Fixed
 - Fixed issue in offline mode related to the inability to reload plotly.js on page refresh and extra init_notebook_mode calls.

plotly/offline/offline.py

@@ -14,6 +14,7 @@
 
 import plotly
 from plotly import tools, utils
+from plotly.exceptions import PlotlyError
 
 try:
     import IPython
@@ -28,6 +29,7 @@
 except ImportError:
     _matplotlib_imported = False
 
+__PLOTLY_OFFLINE_INITIALIZED = False
 
 def download_plotlyjs(download_url):
     warnings.warn('''
@@ -50,16 +52,11 @@ def init_notebook_mode():
     yet. This is an idempotent method and can and should be called from any
     offline methods that require plotly.js to be loaded into the notebook dom.
     """
-    warnings.warn('''
-        `init_notebook_mode` is deprecated and will be removed in the
-        next release. Notebook mode is now automatically initialized when
-        notebook methods are invoked, so it is no
-        longer necessary to manually initialize.
-    ''', DeprecationWarning)
-
     if not _ipython_imported:
         raise ImportError('`iplot` can only run inside an IPython Notebook.')
 
+    global __PLOTLY_OFFLINE_INITIALIZED
+    # Inject plotly.js into the output cell
     script_inject = (
         ''
         '<script type=\'text/javascript\'>'
@@ -68,14 +65,14 @@ def init_notebook_mode():
         '{script}'
         '}});'
         'require([\'plotly\'], function(Plotly) {{'
-        'console.log(Plotly);'
         'window.Plotly = Plotly;'
         '}});'
         '}}'
         '</script>'
         '').format(script=get_plotlyjs())
 
     display(HTML(script_inject))
+    __PLOTLY_OFFLINE_INITIALIZED = True
 
 
 def _plot_html(figure_or_data, show_link, link_text,
@@ -177,13 +174,22 @@ def iplot(figure_or_data, show_link=True, link_text='Export to plot.ly',
 
     Example:
     ```
-    from plotly.offline import iplot
-
+    from plotly.offline import init_notebook_mode, iplot
+    init_notebook_mode()
     iplot([{'x': [1, 2, 3], 'y': [5, 2, 7]}])
     ```
     """
-
-    init_notebook_mode()
+    if not __PLOTLY_OFFLINE_INITIALIZED:
+        raise PlotlyError('\n'.join([
+            'Plotly Offline mode has not been initialized in this notebook. '
+            'Run: ',
+            '',
+            'import plotly',
+            'plotly.offline.init_notebook_mode() '
+            '# run at the start of every ipython notebook',
+        ]))
+    if not tools._ipython_imported:
+        raise ImportError('`iplot` can only run inside an IPython Notebook.')
 
     plot_html, plotdivid, width, height = _plot_html(
         figure_or_data, show_link, link_text, validate,
@@ -415,19 +421,18 @@ def iplot_mpl(mpl_fig, resize=False, strip_style=False,
 
     Example:
     ```
-    from plotly.offline import iplot_mpl
+    from plotly.offline import init_notebook_mode, iplot_mpl
     import matplotlib.pyplot as plt
 
     fig = plt.figure()
     x = [10, 15, 20, 25, 30]
     y = [100, 250, 200, 150, 300]
     plt.plot(x, y, "o")
 
+    init_notebook_mode()
     iplot_mpl(fig)
     ```
     """
-    init_notebook_mode()
-
     plotly_plot = tools.mpl_to_plotly(mpl_fig, resize, strip_style, verbose)
     return iplot(plotly_plot, show_link, link_text, validate)
 

plotly/tests/test_optional/test_offline/test_offline.py

@@ -29,7 +29,8 @@ class PlotlyOfflineTestCase(TestCase):
     def setUp(self):
         pass
 
-    def test_iplot_works_wihout_calling_init_notebook_mode(self):
+    @raises(plotly.exceptions.PlotlyError)
+    def test_iplot_doesnt_work_before_you_call_init_notebook_mode(self):
         plotly.offline.iplot([{}])
 
     def test_iplot_works_after_you_call_init_notebook_mode(self):
@@ -86,4 +87,3 @@ def test_default_mpl_plot_generates_expected_html(self):
         self.assertTrue(PLOTLYJS in html)         # and the source code
         # and it's an <html> doc
         self.assertTrue(html.startswith('<html>') and html.endswith('</html>'))
-

plotly/version.py

@@ -1 +1 @@
-__version__ = '1.9.13'
+__version__ = '1.10.0'