Added tests to 2d_density

Author: Kully

plotly/tests/test_core/test_tools/test_figure_factory.py

@@ -1365,6 +1365,116 @@ def test_gantt_all_args(self):
         self.assertEqual(test_gantt_chart['layout'],
                          exp_gantt_chart['layout'])
 
+
+class Test2D_Density(TestCase):
+
+    def test_validate_2D_density(self):
+
+        # validate that x and y contain only numbers
+
+        x = [1, 2]
+
+        y = ['a', 2]
+
+        pattern = ("All elements of your 'x' and 'y' lists must be numbers.")
+
+        self.assertRaisesRegexp(PlotlyError, pattern,
+                                tls.FigureFactory.create_2D_density, x, y)
+
+        # validate that x and y are the same length
+
+        x2 = [1]
+
+        y2 = [1, 2]
+
+        pattern2 = ("Both lists 'x' and 'y' must be the same length.")
+
+        self.assertRaisesRegexp(PlotlyError, pattern2,
+                                tls.FigureFactory.create_2D_density, x2, y2)
+
+    def test_2D_density_all_args(self):
+
+        # check if 2D_density data matches with expected output
+
+        x = [1, 2]
+        y = [2, 4]
+
+        colorscale = ['#7A4579', '#D56073', 'rgb(236,158,105)',
+                      (1, 1, 0.2), (0.98, 0.98, 0.98)]
+
+        test_2D_density_chart = tls.FigureFactory.create_2D_density(
+            x, y, colorscale=colorscale, hist_color='rgb(255, 237, 222)',
+            point_size=3, height=800, width=800)
+
+        exp_2D_density_chart = {
+            'data': [{'marker': {'color': 'rgb(0.0, 0.0, 127.5)',
+                      'opacity': 0.4,
+                      'size': 3},
+                      'mode': 'markers',
+                      'name': 'points',
+                      'type': 'scatter',
+                      'x': [1, 2],
+                      'y': [2, 4]},
+                     {'colorscale': [[0.0, 'rgb(122.0, 69.0, 121.0)'],
+                                     [0.25, 'rgb(213.0, 96.0, 115.0)'],
+                                     [0.5, 'rgb(236.0, 158.0, 105.0)'],
+                                     [0.75, 'rgb(255.0, 255.0, 51.0)'],
+                                     [1.0, 'rgb(249.9, 249.9, 249.9)']],
+                      'name': 'density',
+                      'ncontours': 20,
+                      'reversescale': True,
+                      'showscale': False,
+                      'type': 'histogram2dcontour',
+                      'x': [1, 2],
+                      'y': [2, 4]},
+                     {'marker': {'color': 'rgb(255.0, 237.0, 222.0)'},
+                      'name': 'x density',
+                      'type': 'histogram',
+                      'x': [1, 2],
+                      'yaxis': 'y2'},
+                     {'marker': {'color': 'rgb(255.0, 237.0, 222.0)'},
+                      'name': 'y density',
+                      'type': 'histogram',
+                      'xaxis': 'x2',
+                      'y': [2, 4]}],
+            'layout': {'autosize': False,
+                       'bargap': 0,
+                       'height': 800,
+                       'hovermode': 'closest',
+                       'margin': {'t': 50},
+                       'showlegend': False,
+                       'title': 'Love',
+                       'width': 800,
+                       'xaxis': {'___domain': [0, 0.85],
+                                 'showgrid': False,
+                                 'zeroline': False},
+                       'xaxis2': {'___domain': [0.85, 1],
+                                  'showgrid': False,
+                                  'zeroline': False},
+                       'yaxis': {'___domain': [0, 0.85],
+                                 'showgrid': False,
+                                 'zeroline': False},
+                       'yaxis2': {'___domain': [0.85, 1],
+                                  'showgrid': False,
+                                  'zeroline': False}}
+        }
+
+        self.assertEqual(test_2D_density_chart['data'][0],
+                         exp_2D_density_chart['data'][0])
+
+        self.assertEqual(test_2D_density_chart['data'][1],
+                         exp_2D_density_chart['data'][1])
+
+        self.assertEqual(test_2D_density_chart['data'][2],
+                         exp_2D_density_chart['data'][2])
+
+        self.assertEqual(test_2D_density_chart['data'][3],
+                         exp_2D_density_chart['data'][3])
+
+        self.assertEqual(test_2D_density_chart['layout'],
+                         exp_2D_density_chart['layout'])
+
+
 # class TestDistplot(TestCase):
 
 #     def test_scipy_import_error(self):

plotly/tools.py

@@ -1494,8 +1494,8 @@ def create_2D_density(x, y, colorscale='Earth', ncontours=20,
         """
         Returns figure for a 2D density plot
 
-        :param (list) x: x-axis data for plot generation
-        :param (list) y: y-axis data for plot generation
+        :param (list|array) x: x-axis data for plot generation
+        :param (list|array) y: y-axis data for plot generation
         :param (str|tuple|list) colorscale: either a plotly scale name, an rgb
             or hex color, a color tuple or a list or tuple of colors. An rgb
             color is of the form 'rgb(x, y, z)' where x, y, z belong to the
@@ -1527,7 +1527,7 @@ def create_2D_density(x, y, colorscale='Earth', ncontours=20,
         py.iplot(fig, filename='simple-2d-density')
         ```
 
-        Example 2: Use Parameters
+        Example 2: Using Parameters
         ```
         import plotly.plotly as py
         from plotly.tools import FigureFactory as FF
@@ -1551,6 +1551,21 @@ def create_2D_density(x, y, colorscale='Earth', ncontours=20,
         ```
         """
         from plotly.graph_objs import graph_objs
+        from numbers import Number
+
+        # validate x and y are filled with numbers only
+        for array in [x, y]:
+            if not all(isinstance(element, Number) for element in array):
+                raise exceptions.PlotlyError(
+                    "All elements of your 'x' and 'y' lists must be numbers."
+                )
+
+        # validate x and y are the same length
+        if len(x) != len(y):
+            raise exceptions.PlotlyError(
+                "Both lists 'x' and 'y' must be the same length."
+            )
+
         colorscale = FigureFactory._validate_colors(colorscale, 'rgb')
         colorscale = FigureFactory._make_linear_colorscale(colorscale)