first draft of adding pie, sunburst, funnel and funnelarea

Author: emmanuelle

packages/python/plotly/plotly/express/__init__.py

@@ -39,6 +39,10 @@
     choropleth,
     density_contour,
     density_heatmap,
+    pie,
+    sunburst,
+    funnel,
+    funnel_area,
 )
 
 from ._imshow import imshow
@@ -77,6 +81,10 @@
     "strip",
     "histogram",
     "choropleth",
+    "pie",
+    "sunburst",
+    "funnel"
+    "funnel_area"
     "imshow",
     "data",
     "colors",

packages/python/plotly/plotly/express/_chart_types.py

@@ -1115,3 +1115,118 @@ def parallel_categories(
 
 
 parallel_categories.__doc__ = make_docstring(parallel_categories)
+
+
+def pie(
+    data_frame=None,
+    text=None,
+    values=None,
+    hover_name=None,
+    hover_data=None,
+    custom_data=None,
+    labels={},
+    title=None,
+    template=None,
+    width=None,
+    height=None,
+    opacity=None,
+        ):
+    """
+    In a pie plot, each row of `data_frame` is represented as a sector of a pie.
+    """
+    return make_figure(
+        args=locals(),
+        constructor=go.Pie,
+    )
+
+
+pie.__doc__ = make_docstring(pie)
+
+
+def sunburst(
+    data_frame=None,
+    text=None,
+    values=None,
+    parents=None,
+    ids=None,
+    hover_name=None,
+    hover_data=None,
+    custom_data=None,
+    labels={},
+    title=None,
+    template=None,
+    width=None,
+    height=None,
+    branchvalues=None,
+    maxdepth=None,
+        ):
+    """
+    In a pie plot, each row of `data_frame` is represented as a sector of a pie.
+    """
+    return make_figure(
+        args=locals(),
+        constructor=go.Sunburst,
+        trace_patch=dict(branchvalues=branchvalues, maxdepth=maxdepth)
+    )
+
+
+sunburst.__doc__ = make_docstring(sunburst)
+
+
+
+def funnel(
+    data_frame=None,
+    x=None,
+    y=None,
+    color=None,
+    color_discrete_sequence=None,
+    color_discrete_map={},
+    orientation=None,
+    textinfo=None,
+    hover_name=None,
+    hover_data=None,
+    custom_data=None,
+    labels={},
+    title=None,
+    template=None,
+    width=None,
+    height=None,
+    opacity=None,
+        ):
+    """
+    In a funnel plot, each row of `data_frame` is represented as a rectangular sector of a funnel.
+    """
+    return make_figure(
+        args=locals(),
+        constructor=go.Funnel,
+        trace_patch=dict(opacity=opacity, orientation=orientation, textinfo=textinfo),
+    )
+
+
+funnel.__doc__ = make_docstring(funnel, override_dict=dict(textinfo=["str", "Determines which trace information appear on the graph. In the case of having multiple funnels, percentages & totals are computed separately (per trace)."]))
+
+
+def funnel_area(
+    data_frame=None,
+    values=None,
+    text=None,
+    textinfo=None,
+    hover_name=None,
+    hover_data=None,
+    custom_data=None,
+    labels={},
+    title=None,
+    template=None,
+    width=None,
+    height=None,
+        ):
+    """
+    In a funnel area plot, each row of `data_frame` is represented as a trapezoidal sector of a funnel.
+    """
+    return make_figure(
+        args=locals(),
+        constructor=go.Funnelarea,
+    )
+
+
+funnel_area.__doc__ = make_docstring(funnel_area, override_dict=dict(textinfo=["str", "Determines which trace information appear on the graph. In the case of having multiple funnels, percentages & totals are computed separately (per trace)."]))

packages/python/plotly/plotly/express/_core.py

@@ -305,11 +305,25 @@ def make_trace_kwargs(args, trace_spec, g, mapping_labels, sizeref):
             elif k == "locations":
                 result[k] = g[v]
                 mapping_labels[v_label] = "%{location}"
+            elif k == "values":
+                result[k] = g[v]
+                mapping_labels["value"] = "%{value}"
+            elif k == "parents":
+                result[k] = g[v]
+                mapping_labels["parent"] = "%{parent}"
+            elif k == "ids":
+                result[k] = g[v]
+                mapping_labels["id"] = "%{id}"
+            elif k == "text":
+                if trace_spec.constructor in [go.Sunburst, go.Treemap]:
+                    result["labels"] = g[v]
+                else:
+                    result[k] = g[v]
             else:
                 if v:
                     result[k] = g[v]
                 mapping_labels[v_label] = "%%{%s}" % k
-    if trace_spec.constructor not in [go.Parcoords, go.Parcats]:
+    if trace_spec.constructor not in [go.Parcoords, go.Parcats, go.Sunburst, go.Treemap]:
         hover_lines = [k + "=" + v for k, v in mapping_labels.items()]
         result["hovertemplate"] = hover_header + "<br>".join(hover_lines)
     return result, fit_results
@@ -956,6 +970,7 @@ def infer_config(args, constructor, trace_patch):
     attrables = (
         ["x", "y", "z", "a", "b", "c", "r", "theta", "size", "dimensions"]
         + ["custom_data", "hover_name", "hover_data", "text"]
+        + ["values", "parents", "ids"]
         + ["error_x", "error_x_minus"]
         + ["error_y", "error_y_minus", "error_z", "error_z_minus"]
         + ["lat", "lon", "locations", "animation_group"]
@@ -997,6 +1012,8 @@ def infer_config(args, constructor, trace_patch):
             grouped_attrs.append("marker.color")
 
         show_colorbar = bool("color" in attrs and args["color"])
+    else:
+        show_colorbar=False
 
     # Compute line_dash grouping attribute
     if "line_dash" in args:
@@ -1148,6 +1165,7 @@ def make_figure(args, constructor, trace_patch={}, layout_patch={}):
                 go.Parcoords,
                 go.Choropleth,
                 go.Histogram2d,
+                go.Sunburst,
             ]:
                 trace.update(
                     legendgroup=trace_name,

packages/python/plotly/plotly/express/_doc.py

@@ -66,6 +66,21 @@
         colref_desc,
         "Values from this column or array_like are used to position marks along the angular axis in polar coordinates.",
     ],
+    values=[
+        colref_type,
+        colref_desc,
+        "Values from this column or array_like are used to set values associated to sectors."
+    ],
+    parents=[
+        colref_type,
+        colref_desc,
+        "Values from this column or array_like are used to set values associated to sectors."
+    ],
+    ids=[
+        colref_type,
+        colref_desc,
+        "Values from this column or array_like are used to set values associated to sectors."
+    ],
     lat=[
         colref_type,
         colref_desc,
@@ -442,21 +457,35 @@
     nbins=["int", "Positive integer.", "Sets the number of bins."],
     nbinsx=["int", "Positive integer.", "Sets the number of bins along the x axis."],
     nbinsy=["int", "Positive integer.", "Sets the number of bins along the y axis."],
+    branchvalues=["str", "'total' or 'remainder'", 
+            "Determines how the items in `values` are summed. When"
+            "set to 'total', items in `values` are taken to be value"
+            "of all its descendants. When set to 'remainder', items"
+            "in `values` corresponding to the root and the branches"
+            ":sectors are taken to be the extra part not part of the"
+            "sum of the values at their leaves."],
+    maxdepth=["int", "Positive integer", 
+            "Sets the number of rendered sectors from any given `level`. Set `maxdepth` to -1 to render all the"
+            "levels in the hierarchy."]
 )
 
 
-def make_docstring(fn):
+def make_docstring(fn, override_dict={}):
     tw = TextWrapper(width=77, initial_indent="    ", subsequent_indent="    ")
     result = (fn.__doc__ or "") + "\nParameters\n----------\n"
     for param in inspect.getargspec(fn)[0]:
-        param_desc_list = docs[param][1:]
+        if override_dict.get(param):
+            param_doc = override_dict[param]
+        else:
+            param_doc = docs[param]
+        param_desc_list = param_doc[1:]
         param_desc = (
             tw.fill(" ".join(param_desc_list or ""))
             if param in docs
             else "(documentation missing from map)"
         )
 
-        param_type = docs[param][0]
+        param_type = param_doc[0]
         result += "%s: %s\n%s\n" % (param, param_type, param_desc)
     result += "\nReturns\n-------\n"
     result += "    A `Figure` object."