Merge pull request #2524 from plotly/path_hover_fixes

fixing hover_data and hover_name bugs in path API

Author: nicolaskruchten

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

@@ -1432,23 +1432,12 @@ def process_dataframe_hierarchy(args):
     _check_dataframe_all_leaves(df[path[::-1]])
     discrete_color = False
 
-    if args["color"] and args["color"] in path:
-        series_to_copy = df[args["color"]]
-        new_col_name = args["color"] + "additional_col_for_color"
-        path = [new_col_name if x == args["color"] else x for x in path]
-        df[new_col_name] = series_to_copy
-    if args["hover_data"]:
-        for col_name in args["hover_data"]:
-            if col_name == args["color"]:
-                series_to_copy = df[col_name]
-                new_col_name = str(args["color"]) + "additional_col_for_hover"
-                df[new_col_name] = series_to_copy
-                args["color"] = new_col_name
-            elif col_name in path:
-                series_to_copy = df[col_name]
-                new_col_name = col_name + "additional_col_for_hover"
-                path = [new_col_name if x == col_name else x for x in path]
-                df[new_col_name] = series_to_copy
+    new_path = []
+    for col_name in path:
+        new_col_name = col_name + "_path_copy"
+        new_path.append(new_col_name)
+        df[new_col_name] = df[col_name]
+    path = new_path
     # ------------ Define aggregation functions --------------------------------
 
     def aggfunc_discrete(x):

packages/python/plotly/plotly/tests/test_core/test_px/test_px_functions.py

@@ -171,6 +171,23 @@ def test_sunburst_treemap_with_path_and_hover():
     )
     assert "smoker" in fig.data[0].hovertemplate
 
+    df = px.data.gapminder().query("year == 2007")
+    fig = px.sunburst(
+        df, path=["continent", "country"], color="lifeExp", hover_data=df.columns
+    )
+    assert fig.layout.coloraxis.colorbar.title.text == "lifeExp"
+
+    df = px.data.tips()
+    fig = px.sunburst(df, path=["sex", "day", "time", "smoker"], hover_name="smoker")
+    assert "smoker" not in fig.data[0].hovertemplate  # represented as '%{hovertext}'
+    assert "%{hovertext}" in fig.data[0].hovertemplate  # represented as '%{hovertext}'
+
+    df = px.data.tips()
+    fig = px.sunburst(df, path=["sex", "day", "time", "smoker"], custom_data=["smoker"])
+    assert fig.data[0].customdata[0][0] in ["Yes", "No"]
+    assert "smoker" not in fig.data[0].hovertemplate
+    assert "%{hovertext}" not in fig.data[0].hovertemplate
+
 
 def test_sunburst_treemap_with_path_color():
     vendors = ["A", "B", "C", "D", "E", "F", "G", "H"]