Upgrade plotly.js to 3.1.0

codegen/datatypes.py

@@ -10,6 +10,10 @@
     "choroplethmapbox",
     "densitymapbox",
 ]
+locationmode_traces = [
+    "choropleth",
+    "scattergeo",
+]
 
 
 def get_typing_type(plotly_type, array_ok=False):
@@ -100,6 +104,7 @@ def build_datatype_py(node):
 
     if (
         node.name_property in deprecated_mapbox_traces
+        or node.name_property in locationmode_traces
         or node.name_property == "template"
     ):
         buffer.write("import warnings\n")
@@ -341,6 +346,27 @@ def __init__(self"""
 constructor must be a dict or
 an instance of :class:`{class_name}`\"\"\")
 
+        """
+    )
+
+    # Add warning for 'country names' locationmode
+    if node.name_property in locationmode_traces:
+        buffer.write(
+            f"""
+        if locationmode == "country names" and kwargs.get("_validate"):
+            warnings.warn(
+                "The library used by the *country names* `locationmode` option is changing in an upcoming version. "
+                "Country names in existing plots may not work in the new version. "
+                "To ensure consistent behavior, consider setting `locationmode` to *ISO-3*.",
+                DeprecationWarning,
+                stacklevel=5,
+            )
+
+            """
+        )
+
+    buffer.write(
+        f"""
         self._skip_invalid = kwargs.pop("skip_invalid", False)
         self._validate = kwargs.pop("_validate", True)
         """

js/package.json

@@ -19,7 +19,7 @@
     },
     "dependencies": {
       "lodash-es": "^4.17.21",
-      "plotly.js": "3.0.3",
+      "plotly.js": "3.1.0",
       "@lumino/widgets": "~2.4.0"
     },
     "devDependencies": {

plotly/express/_chart_types.py

@@ -1110,6 +1110,16 @@ def choropleth(
     In a choropleth map, each row of `data_frame` is represented by a
     colored region mark on a map.
     """
+
+    if locationmode == "country names":
+        warn(
+            "The library used by the *country names* `locationmode` option is changing in an upcoming version. "
+            "Country names in existing plots may not work in the new version. "
+            "To ensure consistent behavior, consider setting `locationmode` to *ISO-3*.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+
     return make_figure(
         args=locals(),
         constructor=go.Choropleth,
@@ -1168,6 +1178,16 @@ def scatter_geo(
     In a geographic scatter plot, each row of `data_frame` is represented
     by a symbol mark on a map.
     """
+
+    if locationmode == "country names":
+        warn(
+            "The library used by the *country names* `locationmode` option is changing in an upcoming version. "
+            "Country names in existing plots may not work in the new version. "
+            "To ensure consistent behavior, consider setting `locationmode` to *ISO-3*.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+
     return make_figure(
         args=locals(),
         constructor=go.Scattergeo,

plotly/graph_objs/_bar.py

@@ -386,8 +386,8 @@ def hovertemplate(self):
         (the ones that are `arrayOk: true`) are available. Finally, the
         template string has access to variables `value` and `label`.
         Anything contained in tag `<extra>` is displayed in the
-        secondary box, for example "<extra>{fullData.name}</extra>". To
-        hide the secondary box completely, use an empty tag
+        secondary box, for example `<extra>%{fullData.name}</extra>`.
+        To hide the secondary box completely, use an empty tag
         `<extra></extra>`.
 
         The 'hovertemplate' property is a string and must be specified as:
@@ -1731,7 +1731,7 @@ def _prop_descriptions(self):
             are available. Finally, the template string has access
             to variables `value` and `label`. Anything contained in
             tag `<extra>` is displayed in the secondary box, for
-            example "<extra>{fullData.name}</extra>". To hide the
+            example `<extra>%{fullData.name}</extra>`. To hide the
             secondary box completely, use an empty tag
             `<extra></extra>`.
         hovertemplatesrc
@@ -2197,7 +2197,7 @@ def __init__(
             are available. Finally, the template string has access
             to variables `value` and `label`. Anything contained in
             tag `<extra>` is displayed in the secondary box, for
-            example "<extra>{fullData.name}</extra>". To hide the
+            example `<extra>%{fullData.name}</extra>`. To hide the
             secondary box completely, use an empty tag
             `<extra></extra>`.
         hovertemplatesrc

plotly/graph_objs/_barpolar.py

@@ -260,7 +260,7 @@ def hovertemplate(self):
         Additionally, every attributes that can be specified per-point
         (the ones that are `arrayOk: true`) are available.  Anything
         contained in tag `<extra>` is displayed in the secondary box,
-        for example "<extra>{fullData.name}</extra>". To hide the
+        for example `<extra>%{fullData.name}</extra>`. To hide the
         secondary box completely, use an empty tag `<extra></extra>`.
 
         The 'hovertemplate' property is a string and must be specified as:
@@ -1086,8 +1086,9 @@ def _prop_descriptions(self):
             specified per-point (the ones that are `arrayOk: true`)
             are available.  Anything contained in tag `<extra>` is
             displayed in the secondary box, for example
-            "<extra>{fullData.name}</extra>". To hide the secondary
-            box completely, use an empty tag `<extra></extra>`.
+            `<extra>%{fullData.name}</extra>`. To hide the
+            secondary box completely, use an empty tag
+            `<extra></extra>`.
         hovertemplatesrc
             Sets the source reference on Chart Studio Cloud for
             `hovertemplate`.
@@ -1368,8 +1369,9 @@ def __init__(
             specified per-point (the ones that are `arrayOk: true`)
             are available.  Anything contained in tag `<extra>` is
             displayed in the secondary box, for example
-            "<extra>{fullData.name}</extra>". To hide the secondary
-            box completely, use an empty tag `<extra></extra>`.
+            `<extra>%{fullData.name}</extra>`. To hide the
+            secondary box completely, use an empty tag
+            `<extra></extra>`.
         hovertemplatesrc
             Sets the source reference on Chart Studio Cloud for
             `hovertemplate`.

plotly/graph_objs/_box.py

@@ -377,7 +377,7 @@ def hovertemplate(self):
         Additionally, every attributes that can be specified per-point
         (the ones that are `arrayOk: true`) are available.  Anything
         contained in tag `<extra>` is displayed in the secondary box,
-        for example "<extra>{fullData.name}</extra>". To hide the
+        for example `<extra>%{fullData.name}</extra>`. To hide the
         secondary box completely, use an empty tag `<extra></extra>`.
 
         The 'hovertemplate' property is a string and must be specified as:
@@ -1996,8 +1996,9 @@ def _prop_descriptions(self):
             specified per-point (the ones that are `arrayOk: true`)
             are available.  Anything contained in tag `<extra>` is
             displayed in the secondary box, for example
-            "<extra>{fullData.name}</extra>". To hide the secondary
-            box completely, use an empty tag `<extra></extra>`.
+            `<extra>%{fullData.name}</extra>`. To hide the
+            secondary box completely, use an empty tag
+            `<extra></extra>`.
         hovertemplatesrc
             Sets the source reference on Chart Studio Cloud for
             `hovertemplate`.
@@ -2567,8 +2568,9 @@ def __init__(
             specified per-point (the ones that are `arrayOk: true`)
             are available.  Anything contained in tag `<extra>` is
             displayed in the secondary box, for example
-            "<extra>{fullData.name}</extra>". To hide the secondary
-            box completely, use an empty tag `<extra></extra>`.
+            `<extra>%{fullData.name}</extra>`. To hide the
+            secondary box completely, use an empty tag
+            `<extra></extra>`.
         hovertemplatesrc
             Sets the source reference on Chart Studio Cloud for
             `hovertemplate`.

plotly/graph_objs/_choropleth.py

@@ -3,6 +3,7 @@
 
 from plotly.basedatatypes import BaseTraceType as _BaseTraceType
 import copy as _copy
+import warnings
 
 
 class Choropleth(_BaseTraceType):
@@ -370,7 +371,7 @@ def hovertemplate(self):
         Additionally, every attributes that can be specified per-point
         (the ones that are `arrayOk: true`) are available.  Anything
         contained in tag `<extra>` is displayed in the secondary box,
-        for example "<extra>{fullData.name}</extra>". To hide the
+        for example `<extra>%{fullData.name}</extra>`. To hide the
         secondary box completely, use an empty tag `<extra></extra>`.
 
         The 'hovertemplate' property is a string and must be specified as:
@@ -594,11 +595,14 @@ def legendwidth(self, val):
     @property
     def locationmode(self):
         """
-        Determines the set of locations used to match entries in
-        `locations` to regions on the map. Values "ISO-3", "USA-
-        states", *country names* correspond to features on the base map
-        and value "geojson-id" corresponds to features from a custom
-        GeoJSON linked to the `geojson` attribute.
+        The library used by the *country names* `locationmode` option
+        is changing in an upcoming version. Country names in existing
+        plots may not work in the new version. Determines the set of
+        locations used to match entries in `locations` to regions on
+        the map. Values "ISO-3", "USA-states", *country names*
+        correspond to features on the base map and value "geojson-id"
+        corresponds to features from a custom GeoJSON linked to the
+        `geojson` attribute.
 
         The 'locationmode' property is an enumeration that may be specified as:
           - One of the following enumeration values:
@@ -1196,8 +1200,9 @@ def _prop_descriptions(self):
             specified per-point (the ones that are `arrayOk: true`)
             are available.  Anything contained in tag `<extra>` is
             displayed in the secondary box, for example
-            "<extra>{fullData.name}</extra>". To hide the secondary
-            box completely, use an empty tag `<extra></extra>`.
+            `<extra>%{fullData.name}</extra>`. To hide the
+            secondary box completely, use an empty tag
+            `<extra></extra>`.
         hovertemplatesrc
             Sets the source reference on Chart Studio Cloud for
             `hovertemplate`.
@@ -1241,12 +1246,15 @@ def _prop_descriptions(self):
             Sets the width (in px or fraction) of the legend for
             this trace.
         locationmode
-            Determines the set of locations used to match entries
-            in `locations` to regions on the map. Values "ISO-3",
-            "USA-states", *country names* correspond to features on
-            the base map and value "geojson-id" corresponds to
-            features from a custom GeoJSON linked to the `geojson`
-            attribute.
+            The library used by the *country names* `locationmode`
+            option is changing in an upcoming version. Country
+            names in existing plots may not work in the new
+            version. Determines the set of locations used to match
+            entries in `locations` to regions on the map. Values
+            "ISO-3", "USA-states", *country names* correspond to
+            features on the base map and value "geojson-id"
+            corresponds to features from a custom GeoJSON linked to
+            the `geojson` attribute.
         locations
             Sets the coordinates via location IDs or names. See
             `locationmode` for more info.
@@ -1515,8 +1523,9 @@ def __init__(
             specified per-point (the ones that are `arrayOk: true`)
             are available.  Anything contained in tag `<extra>` is
             displayed in the secondary box, for example
-            "<extra>{fullData.name}</extra>". To hide the secondary
-            box completely, use an empty tag `<extra></extra>`.
+            `<extra>%{fullData.name}</extra>`. To hide the
+            secondary box completely, use an empty tag
+            `<extra></extra>`.
         hovertemplatesrc
             Sets the source reference on Chart Studio Cloud for
             `hovertemplate`.
@@ -1560,12 +1569,15 @@ def __init__(
             Sets the width (in px or fraction) of the legend for
             this trace.
         locationmode
-            Determines the set of locations used to match entries
-            in `locations` to regions on the map. Values "ISO-3",
-            "USA-states", *country names* correspond to features on
-            the base map and value "geojson-id" corresponds to
-            features from a custom GeoJSON linked to the `geojson`
-            attribute.
+            The library used by the *country names* `locationmode`
+            option is changing in an upcoming version. Country
+            names in existing plots may not work in the new
+            version. Determines the set of locations used to match
+            entries in `locations` to regions on the map. Values
+            "ISO-3", "USA-states", *country names* correspond to
+            features on the base map and value "geojson-id"
+            corresponds to features from a custom GeoJSON linked to
+            the `geojson` attribute.
         locations
             Sets the coordinates via location IDs or names. See
             `locationmode` for more info.
@@ -1697,6 +1709,15 @@ def __init__(
 constructor must be a dict or
 an instance of :class:`plotly.graph_objs.Choropleth`""")
 
+        if locationmode == "country names" and kwargs.get("_validate"):
+            warnings.warn(
+                "The library used by the *country names* `locationmode` option is changing in an upcoming version. "
+                "Country names in existing plots may not work in the new version. "
+                "To ensure consistent behavior, consider setting `locationmode` to *ISO-3*.",
+                DeprecationWarning,
+                stacklevel=5,
+            )
+
         self._skip_invalid = kwargs.pop("skip_invalid", False)
         self._validate = kwargs.pop("_validate", True)
 

plotly/graph_objs/_choroplethmap.py

@@ -368,7 +368,7 @@ def hovertemplate(self):
         (the ones that are `arrayOk: true`) are available. Finally, the
         template string has access to variable `properties` Anything
         contained in tag `<extra>` is displayed in the secondary box,
-        for example "<extra>{fullData.name}</extra>". To hide the
+        for example `<extra>%{fullData.name}</extra>`. To hide the
         secondary box completely, use an empty tag `<extra></extra>`.
 
         The 'hovertemplate' property is a string and must be specified as:
@@ -1193,7 +1193,7 @@ def _prop_descriptions(self):
             are available. Finally, the template string has access
             to variable `properties` Anything contained in tag
             `<extra>` is displayed in the secondary box, for
-            example "<extra>{fullData.name}</extra>". To hide the
+            example `<extra>%{fullData.name}</extra>`. To hide the
             secondary box completely, use an empty tag
             `<extra></extra>`.
         hovertemplatesrc
@@ -1510,7 +1510,7 @@ def __init__(
             are available. Finally, the template string has access
             to variable `properties` Anything contained in tag
             `<extra>` is displayed in the secondary box, for
-            example "<extra>{fullData.name}</extra>". To hide the
+            example `<extra>%{fullData.name}</extra>`. To hide the
             secondary box completely, use an empty tag
             `<extra></extra>`.
         hovertemplatesrc

plotly/graph_objs/_choroplethmapbox.py

@@ -369,7 +369,7 @@ def hovertemplate(self):
         (the ones that are `arrayOk: true`) are available. Finally, the
         template string has access to variable `properties` Anything
         contained in tag `<extra>` is displayed in the secondary box,
-        for example "<extra>{fullData.name}</extra>". To hide the
+        for example `<extra>%{fullData.name}</extra>`. To hide the
         secondary box completely, use an empty tag `<extra></extra>`.
 
         The 'hovertemplate' property is a string and must be specified as:
@@ -1198,7 +1198,7 @@ def _prop_descriptions(self):
             are available. Finally, the template string has access
             to variable `properties` Anything contained in tag
             `<extra>` is displayed in the secondary box, for
-            example "<extra>{fullData.name}</extra>". To hide the
+            example `<extra>%{fullData.name}</extra>`. To hide the
             secondary box completely, use an empty tag
             `<extra></extra>`.
         hovertemplatesrc
@@ -1525,7 +1525,7 @@ def __init__(
             are available. Finally, the template string has access
             to variable `properties` Anything contained in tag
             `<extra>` is displayed in the secondary box, for
-            example "<extra>{fullData.name}</extra>". To hide the
+            example `<extra>%{fullData.name}</extra>`. To hide the
             secondary box completely, use an empty tag
             `<extra></extra>`.
         hovertemplatesrc