Refact all our _*_imported code \o/

Author: theengineear

plotly/graph_objs/figure_factory.py

@@ -6,21 +6,8 @@
 import math
 from collections import OrderedDict
 
-from plotly import exceptions
+from plotly import exceptions, optional_imports
 from plotly.graph_objs.graph_objs import GraphObjectFactory
-from plotly.tools import (_numpy_imported, _scipy_imported,
-                          _scipy__spatial_imported,
-                          _scipy__cluster__hierarchy_imported)
-
-if _scipy_imported:
-    import scipy
-    import scipy as scp
-if _numpy_imported:
-    import numpy as np
-if _scipy__spatial_imported:
-    import scipy.spatial as scs
-if _scipy__cluster__hierarchy_imported:
-    import scipy.cluster.hierarchy as sch
 
 
 # Default colours for finance charts
@@ -106,16 +93,13 @@ def _validate_distplot(hist_data, curve_type):
         :raises: (PlotlyError) If curve_type is not valid (i.e. not 'kde' or
             'normal').
         """
-        try:
-            import pandas as pd
-            _pandas_imported = True
-        except ImportError:
-            _pandas_imported = False
+        pd = optional_imports.get_module('pandas')
+        np = optional_imports.get_module('numpy')
 
         hist_data_types = (list,)
-        if _numpy_imported:
+        if np:
             hist_data_types += (np.ndarray,)
-        if _pandas_imported:
+        if pd:
             hist_data_types += (pd.core.series.Series,)
 
         if not isinstance(hist_data[0], hist_data_types):
@@ -131,8 +115,8 @@ def _validate_distplot(hist_data, curve_type):
             raise exceptions.PlotlyError("curve_type must be defined as "
                                          "'kde' or 'normal'")
 
-        if _scipy_imported is False:
-            raise ImportError("FigureFactory.create_distplot requires scipy")
+        msg = 'FigureFactory.create_distplot requires scipy'
+        optional_imports.get_module('scipy', raise_exc=True, msg=msg)
 
     @staticmethod
     def _validate_positive_scalars(**kwargs):
@@ -165,8 +149,8 @@ def _validate_streamline(x, y):
         :raises: (PlotlyError) If x is not evenly spaced.
         :raises: (PlotlyError) If y is not evenly spaced.
         """
-        if _numpy_imported is False:
-            raise ImportError("FigureFactory.create_streamline requires numpy")
+        msg = 'FigureFactory.create_streamline requires numpy'
+        optional_imports.get_module('numpy', raise_exc=True, msg=msg)
         for index in range(len(x) - 1):
             if ((x[index + 1] - x[index]) - (x[1] - x[0])) > .0001:
                 raise exceptions.PlotlyError("x must be a 1 dimensional, "
@@ -1085,13 +1069,10 @@ def create_dendrogram(X, orientation="bottom", labels=None,
         ```
 
         """
-        dependencies = (_scipy_imported and _scipy__spatial_imported and
-                        _scipy__cluster__hierarchy_imported)
-
-        if dependencies is False:
-            raise ImportError("FigureFactory.create_dendrogram requires "
-                              "scipy, scipy.spatial and scipy.hierarchy")
-
+        msg = ('FigureFactory.create_dendrogram requires scipy, scipy.spatial '
+               'and scipy.hierarchy')
+        for module in ['scipy', 'scipy.spatial', 'scipy.cluster.hierarchy']:
+            optional_imports.get_module(module, raise_exc=True, msg=msg)
         s = X.shape
         if len(s) != 2:
             exceptions.PlotlyError("X should be 2-dimensional array.")
@@ -1253,6 +1234,7 @@ class _Streamline(FigureFactory):
     def __init__(self, x, y, u, v,
                  density, angle,
                  arrow_scale, **kwargs):
+        np = optional_imports.get_module('numpy', raise_exc=True)
         self.x = np.array(x)
         self.y = np.array(y)
         self.u = np.array(u)
@@ -1296,6 +1278,7 @@ def value_at(self, a, xi, yi):
         """
         Set up for RK4 function, based on Bokeh's streamline code
         """
+        np = optional_imports.get_module('numpy', raise_exc=True)
         if isinstance(xi, np.ndarray):
             self.x = xi.astype(np.int)
             self.y = yi.astype(np.int)
@@ -1412,6 +1395,7 @@ def get_streamlines(self):
         """
         Get streamlines by building trajectory set.
         """
+        np = optional_imports.get_module('numpy', raise_exc=True)
         for indent in range(self.density // 2):
             for xi in range(self.density - 2 * indent):
                 self.traj(xi + indent, indent)
@@ -1442,6 +1426,7 @@ def get_streamline_arrows(self):
         :rtype (list, list) arrows_x: x-values to create arrowhead and
             arrows_y: y-values to create arrowhead
         """
+        np = optional_imports.get_module('numpy', raise_exc=True)
         arrow_end_x = np.empty((len(self.st_x)))
         arrow_end_y = np.empty((len(self.st_y)))
         arrow_start_x = np.empty((len(self.st_x)))
@@ -1743,12 +1728,14 @@ def make_kde(self):
 
         :rtype (list) curve: list of kde representations
         """
+        scipy__stats = optional_imports.get_module('scipy.stats',
+                                                   raise_exc=True)
         curve = [None] * self.trace_number
         for index in range(self.trace_number):
             self.curve_x[index] = [self.start[index] +
                                    x * (self.end[index] - self.start[index]) /
                                    500 for x in range(500)]
-            self.curve_y[index] = (scipy.stats.gaussian_kde
+            self.curve_y[index] = (scipy__stats.gaussian_kde
                                    (self.hist_data[index])
                                    (self.curve_x[index]))
             self.curve_y[index] *= self.bin_size
@@ -1774,6 +1761,7 @@ def make_normal(self):
 
         :rtype (list) curve: list of normal curve representations
         """
+        scipy = optional_imports.get_module('scipy', raise_exc=True)
         curve = [None] * self.trace_number
         mean = [None] * self.trace_number
         sd = [None] * self.trace_number
@@ -1978,6 +1966,11 @@ def get_dendrogram_traces(self, X, colorscale):
             (e) P['leaves']: left-to-right traversal of the leaves
 
         """
+        np = optional_imports.get_module('numpy', raise_exc=True)
+        scp = optional_imports.get_module('scipy', raise_exc=True)
+        scs = optional_imports.get_module('scipy.spatial', raise_exc=True)
+        sch = optional_imports.get_module('scipy.cluster.hierarchy',
+                                          raise_exc=True)
         d = scs.distance.pdist(X)
         Z = sch.linkage(d, method='complete')
         P = sch.dendrogram(Z, orientation=self.orientation,

plotly/offline/offline.py

@@ -11,7 +11,7 @@
 
 import requests
 
-from plotly import session, tools, utils
+from plotly import session, tools, utils, optional_imports
 from plotly.exceptions import PlotlyError
 
 PLOTLY_OFFLINE_DIRECTORY = plotlyjs_path = os.path.expanduser(
@@ -51,9 +51,9 @@ def init_notebook_mode():
     to load the necessary javascript files for creating
     Plotly graphs with plotly.offline.iplot.
     """
-    if not tools._ipython_imported:
-        raise ImportError('`iplot` can only run inside an IPython Notebook.')
-    from IPython.display import HTML, display
+    msg = '`iplot` can only run inside an IPython Notebook.'
+    IPython__display = optional_imports.get_module('IPython.display',
+                                                   raise_exc=True, msg=msg)
 
     if not os.path.exists(PLOTLY_OFFLINE_BUNDLE):
         raise PlotlyError('Plotly Offline source file at {source_path} '
@@ -68,8 +68,10 @@ def init_notebook_mode():
 
     global __PLOTLY_OFFLINE_INITIALIZED
     __PLOTLY_OFFLINE_INITIALIZED = True
-    display(HTML('<script type="text/javascript">' +
-                 open(PLOTLY_OFFLINE_BUNDLE).read() + '</script>'))
+    IPython__display.display(IPython__display.HTML(
+        '<script type="text/javascript">' +
+        open(PLOTLY_OFFLINE_BUNDLE).read() + '</script>'
+    ))
 
 
 def iplot(figure_or_data, show_link=True, link_text='Export to plot.ly'):
@@ -108,10 +110,10 @@ def iplot(figure_or_data, show_link=True, link_text='Export to plot.ly'):
             '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.')
+    msg = '`iplot` can only run inside an IPython Notebook.'
+    IPython__display = optional_imports.get_module('IPython.display',
+                                                   raise_exc=True, msg=msg)
 
-    from IPython.display import HTML, display
     if isinstance(figure_or_data, dict):
         data = figure_or_data['data']
         layout = figure_or_data.get('layout', {})
@@ -152,7 +154,7 @@ def iplot(figure_or_data, show_link=True, link_text='Export to plot.ly'):
             .replace('http://', '')
         link_text = link_text.replace('plot.ly', link_domain)
 
-    display(HTML(
+    IPython__display.display(IPython__display.HTML(
         '<script type="text/javascript">'
         'window.PLOTLYENV=window.PLOTLYENV || {};'
         'window.PLOTLYENV.BASE_URL="' + plotly_platform_url + '";'
@@ -169,17 +171,17 @@ def iplot(figure_or_data, show_link=True, link_text='Export to plot.ly'):
               layout=jlayout,
               link_text=link_text)
 
-    display(HTML(''
-                 '<div class="{id} loading" style="color: rgb(50,50,50);">'
-                 'Drawing...</div>'
-                 '<div id="{id}" style="height: {height}; width: {width};" '
-                 'class="plotly-graph-div">'
-                 '</div>'
-                 '<script type="text/javascript">'
-                 '{script}'
-                 '</script>'
-                 ''.format(id=plotdivid, script=script,
-                           height=height, width=width)))
+    IPython__display.display(IPython__display.HTML(
+        '<div class="{id} loading" style="color: rgb(50,50,50);">'
+        'Drawing...</div>'
+        '<div id="{id}" style="height: {height}; width: {width};" '
+        'class="plotly-graph-div">'
+        '</div>'
+        '<script type="text/javascript">'
+        '{script}'
+        '</script>'
+        ''.format(id=plotdivid, script=script, height=height, width=width)
+    ))
 
 
 def plot():

plotly/tools.py

@@ -12,10 +12,8 @@
 import warnings
 import six
 
-from plotly import utils
-from plotly import exceptions
-from plotly import graph_reference
-from plotly import session
+from plotly import (exceptions, graph_reference, optional_imports, session,
+                    utils)
 from plotly.files import (CONFIG_FILE, CREDENTIALS_FILE, FILE_CONTENT,
                           GRAPH_REFERENCE_FILE, check_file_permissions)
 
@@ -29,50 +27,6 @@ def warning_on_one_line(message, category, filename, lineno,
                                      message)
 warnings.formatwarning = warning_on_one_line
 
-try:
-    from . import matplotlylib
-    _matplotlylib_imported = True
-except ImportError:
-    _matplotlylib_imported = False
-
-try:
-    import IPython
-    import IPython.core.display
-    _ipython_imported = True
-except ImportError:
-    _ipython_imported = False
-
-try:
-    import numpy as np
-    _numpy_imported = True
-except ImportError:
-    _numpy_imported = False
-
-try:
-    import scipy as scp
-    _scipy_imported = True
-except ImportError:
-    _scipy_imported = False
-
-try:
-    import scipy.spatial as scs
-    _scipy__spatial_imported = True
-except ImportError:
-    _scipy__spatial_imported = False
-
-try:
-    import scipy.cluster.hierarchy as sch
-    _scipy__cluster__hierarchy_imported = True
-except ImportError:
-    _scipy__cluster__hierarchy_imported = False
-
-try:
-    import scipy
-    import scipy.stats
-    _scipy_imported = True
-except ImportError:
-    _scipy_imported = False
-
 
 def get_config_defaults():
     """
@@ -383,11 +337,12 @@ def embed(file_owner_or_url, file_id=None, width="100%", height=525):
                       height=height)
 
         # see if we are in the SageMath Cloud
-        from sage_salvus import html
-        return html(s, hide=False)
+        sage_salvus = optional_imports.get_module('sage_salvus')
+        if sage_salvus:
+            return sage_salvus.html(s, hide=False)
     except:
         pass
-    if _ipython_imported:
+    if optional_imports.get_module('IPython.core.display'):
         if file_id:
             plotly_domain = (
                 session.get_session_config().get('plotly_domain') or
@@ -466,7 +421,8 @@ def mpl_to_plotly(fig, resize=False, strip_style=False, verbose=False):
     {plotly_domain}/python/getting-started
 
     """
-    if _matplotlylib_imported:
+    matplotlylib = optional_imports.get_module('plotly.matplotlylib')
+    if matplotlylib:
         renderer = matplotlylib.PlotlyRenderer()
         matplotlylib.Exporter(renderer).run(fig)
         if resize:
@@ -1361,8 +1317,9 @@ def _replace_newline(obj):
         return obj  # we return the actual reference... but DON'T mutate.
 
 
-if _ipython_imported:
-    class PlotlyDisplay(IPython.core.display.HTML):
+IPython__core__display = optional_imports.get_module('IPython.core.display')
+if IPython__core__display:
+    class PlotlyDisplay(IPython__core__display.HTML):
         """An IPython display object for use with plotly urls
 
         PlotlyDisplay objects should be instantiated with a url for a plot.

plotly/utils.py

@@ -15,26 +15,8 @@
 
 import pytz
 
-
-from . exceptions import PlotlyError
-
-try:
-    import numpy
-    _numpy_imported = True
-except ImportError:
-    _numpy_imported = False
-
-try:
-    import pandas
-    _pandas_imported = True
-except ImportError:
-    _pandas_imported = False
-
-try:
-    import sage.all
-    _sage_imported = True
-except ImportError:
-    _sage_imported = False
+from plotly import optional_imports
+from plotly.exceptions import PlotlyError
 
 
 ### incase people are using threading, we lock file reads
@@ -229,7 +211,8 @@ def encode_as_list(obj):
     @staticmethod
     def encode_as_sage(obj):
         """Attempt to convert sage.all.RR to floats and sage.all.ZZ to ints"""
-        if not _sage_imported:
+        sage = optional_imports.get_module('sage')
+        if not sage:
             raise NotEncodable
 
         if obj in sage.all.RR:
@@ -242,7 +225,8 @@ def encode_as_sage(obj):
     @staticmethod
     def encode_as_pandas(obj):
         """Attempt to convert pandas.NaT"""
-        if not _pandas_imported:
+        pandas = optional_imports.get_module('pandas')
+        if not pandas:
             raise NotEncodable
 
         if obj is pandas.NaT:
@@ -253,7 +237,8 @@ def encode_as_pandas(obj):
     @staticmethod
     def encode_as_numpy(obj):
         """Attempt to convert numpy.ma.core.masked"""
-        if not _numpy_imported:
+        numpy = optional_imports.get_module('numpy')
+        if not numpy:
             raise NotEncodable
 
         if obj is numpy.ma.core.masked: