move endpts_to_intervals to utils from _scatterplot.py

Author: Kully

plotly/figure_factory/_facet_grid.py

@@ -550,16 +550,17 @@ def create_facet_grid(df, x, y, facet_row=None, facet_col=None,
                       facet_row_labels=None, facet_col_labels=None,
                       height=None, width=None, trace_type='scatter',
                       scales='fixed', dtick_x=None, dtick_y=None,
-                      show_boxes=True, ggplot2=False, **kwargs):
+                      show_boxes=True, ggplot2=False, binsize=1, **kwargs):
     """
     Returns figure for facet grid.
 
     :param (pd.DataFrame) df: the dataframe of columns for the facet grid.
-    :param (str) x: the key of the dataframe to be used as the x axis df.
-    :param (str) y: the key of the dataframe to be used as the y axis df.
-    :param (str) facet_row: the key for row filter column for the facet grid.
-    :param (str) facet_col: the key for the column filter column for the facet
-        grid.
+    :param (str) x: the name of the dataframe column for the x axis data.
+    :param (str) y: the name of the dataframe column for the y axis data.
+    :param (str) facet_row: the name of the dataframe column that is used to
+        facet the grid into row panels.
+    :param (str) facet_col: the name of the dataframe column that is used to
+        facet the grid into column panels.
     :param (str) color_name: the name of your dataframe column that will
         function as the colormap variable.
     :param (str|list|dict) colormap: the param that determines how the
@@ -593,6 +594,7 @@ def create_facet_grid(df, x, y, facet_row=None, facet_col=None,
     :param (bool) ggplot2: draws the facet grid in the style of `ggplot2`. See
         http://ggplot2.tidyverse.org/reference/facet_grid.html for reference.
         Default = False
+    :param (int) binsize: groups all data into bins of a given length.
     :param (dict) kwargs: a dictionary of scatterplot arguments.
 
     Examples 1: One Way Faceting

plotly/figure_factory/_scatterplot.py

@@ -552,7 +552,7 @@ def scatterplot_theme(dataframe, headers, diag, size, height, width, title,
 
     else:
         if endpts:
-            intervals = endpts_to_intervals(endpts)
+            intervals = utils.endpts_to_intervals(endpts)
 
             # Convert colormap to list of n RGB tuples
             if colormap_type == 'seq':

plotly/figure_factory/utils.py

@@ -441,3 +441,50 @@ def validate_colorscale(colorscale):
 
     validate_scale_values(scale_values)
     validate_colors(colorscale_colors)
+
+
+def endpts_to_intervals(endpts):
+    """
+    Returns a list of intervals for categorical colormaps
+
+    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, 6] returns [[-inf, 1], [1, 6], [6, inf]]
+
+    :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))):
+        raise exceptions.PlotlyError("The intervals_endpts argument must "
+                                     "be a list or tuple of a sequence "
+                                     "of increasing numbers.")
+    # Check if endpts contains only numbers
+    for item in endpts:
+        if isinstance(item, str):
+            raise exceptions.PlotlyError("The intervals_endpts argument "
+                                         "must be a list or tuple of a "
+                                         "sequence of increasing "
+                                         "numbers.")
+    # Check if numbers in endpts are increasing
+    for k in range(length - 1):
+        if endpts[k] >= endpts[k + 1]:
+            raise exceptions.PlotlyError("The intervals_endpts argument "
+                                         "must be a list or tuple of a "
+                                         "sequence of increasing "
+                                         "numbers.")
+    else:
+        intervals = []
+        # add -inf to intervals
+        intervals.append([float('-inf'), endpts[0]])
+        for k in range(length - 1):
+            interval = []
+            interval.append(endpts[k])
+            interval.append(endpts[k + 1])
+            intervals.append(interval)
+        # add +inf to intervals
+        intervals.append([endpts[length - 1], float('inf')])
+        return intervals