display deprecated warnings for mapbox traces and skip their validation in templates

Author: archmoj

packages/python/plotly/codegen/datatypes.py

@@ -5,6 +5,13 @@
 from codegen.utils import PlotlyNode, write_source_py
 
 
+Deprecated_mapbox_traces = [
+    "scattermapbox",
+    "choroplethmapbox",
+    "densitymapbox",
+]
+
+
 def get_typing_type(plotly_type, array_ok=False):
     """
     Get Python type corresponding to a valType string from the plotly schema
@@ -95,6 +102,9 @@ def build_datatype_py(node):
     )
     buffer.write(f"import copy as _copy\n")
 
+    if node.name_property in Deprecated_mapbox_traces:
+        buffer.write(f"from warnings import warn\n")
+
     # Write class definition
     # ----------------------
     buffer.write(
@@ -400,6 +410,18 @@ def __init__(self"""
 """
     )
 
+    if node.name_property in Deprecated_mapbox_traces:
+        buffer.write(
+            f"""
+        warn(
+            "*{node.name_property}* is deprecated!"
+            + " Use *{node.name_property.replace("mapbox", "map")}* instead."
+            + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
+            stacklevel=2
+        )
+"""
+        )
+
     # Return source string
     # --------------------
     return buffer.getvalue()

packages/python/plotly/plotly/basedatatypes.py

@@ -28,6 +28,12 @@
 #   - Setting a property to Undefined leaves existing value unmodified
 Undefined = object()
 
+Deprecated_mapbox_traces = [
+    "scattermapbox",
+    "choroplethmapbox",
+    "densitymapbox",
+]
+
 
 def _len_dict_item(item):
     """
@@ -4840,49 +4846,56 @@ def __setitem__(self, prop, value):
             # ### Unwrap scalar tuple ###
             prop = prop[0]
 
-            if self._validate:
-                if prop not in self._valid_props:
-                    self._raise_on_invalid_property_error()(prop)
+            # skip deprecated mapbox templates
+            if (
+                prop not in Deprecated_mapbox_traces
+                or "template" not in self._parent_path_str
+            ):
+                if self._validate:
+                    if prop not in self._valid_props:
+                        self._raise_on_invalid_property_error()(prop)
 
-                # ### Get validator for this property ###
-                validator = self._get_validator(prop)
+                    # ### Get validator for this property ###
+                    validator = self._get_validator(prop)
 
-                # ### Handle compound property ###
-                if isinstance(validator, CompoundValidator):
-                    self._set_compound_prop(prop, value)
+                    # ### Handle compound property ###
+                    if isinstance(validator, CompoundValidator):
+                        self._set_compound_prop(prop, value)
 
-                # ### Handle compound array property ###
-                elif isinstance(validator, (CompoundArrayValidator, BaseDataValidator)):
-                    self._set_array_prop(prop, value)
+                    # ### Handle compound array property ###
+                    elif isinstance(
+                        validator, (CompoundArrayValidator, BaseDataValidator)
+                    ):
+                        self._set_array_prop(prop, value)
 
-                # ### Handle simple property ###
+                    # ### Handle simple property ###
+                    else:
+                        self._set_prop(prop, value)
                 else:
-                    self._set_prop(prop, value)
-            else:
-                # Make sure properties dict is initialized
-                self._init_props()
-
-                if isinstance(value, BasePlotlyType):
-                    # Extract json from graph objects
-                    value = value.to_plotly_json()
-
-                # Check for list/tuple of graph objects
-                if (
-                    isinstance(value, (list, tuple))
-                    and value
-                    and isinstance(value[0], BasePlotlyType)
-                ):
-                    value = [
-                        v.to_plotly_json() if isinstance(v, BasePlotlyType) else v
-                        for v in value
-                    ]
+                    # Make sure properties dict is initialized
+                    self._init_props()
+
+                    if isinstance(value, BasePlotlyType):
+                        # Extract json from graph objects
+                        value = value.to_plotly_json()
+
+                    # Check for list/tuple of graph objects
+                    if (
+                        isinstance(value, (list, tuple))
+                        and value
+                        and isinstance(value[0], BasePlotlyType)
+                    ):
+                        value = [
+                            v.to_plotly_json() if isinstance(v, BasePlotlyType) else v
+                            for v in value
+                        ]
 
-                self._props[prop] = value
+                    self._props[prop] = value
 
-                # Remove any already constructed graph object so that it will be
-                # reconstructed on property access
-                self._compound_props.pop(prop, None)
-                self._compound_array_props.pop(prop, None)
+                    # Remove any already constructed graph object so that it will be
+                    # reconstructed on property access
+                    self._compound_props.pop(prop, None)
+                    self._compound_array_props.pop(prop, None)
 
         # Handle non-scalar case
         # ----------------------

packages/python/plotly/plotly/graph_objs/_choroplethmapbox.py

@@ -1,5 +1,6 @@
 from plotly.basedatatypes import BaseTraceType as _BaseTraceType
 import copy as _copy
+from warnings import warn
 
 
 class Choroplethmapbox(_BaseTraceType):
@@ -2378,3 +2379,10 @@ def __init__(
         # Reset skip_invalid
         # ------------------
         self._skip_invalid = False
+
+        warn(
+            "*choroplethmapbox* is deprecated!"
+            + " Use *choroplethmap* instead."
+            + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
+            stacklevel=2,
+        )

packages/python/plotly/plotly/graph_objs/_densitymapbox.py

@@ -1,5 +1,6 @@
 from plotly.basedatatypes import BaseTraceType as _BaseTraceType
 import copy as _copy
+from warnings import warn
 
 
 class Densitymapbox(_BaseTraceType):
@@ -2319,3 +2320,10 @@ def __init__(
         # Reset skip_invalid
         # ------------------
         self._skip_invalid = False
+
+        warn(
+            "*densitymapbox* is deprecated!"
+            + " Use *densitymap* instead."
+            + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
+            stacklevel=2,
+        )

packages/python/plotly/plotly/graph_objs/_scattermapbox.py

@@ -1,5 +1,6 @@
 from plotly.basedatatypes import BaseTraceType as _BaseTraceType
 import copy as _copy
+from warnings import warn
 
 
 class Scattermapbox(_BaseTraceType):
@@ -2292,3 +2293,10 @@ def __init__(
         # Reset skip_invalid
         # ------------------
         self._skip_invalid = False
+
+        warn(
+            "*scattermapbox* is deprecated!"
+            + " Use *scattermap* instead."
+            + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
+            stacklevel=2,
+        )