Commented out current theme-index-test//created test for no index- no theme

Author: Kully

plotly/tests/test_optional/test_figure_factory.py

@@ -693,11 +693,11 @@ def test_valid_endpts(self):
                                 df, use_theme=True, index='a',
                                 palette='Blues', endpts=[2, 1])
 
+    """
     def test_scatter_plot_matrix_kwargs(self):
 
         # check if test scatter plot matrix matches with
         # the expected output
-
         df = pd.DataFrame([[2, 'Apple'], [6, 'Pear'],
                           [-15, 'Apple'], [5, 'Pear'],
                           [-2, 'Apple'], [0, 'Apple']],
@@ -735,6 +735,77 @@ def test_scatter_plot_matrix_kwargs(self):
                                   'title': 'Numbers'}}
         }
 
+        self.assert_dict_equal(test_scatter_plot_matrix['data'][0],
+                               exp_scatter_plot_matrix['data'][0])
+
+        self.assert_dict_equal(test_scatter_plot_matrix['data'][1],
+                               exp_scatter_plot_matrix['data'][1])
+
+        self.assert_dict_equal(test_scatter_plot_matrix['layout'],
+                               exp_scatter_plot_matrix['layout'])
+    """
+
+    def test_scatter_plot_matrix(self):
+
+        # check if test scatter plot matrix without index or theme matches
+        # with the expected output
+        df = pd.DataFrame([[2, 'Apple'], [6, 'Pear'],
+                          [-15, 'Apple'], [5, 'Pear'],
+                          [-2, 'Apple'], [0, 'Apple']],
+                          columns=['Numbers', 'Fruit'])
+
+        test_scatter_plot_matrix = tls.FigureFactory.create_scatterplotmatrix(
+            df, diag='scatter', height=1000, width=1000, size=13,
+            title='Scatterplot Matrix', use_theme=False
+        )
+
+        exp_scatter_plot_matrix = {
+            'data': [{'marker': {'size': 13},
+                     'mode': 'markers',
+                     'showlegend': False,
+                     'type': 'scatter',
+                     'x': [2, 6, -15, 5, -2, 0],
+                     'xaxis': 'x1',
+                     'y': [2, 6, -15, 5, -2, 0],
+                     'yaxis': 'y1'},
+                    {'marker': {'size': 13},
+                     'mode': 'markers',
+                     'showlegend': False,
+                     'type': 'scatter',
+                     'x': ['Apple', 'Pear', 'Apple', 'Pear', 'Apple', 'Apple'],
+                     'xaxis': 'x2',
+                     'y': [2, 6, -15, 5, -2, 0],
+                     'yaxis': 'y2'},
+                    {'marker': {'size': 13},
+                     'mode': 'markers',
+                     'showlegend': False,
+                     'type': 'scatter',
+                     'x': [2, 6, -15, 5, -2, 0],
+                     'xaxis': 'x3',
+                     'y': ['Apple', 'Pear', 'Apple', 'Pear', 'Apple', 'Apple'],
+                     'yaxis': 'y3'},
+                    {'marker': {'size': 13},
+                     'mode': 'markers',
+                     'showlegend': False,
+                     'type': 'scatter',
+                     'x': ['Apple', 'Pear', 'Apple', 'Pear', 'Apple', 'Apple'],
+                     'xaxis': 'x4',
+                     'y': ['Apple', 'Pear', 'Apple', 'Pear', 'Apple', 'Apple'],
+                     'yaxis': 'y4'}],
+                   'layout': {'height': 1000,
+                    'showlegend': True,
+                    'title': 'Scatterplot Matrix',
+                    'width': 1000,
+                    'xaxis1': {'anchor': 'y1', 'domain': [0.0, 0.45]},
+                    'xaxis2': {'anchor': 'y2', 'domain': [0.55, 1.0]},
+                    'xaxis3': {'anchor': 'y3', 'domain': [0.0, 0.45], 'title': 'Numbers'},
+                    'xaxis4': {'anchor': 'y4', 'domain': [0.55, 1.0], 'title': 'Fruit'},
+                    'yaxis1': {'anchor': 'x1', 'domain': [0.575, 1.0], 'title': 'Numbers'},
+                    'yaxis2': {'anchor': 'x2', 'domain': [0.575, 1.0]},
+                    'yaxis3': {'anchor': 'x3', 'domain': [0.0, 0.425], 'title': 'Fruit'},
+                    'yaxis4': {'anchor': 'x4', 'domain': [0.0, 0.425]}}
+        }
+
         self.assert_dict_equal(test_scatter_plot_matrix['data'][0],
                                exp_scatter_plot_matrix['data'][0])
 

plotly/tools.py

@@ -22,6 +22,11 @@
 from plotly.files import (CONFIG_FILE, CREDENTIALS_FILE, FILE_CONTENT,
                           GRAPH_REFERENCE_FILE, check_file_permissions)
 
+DEFAULT_PLOTLY_COLORS = ['rgb(31, 119, 180)', 'rgb(255, 127, 14)',
+                         'rgb(44, 160, 44)', 'rgb(214, 39, 40)',
+                         'rgb(148, 103, 189)', 'rgb(140, 86, 75)',
+                         'rgb(227, 119, 194)', 'rgb(127, 127, 127)',
+                         'rgb(188, 189, 34)', 'rgb(23, 190, 207)']
 
 # Warning format
 def warning_on_one_line(message, category, filename, lineno,
@@ -1425,12 +1430,6 @@ def return_figure_from_figure_or_data(figure_or_data, validate_figure):
 _DEFAULT_INCREASING_COLOR = '#3D9970'  # http://clrs.cc
 _DEFAULT_DECREASING_COLOR = '#FF4136'
 
-DEFAULT_PLOTLY_COLORS = ['rgb(31, 119, 180)', 'rgb(255, 127, 14)',
-                         'rgb(44, 160, 44)', 'rgb(214, 39, 40)',
-                         'rgb(148, 103, 189)', 'rgb(140, 86, 75)',
-                         'rgb(227, 119, 194)', 'rgb(127, 127, 127)',
-                         'rgb(188, 189, 34)', 'rgb(23, 190, 207)']
-
 DIAG_CHOICES = ['scatter', 'histogram', 'box']
 
 
@@ -1455,6 +1454,11 @@ def _scatterplot(dataframe, headers,
                      diag, size,
                      height, width,
                      title, **kwargs):
+        """
+        Returns fig for scatterplotmatrix without index or theme.
+        Refer to FigureFactory.create_scatterplotmatrix() for docstring.
+        """
+
         from plotly.graph_objs import graph_objs
         dim = len(dataframe)
         fig = make_subplots(rows=dim, cols=dim)
@@ -1527,6 +1531,10 @@ def _scatterplot_index(dataframe, headers,
                            title,
                            index, index_vals,
                            **kwargs):
+        """
+        Returns fig for scatterplotmatrix with an index and no theme.
+        Refer to FigureFactory.create_scatterplotmatrix() for docstring.
+        """
         from plotly.graph_objs import graph_objs
         dim = len(dataframe)
         fig = make_subplots(rows=dim, cols=dim)
@@ -1690,6 +1698,13 @@ def _scatterplot_index(dataframe, headers,
     def _scatterplot_theme(dataframe, headers, diag, size, height, width,
                            title, index, index_vals, endpts,
                            palette, **kwargs):
+        """
+        Returns fig for scatterplotmatrix with both index and theme.
+        Refer to FigureFactory.create_scatterplotmatrix() for docstring.
+
+        :raises: (PlotlyError) If palette string is not a Plotly colorscale
+        :raises: (PlotlyError) If palette is not a string or list
+        """
         from plotly.graph_objs import graph_objs
         plotly_scales = {'Greys': ['rgb(0,0,0)', 'rgb(255,255,255)'],
                          'YlGnBu': ['rgb(8,29,88)', 'rgb(255,255,217)'],
@@ -1864,6 +1879,7 @@ def _scatterplot_theme(dataframe, headers, diag, size, height, width,
                         c_indx += 1
                     trace_list.append(unique_index_vals)
                     legend_param += 1
+            #return trace_list
 
             trace_index = 0
             indices = range(1, dim + 1)
@@ -2246,6 +2262,12 @@ def _scatterplot_theme(dataframe, headers, diag, size, height, width,
 
     @staticmethod
     def _validate_index(index_vals):
+        """
+        Validates if a list contains all numbers or all strings.
+
+        :raises: (PlotlyError) If there are any two items in the list whose
+            types differ
+        """
         from numbers import Number
         if isinstance(index_vals[0], Number):
             if not all(isinstance(item, Number) for item in index_vals):
@@ -2263,6 +2285,13 @@ def _validate_index(index_vals):
 
     @staticmethod
     def _validate_dataframe(array):
+        """
+        Validates if for the lists in a dataframe, they contain all numbers
+            or all strings.
+
+        :raises: (PlotlyError) If there are any two items in any list whose
+            types differ
+        """
         from numbers import Number
         for vector in array:
             if isinstance(vector[0], Number):
@@ -2280,6 +2309,17 @@ def _validate_dataframe(array):
 
     @staticmethod
     def _validate_scatterplotmatrix(df, index, diag, **kwargs):
+        """
+        Validates basic inputs for FigureFactory.create_scatterplotmatrix()
+
+        :raises: (PlotlyError) If pandas is not imported
+        :raises: (PlotlyError) If pandas dataframe is not inputted
+        :raises: (PlotlyError) If pandas dataframe has <= 1 columns
+        :raises: (PlotlyError) If diagonal plot choice (diag) is not one of
+            the viable options
+        :raises: (PlotlyError) If kwargs contains 'size', 'color' or
+            'colorscale'
+        """
         if _pandas_imported is False:
             raise ImportError("FigureFactory.scatterplotmatrix requires "
                               "a pandas DataFrame.")
@@ -2316,6 +2356,16 @@ def _validate_scatterplotmatrix(df, index, diag, **kwargs):
 
     @staticmethod
     def _endpts_to_intervals(endpts):
+        """
+        Accepts a list or tuple of sequentially increasing numbers and returns
+        a list representation of the mathematical intervals with these numbers
+        as endpoints. For example, [1, 4, 6] returns [[1, 4], [4, 6]]
+
+        :raises: (PlotlyError) If input is not a list or tuple
+        :raises: (PlotlyError) If the input contains a string
+        :raises: (PlotlyError) If any number does not increase after the
+            previous one in the sequence
+        """
         length = len(endpts)
         # Check if endpts is a list or tuple
         if not (isinstance(endpts, (tuple)) or isinstance(endpts, (list))):
@@ -2351,8 +2401,11 @@ def _endpts_to_intervals(endpts):
 
     @staticmethod
     def _convert_to_RGB_255(colors):
-        # convert a list of color tuples in normalized space to
-        # to a list of RGB_255 converted tuples
+        """
+        Takes a list of color tuples where each element is between 0 and 1
+        and returns the same list where each tuple element is normalized to be
+        between 0 and 255
+        """
         colors_255 = []
 
         for color in colors:
@@ -2362,8 +2415,10 @@ def _convert_to_RGB_255(colors):
 
     @staticmethod
     def _n_colors(tuple1, tuple2, n_colors):
-        # Split two color tuples in normalized
-        # space into n_colors # of intermediate color tuples
+        """
+        Accepts two color tuples and returns a list of n_colors colors
+        which form the intermediate points between tuple1 and tuple2
+        """
         diff_0 = float(tuple2[0] - tuple1[0])
         incr_0 = diff_0/(n_colors - 1)
         diff_1 = float(tuple2[1] - tuple1[1])
@@ -2382,6 +2437,10 @@ def _n_colors(tuple1, tuple2, n_colors):
 
     @staticmethod
     def _label_rgb(colors):
+        """
+        Takes a list of two color tuples of the form (a, b, c) and returns the
+        same list with each tuple replaced by a string 'rgb(a, b, c)'
+        """
         colors_label = []
         for color in colors:
             color_label = 'rgb{}'.format(color)
@@ -2391,6 +2450,12 @@ def _label_rgb(colors):
 
     @staticmethod
     def _unlabel_rgb(colors):
+        """
+        This function takes a list of two 'rgb(a, b, c)' color strings and
+        returns a list of the color tuples in tuple form without the 'rgb'
+        label. In particular, the output is a list of two tuples of the form
+        (a, b, c)
+        """
         unlabelled_colors = []
         for color in colors:
             str_vals = ''