Added serve_plotlyjs_from_directory() instead of kwarg to separate html and js into two files

Author: Christian Fufezan

plotly/offline/__init__.py

@@ -10,5 +10,6 @@
     iplot,
     iplot_mpl,
     plot,
-    plot_mpl
+    plot_mpl,
+    serve_plotlyjs_from_directory
 )

plotly/offline/offline.py

@@ -31,6 +31,7 @@
     _matplotlib_imported = False
 
 __PLOTLY_OFFLINE_INITIALIZED = False
+__SERVE_PLOTLYJS_FROM_DIRECTORY = False
 
 
 def download_plotlyjs(download_url):
@@ -42,15 +43,29 @@ def download_plotlyjs(download_url):
     pass
 
 
-def get_plotlyjs( outsource_plotly = False ):
-    if outsource_plotly:
+def get_plotlyjs():
+    global __SERVE_PLOTLYJS_FROM_DIRECTORY
+    if __SERVE_PLOTLYJS_FROM_DIRECTORY:
         plotlyjs = '</script><script src="plotly.min.js">'
     else:
         path = os.path.join('offline', 'plotly.min.js')
         plotlyjs = resource_string('plotly', path).decode('utf-8')
     return plotlyjs
 
 
+def serve_plotlyjs_from_directory():
+    """
+    Sets global plotly.offline.__SERVE_PLOTLYJS_FROM_DIRECTORY to True,
+    which will trigger the separation of the html and the plotly.min.js
+    into two files. This will reduce the overall space required
+    if muliple plots are created in the same directory, since only one
+    copy of plotly.min.js will be stored.
+    """
+    global __SERVE_PLOTLYJS_FROM_DIRECTORY
+    __SERVE_PLOTLYJS_FROM_DIRECTORY = True
+    return
+
+
 def init_notebook_mode(connected=False):
     """
     Initialize plotly.js in the browser if it hasn't been loaded into the DOM
@@ -247,7 +262,7 @@ def plot(figure_or_data,
          include_plotlyjs=True,
          filename='temp-plot.html',
          auto_open=True,
-         outsource_plotly=False):
+         ):
     """ Create a plotly graph locally as an HTML document or string.
 
     Example:
@@ -293,10 +308,6 @@ def plot(figure_or_data,
     auto_open (default=True) -- If True, open the saved file in a
         web browser after saving.
         This argument only applies if `output_type` is 'file'.
-    outsource_plotly (default=False) -- If True, the javascript library will
-        be copied into a separate file, thereby reducing the file size for the
-        actual plat significantly. This is handy if several plots are created
-        in the same folder.
     """
     if output_type not in ['div', 'file']:
         raise ValueError(
@@ -328,15 +339,19 @@ def plot(figure_or_data,
             os.path.dirname(__file__), 'plotly.min.js'
         )
         # src_path = resource_string('plotly', path)
-        dest_path = os.path.join( os.path.dirname( filename ), 'plotly.min.js')
-        if os.path.exists( dest_path ) is False:
-            shutil.copy( src_path, dest_path )
+        global __SERVE_PLOTLYJS_FROM_DIRECTORY
+        if __SERVE_PLOTLYJS_FROM_DIRECTORY:
+            dest_path = os.path.join(
+                os.path.dirname( filename ), 'plotly.min.js'
+            )
+            if os.path.exists( dest_path ) is False:
+                shutil.copy( src_path, dest_path )
 
         with open(filename, 'w') as f:
             if include_plotlyjs:
                 plotly_js_script = ''.join([
                     '<script type="text/javascript">',
-                    get_plotlyjs(outsource_plotly=outsource_plotly),
+                    get_plotlyjs(),
                     '</script>',
                 ])
             else:
@@ -363,7 +378,7 @@ def plot(figure_or_data,
             return ''.join([
                 '<div>',
                 '<script type="text/javascript">',
-                get_plotlyjs(outsource_plotly=outsource_plotly),
+                get_plotlyjs(),
                 '</script>',
                 plot_html,
                 '</div>'