Skip to content

Fix: Display deprecated warnings for mapbox traces#4900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
archmoj merged 8 commits into from
Nov 25, 2024
Merged

Fix: Display deprecated warnings for mapbox traces #4900

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
aba3ab2
display deprecated warnings for mapbox traces and skip their validati…
archmoj Nov 12, 2024
4010260
add DeprecationWarning warning type in codegen
emilykl Nov 25, 2024
c187794
capitalization
emilykl Nov 25, 2024
cb3dba7
clean up basedatatypes (return to previous)
emilykl Nov 25, 2024
9908d72
add deprecation warnings to px mapbox functions
emilykl Nov 25, 2024
3b31f3a
formatting
emilykl Nov 25, 2024
e688d28
Merge branch 'master' into v6-mapbox-deprecated-warning
emilykl Nov 25, 2024
5d113b9
cleanup
emilykl Nov 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions packages/python/plotly/codegen/datatypes.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand DownExpand Up@@ -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(
Expand DownExpand Up@@ -400,6 +410,19 @@ 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,
category=DeprecationWarning,

@archmojarchmojNov 25, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@emilykl Good improvement. And I can approve this PR.
As follow ups to this PR:
Could you possibly

  1. double check that stacklevel=2 is the best option we could use?
  2. should we use similar stacklevel and category options for other warnings in plotly.py?
    Thank you!

@emilyklemilyklNov 25, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe stacklevel=2 is the correct option in this case -- it causes the warning to appear to be emitted at the place in the user's code where they have called the deprecated function, for example:

Making a go.Choroplethmapbox figure...
/Users/ekl/code/plotly.py/my_script.py:32: DeprecationWarning:
*choroplethmapbox* is deprecated! Use *choroplethmap* instead. Learn more at: https://plotly.com/python/mapbox-to-maplibre/

(Also, for DeprecationWarning specifically, using any other stacklevel for these deprecations causes the warning to not appear at all.)

It's just coincidence that stacklevel=2 is the correct option in this case for both the go and px deprecations... the correct stacklevel will differ in every case depending on exactly where the warning is being emitted.

I don't think it's worth the effort to go through the codebase and clean up existing warnings, but I do think it makes sense to use stacklevel and category consistently going forward. It seems at least some of the warnings already in place in Plotly.py are using them correctly.

)
"""
)

# Return source string
# --------------------
return buffer.getvalue()
Expand Down
38 changes: 38 additions & 0 deletions packages/python/plotly/plotly/express/_chart_types.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from warnings import warn

from ._core import make_figure
from ._doc import make_docstring
import plotly.graph_objs as go
Expand DownExpand Up@@ -1415,9 +1417,18 @@ def scatter_mapbox(
height=None,
) -> go.Figure:
"""
*scatter_mapbox* is deprecated! Use *scatter_map* instead.
Learn more at: https://plotly.com/python/mapbox-to-maplibre/
In a Mapbox scatter plot, each row of `data_frame` is represented by a
symbol mark on a Mapbox map.
"""
warn(
"*scatter_mapbox* is deprecated!"
+ " Use *scatter_map* instead."
+ " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
stacklevel=2,
category=DeprecationWarning,
)
return make_figure(args=locals(), constructor=go.Scattermapbox)


Expand DownExpand Up@@ -1453,9 +1464,18 @@ def choropleth_mapbox(
height=None,
) -> go.Figure:
"""
*choropleth_mapbox* is deprecated! Use *choropleth_map* instead.
Learn more at: https://plotly.com/python/mapbox-to-maplibre/
In a Mapbox choropleth map, each row of `data_frame` is represented by a
colored region on a Mapbox map.
"""
warn(
"*choropleth_mapbox* is deprecated!"
+ " Use *choropleth_map* instead."
+ " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
stacklevel=2,
category=DeprecationWarning,
)
return make_figure(args=locals(), constructor=go.Choroplethmapbox)


Expand DownExpand Up@@ -1489,9 +1509,18 @@ def density_mapbox(
height=None,
) -> go.Figure:
"""
*density_mapbox* is deprecated! Use *density_map* instead.
Learn more at: https://plotly.com/python/mapbox-to-maplibre/
In a Mapbox density map, each row of `data_frame` contributes to the intensity of
the color of the region around the corresponding point on the map
"""
warn(
"*density_mapbox* is deprecated!"
+ " Use *density_map* instead."
+ " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
stacklevel=2,
category=DeprecationWarning,
)
return make_figure(
args=locals(), constructor=go.Densitymapbox, trace_patch=dict(radius=radius)
)
Expand DownExpand Up@@ -1526,9 +1555,18 @@ def line_mapbox(
height=None,
) -> go.Figure:
"""
*line_mapbox* is deprecated! Use *line_map* instead.
Learn more at: https://plotly.com/python/mapbox-to-maplibre/
In a Mapbox line plot, each row of `data_frame` is represented as
a vertex of a polyline mark on a Mapbox map.
"""
warn(
"*line_mapbox* is deprecated!"
+ " Use *line_map* instead."
+ " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
stacklevel=2,
category=DeprecationWarning,
)
return make_figure(args=locals(), constructor=go.Scattermapbox)


Expand Down
9 changes: 9 additions & 0 deletions packages/python/plotly/plotly/graph_objs/_choroplethmapbox.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Choroplethmapbox(_BaseTraceType):
Expand DownExpand Up@@ -2378,3 +2379,11 @@ 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,
category=DeprecationWarning,
)
9 changes: 9 additions & 0 deletions packages/python/plotly/plotly/graph_objs/_densitymapbox.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Densitymapbox(_BaseTraceType):
Expand DownExpand Up@@ -2319,3 +2320,11 @@ 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,
category=DeprecationWarning,
)
9 changes: 9 additions & 0 deletions packages/python/plotly/plotly/graph_objs/_scattermapbox.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Scattermapbox(_BaseTraceType):
Expand DownExpand Up@@ -2292,3 +2293,11 @@ 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,
category=DeprecationWarning,
)
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Fix: Display deprecated warnings for mapbox traces by archmoj · Pull Request #4900 · plotly/plotly.py · GitHub
Skip to content
Fix: Display deprecated warnings for mapbox traces#4900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

archmoj
merged 8 commits into

from

Nov 25, 2024
 Merged


Fix: Display deprecated warnings for mapbox traces
#4900
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
aba3ab2

display deprecated warnings for mapbox traces and skip their validati…


archmoj Nov 12, 2024
4010260

add DeprecationWarning warning type in codegen


emilykl Nov 25, 2024
c187794

capitalization


emilykl Nov 25, 2024
cb3dba7

clean up basedatatypes (return to previous)


emilykl Nov 25, 2024
9908d72

add deprecation warnings to px mapbox functions


emilykl Nov 25, 2024
3b31f3a

formatting


emilykl Nov 25, 2024
e688d28

Merge branch 'master' into v6-mapbox-deprecated-warning


emilykl Nov 25, 2024
5d113b9

cleanup


emilykl Nov 25, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


23 changes: 23 additions & 0 deletions
packages/python/plotly/codegen/datatypes.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand DownExpand Up@@ -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(
Expand DownExpand Up@@ -400,6 +410,19 @@ 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,
 category=DeprecationWarning,
@archmojarchmojNov 25, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@emilykl Good improvement. And I can approve this PR.

As follow ups to this PR:

Could you possibly
  1. double check that stacklevel=2 is the best option we could use?
  2. should we use similar stacklevel and category options for other warnings in plotly.py?
    
Thank you!
@emilyklemilyklNov 25, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe stacklevel=2 is the correct option in this case -- it causes the warning to appear to be emitted at the place in the user's code where they have called the deprecated function, for example:
Making a go.Choroplethmapbox figure...
/Users/ekl/code/plotly.py/my_script.py:32: DeprecationWarning:
*choroplethmapbox* is deprecated! Use *choroplethmap* instead. Learn more at: https://plotly.com/python/mapbox-to-maplibre/

(Also, for DeprecationWarning specifically, using any other stacklevel for these deprecations causes the warning to not appear at all.)
It's just coincidence that stacklevel=2 is the correct option in this case for both the go and px deprecations... the correct stacklevel will differ in every case depending on exactly where the warning is being emitted.
I don't think it's worth the effort to go through the codebase and clean up existing warnings, but I do think it makes sense to use stacklevel and category consistently going forward. It seems at least some of the warnings already in place in Plotly.py are using them correctly.
 )
"""
 )

 # Return source string
 # --------------------
 return buffer.getvalue()
Expand Down

38 changes: 38 additions & 0 deletions
packages/python/plotly/plotly/express/_chart_types.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from warnings import warn

from ._core import make_figure
from ._doc import make_docstring
import plotly.graph_objs as go
Expand DownExpand Up@@ -1415,9 +1417,18 @@ def scatter_mapbox(
 height=None,
) -> go.Figure:
 """
 *scatter_mapbox* is deprecated! Use *scatter_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox scatter plot, each row of `data_frame` is represented by a
 symbol mark on a Mapbox map.
 """
 warn(
 "*scatter_mapbox* is deprecated!"
 + " Use *scatter_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(args=locals(), constructor=go.Scattermapbox)


Expand DownExpand Up@@ -1453,9 +1464,18 @@ def choropleth_mapbox(
 height=None,
) -> go.Figure:
 """
 *choropleth_mapbox* is deprecated! Use *choropleth_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox choropleth map, each row of `data_frame` is represented by a
 colored region on a Mapbox map.
 """
 warn(
 "*choropleth_mapbox* is deprecated!"
 + " Use *choropleth_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(args=locals(), constructor=go.Choroplethmapbox)


Expand DownExpand Up@@ -1489,9 +1509,18 @@ def density_mapbox(
 height=None,
) -> go.Figure:
 """
 *density_mapbox* is deprecated! Use *density_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox density map, each row of `data_frame` contributes to the intensity of
 the color of the region around the corresponding point on the map
 """
 warn(
 "*density_mapbox* is deprecated!"
 + " Use *density_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(
 args=locals(), constructor=go.Densitymapbox, trace_patch=dict(radius=radius)
 )
Expand DownExpand Up@@ -1526,9 +1555,18 @@ def line_mapbox(
 height=None,
) -> go.Figure:
 """
 *line_mapbox* is deprecated! Use *line_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox line plot, each row of `data_frame` is represented as
 a vertex of a polyline mark on a Mapbox map.
 """
 warn(
 "*line_mapbox* is deprecated!"
 + " Use *line_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(args=locals(), constructor=go.Scattermapbox)


Expand Down

9 changes: 9 additions & 0 deletions
packages/python/plotly/plotly/graph_objs/_choroplethmapbox.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Choroplethmapbox(_BaseTraceType):
Expand DownExpand Up@@ -2378,3 +2379,11 @@ 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,
 category=DeprecationWarning,
 )

9 changes: 9 additions & 0 deletions
packages/python/plotly/plotly/graph_objs/_densitymapbox.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Densitymapbox(_BaseTraceType):
Expand DownExpand Up@@ -2319,3 +2320,11 @@ 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,
 category=DeprecationWarning,
 )

9 changes: 9 additions & 0 deletions
packages/python/plotly/plotly/graph_objs/_scattermapbox.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Scattermapbox(_BaseTraceType):
Expand DownExpand Up@@ -2292,3 +2293,11 @@ 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,
 category=DeprecationWarning,
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Fix: Display deprecated warnings for mapbox traces by archmoj · Pull Request #4900 · plotly/plotly.py · GitHub
Skip to content
Fix: Display deprecated warnings for mapbox traces#4900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

archmoj
merged 8 commits into

from

Nov 25, 2024
 Merged


Fix: Display deprecated warnings for mapbox traces
#4900
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
aba3ab2

display deprecated warnings for mapbox traces and skip their validati…


archmoj Nov 12, 2024
4010260

add DeprecationWarning warning type in codegen


emilykl Nov 25, 2024
c187794

capitalization


emilykl Nov 25, 2024
cb3dba7

clean up basedatatypes (return to previous)


emilykl Nov 25, 2024
9908d72

add deprecation warnings to px mapbox functions


emilykl Nov 25, 2024
3b31f3a

formatting


emilykl Nov 25, 2024
e688d28

Merge branch 'master' into v6-mapbox-deprecated-warning


emilykl Nov 25, 2024
5d113b9

cleanup


emilykl Nov 25, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


23 changes: 23 additions & 0 deletions
packages/python/plotly/codegen/datatypes.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand DownExpand Up@@ -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(
Expand DownExpand Up@@ -400,6 +410,19 @@ 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,
 category=DeprecationWarning,
@archmojarchmojNov 25, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@emilykl Good improvement. And I can approve this PR.

As follow ups to this PR:

Could you possibly
  1. double check that stacklevel=2 is the best option we could use?
  2. should we use similar stacklevel and category options for other warnings in plotly.py?
    
Thank you!
@emilyklemilyklNov 25, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe stacklevel=2 is the correct option in this case -- it causes the warning to appear to be emitted at the place in the user's code where they have called the deprecated function, for example:
Making a go.Choroplethmapbox figure...
/Users/ekl/code/plotly.py/my_script.py:32: DeprecationWarning:
*choroplethmapbox* is deprecated! Use *choroplethmap* instead. Learn more at: https://plotly.com/python/mapbox-to-maplibre/

(Also, for DeprecationWarning specifically, using any other stacklevel for these deprecations causes the warning to not appear at all.)
It's just coincidence that stacklevel=2 is the correct option in this case for both the go and px deprecations... the correct stacklevel will differ in every case depending on exactly where the warning is being emitted.
I don't think it's worth the effort to go through the codebase and clean up existing warnings, but I do think it makes sense to use stacklevel and category consistently going forward. It seems at least some of the warnings already in place in Plotly.py are using them correctly.
 )
"""
 )

 # Return source string
 # --------------------
 return buffer.getvalue()
Expand Down

38 changes: 38 additions & 0 deletions
packages/python/plotly/plotly/express/_chart_types.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from warnings import warn

from ._core import make_figure
from ._doc import make_docstring
import plotly.graph_objs as go
Expand DownExpand Up@@ -1415,9 +1417,18 @@ def scatter_mapbox(
 height=None,
) -> go.Figure:
 """
 *scatter_mapbox* is deprecated! Use *scatter_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox scatter plot, each row of `data_frame` is represented by a
 symbol mark on a Mapbox map.
 """
 warn(
 "*scatter_mapbox* is deprecated!"
 + " Use *scatter_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(args=locals(), constructor=go.Scattermapbox)


Expand DownExpand Up@@ -1453,9 +1464,18 @@ def choropleth_mapbox(
 height=None,
) -> go.Figure:
 """
 *choropleth_mapbox* is deprecated! Use *choropleth_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox choropleth map, each row of `data_frame` is represented by a
 colored region on a Mapbox map.
 """
 warn(
 "*choropleth_mapbox* is deprecated!"
 + " Use *choropleth_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(args=locals(), constructor=go.Choroplethmapbox)


Expand DownExpand Up@@ -1489,9 +1509,18 @@ def density_mapbox(
 height=None,
) -> go.Figure:
 """
 *density_mapbox* is deprecated! Use *density_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox density map, each row of `data_frame` contributes to the intensity of
 the color of the region around the corresponding point on the map
 """
 warn(
 "*density_mapbox* is deprecated!"
 + " Use *density_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(
 args=locals(), constructor=go.Densitymapbox, trace_patch=dict(radius=radius)
 )
Expand DownExpand Up@@ -1526,9 +1555,18 @@ def line_mapbox(
 height=None,
) -> go.Figure:
 """
 *line_mapbox* is deprecated! Use *line_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox line plot, each row of `data_frame` is represented as
 a vertex of a polyline mark on a Mapbox map.
 """
 warn(
 "*line_mapbox* is deprecated!"
 + " Use *line_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(args=locals(), constructor=go.Scattermapbox)


Expand Down

9 changes: 9 additions & 0 deletions
packages/python/plotly/plotly/graph_objs/_choroplethmapbox.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Choroplethmapbox(_BaseTraceType):
Expand DownExpand Up@@ -2378,3 +2379,11 @@ 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,
 category=DeprecationWarning,
 )

9 changes: 9 additions & 0 deletions
packages/python/plotly/plotly/graph_objs/_densitymapbox.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Densitymapbox(_BaseTraceType):
Expand DownExpand Up@@ -2319,3 +2320,11 @@ 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,
 category=DeprecationWarning,
 )

9 changes: 9 additions & 0 deletions
packages/python/plotly/plotly/graph_objs/_scattermapbox.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Scattermapbox(_BaseTraceType):
Expand DownExpand Up@@ -2292,3 +2293,11 @@ 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,
 category=DeprecationWarning,
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Fix: Display deprecated warnings for mapbox traces by archmoj · Pull Request #4900 · plotly/plotly.py · GitHub
Skip to content
Fix: Display deprecated warnings for mapbox traces#4900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

archmoj
merged 8 commits into

from

Nov 25, 2024
 Merged


Fix: Display deprecated warnings for mapbox traces
#4900
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
aba3ab2

display deprecated warnings for mapbox traces and skip their validati…


archmoj Nov 12, 2024
4010260

add DeprecationWarning warning type in codegen


emilykl Nov 25, 2024
c187794

capitalization


emilykl Nov 25, 2024
cb3dba7

clean up basedatatypes (return to previous)


emilykl Nov 25, 2024
9908d72

add deprecation warnings to px mapbox functions


emilykl Nov 25, 2024
3b31f3a

formatting


emilykl Nov 25, 2024
e688d28

Merge branch 'master' into v6-mapbox-deprecated-warning


emilykl Nov 25, 2024
5d113b9

cleanup


emilykl Nov 25, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


23 changes: 23 additions & 0 deletions
packages/python/plotly/codegen/datatypes.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand DownExpand Up@@ -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(
Expand DownExpand Up@@ -400,6 +410,19 @@ 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,
 category=DeprecationWarning,
@archmojarchmojNov 25, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@emilykl Good improvement. And I can approve this PR.

As follow ups to this PR:

Could you possibly
  1. double check that stacklevel=2 is the best option we could use?
  2. should we use similar stacklevel and category options for other warnings in plotly.py?
    
Thank you!
@emilyklemilyklNov 25, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe stacklevel=2 is the correct option in this case -- it causes the warning to appear to be emitted at the place in the user's code where they have called the deprecated function, for example:
Making a go.Choroplethmapbox figure...
/Users/ekl/code/plotly.py/my_script.py:32: DeprecationWarning:
*choroplethmapbox* is deprecated! Use *choroplethmap* instead. Learn more at: https://plotly.com/python/mapbox-to-maplibre/

(Also, for DeprecationWarning specifically, using any other stacklevel for these deprecations causes the warning to not appear at all.)
It's just coincidence that stacklevel=2 is the correct option in this case for both the go and px deprecations... the correct stacklevel will differ in every case depending on exactly where the warning is being emitted.
I don't think it's worth the effort to go through the codebase and clean up existing warnings, but I do think it makes sense to use stacklevel and category consistently going forward. It seems at least some of the warnings already in place in Plotly.py are using them correctly.
 )
"""
 )

 # Return source string
 # --------------------
 return buffer.getvalue()
Expand Down

38 changes: 38 additions & 0 deletions
packages/python/plotly/plotly/express/_chart_types.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from warnings import warn

from ._core import make_figure
from ._doc import make_docstring
import plotly.graph_objs as go
Expand DownExpand Up@@ -1415,9 +1417,18 @@ def scatter_mapbox(
 height=None,
) -> go.Figure:
 """
 *scatter_mapbox* is deprecated! Use *scatter_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox scatter plot, each row of `data_frame` is represented by a
 symbol mark on a Mapbox map.
 """
 warn(
 "*scatter_mapbox* is deprecated!"
 + " Use *scatter_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(args=locals(), constructor=go.Scattermapbox)


Expand DownExpand Up@@ -1453,9 +1464,18 @@ def choropleth_mapbox(
 height=None,
) -> go.Figure:
 """
 *choropleth_mapbox* is deprecated! Use *choropleth_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox choropleth map, each row of `data_frame` is represented by a
 colored region on a Mapbox map.
 """
 warn(
 "*choropleth_mapbox* is deprecated!"
 + " Use *choropleth_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(args=locals(), constructor=go.Choroplethmapbox)


Expand DownExpand Up@@ -1489,9 +1509,18 @@ def density_mapbox(
 height=None,
) -> go.Figure:
 """
 *density_mapbox* is deprecated! Use *density_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox density map, each row of `data_frame` contributes to the intensity of
 the color of the region around the corresponding point on the map
 """
 warn(
 "*density_mapbox* is deprecated!"
 + " Use *density_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(
 args=locals(), constructor=go.Densitymapbox, trace_patch=dict(radius=radius)
 )
Expand DownExpand Up@@ -1526,9 +1555,18 @@ def line_mapbox(
 height=None,
) -> go.Figure:
 """
 *line_mapbox* is deprecated! Use *line_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox line plot, each row of `data_frame` is represented as
 a vertex of a polyline mark on a Mapbox map.
 """
 warn(
 "*line_mapbox* is deprecated!"
 + " Use *line_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(args=locals(), constructor=go.Scattermapbox)


Expand Down

9 changes: 9 additions & 0 deletions
packages/python/plotly/plotly/graph_objs/_choroplethmapbox.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Choroplethmapbox(_BaseTraceType):
Expand DownExpand Up@@ -2378,3 +2379,11 @@ 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,
 category=DeprecationWarning,
 )

9 changes: 9 additions & 0 deletions
packages/python/plotly/plotly/graph_objs/_densitymapbox.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Densitymapbox(_BaseTraceType):
Expand DownExpand Up@@ -2319,3 +2320,11 @@ 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,
 category=DeprecationWarning,
 )

9 changes: 9 additions & 0 deletions
packages/python/plotly/plotly/graph_objs/_scattermapbox.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Scattermapbox(_BaseTraceType):
Expand DownExpand Up@@ -2292,3 +2293,11 @@ 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,
 category=DeprecationWarning,
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Fix: Display deprecated warnings for mapbox traces by archmoj · Pull Request #4900 · plotly/plotly.py · GitHub
Skip to content
Fix: Display deprecated warnings for mapbox traces#4900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

archmoj
merged 8 commits into

from

Nov 25, 2024
 Merged


Fix: Display deprecated warnings for mapbox traces
#4900
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
aba3ab2

display deprecated warnings for mapbox traces and skip their validati…


archmoj Nov 12, 2024
4010260

add DeprecationWarning warning type in codegen


emilykl Nov 25, 2024
c187794

capitalization


emilykl Nov 25, 2024
cb3dba7

clean up basedatatypes (return to previous)


emilykl Nov 25, 2024
9908d72

add deprecation warnings to px mapbox functions


emilykl Nov 25, 2024
3b31f3a

formatting


emilykl Nov 25, 2024
e688d28

Merge branch 'master' into v6-mapbox-deprecated-warning


emilykl Nov 25, 2024
5d113b9

cleanup


emilykl Nov 25, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


23 changes: 23 additions & 0 deletions
packages/python/plotly/codegen/datatypes.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand DownExpand Up@@ -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(
Expand DownExpand Up@@ -400,6 +410,19 @@ 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,
 category=DeprecationWarning,
@archmojarchmojNov 25, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@emilykl Good improvement. And I can approve this PR.

As follow ups to this PR:

Could you possibly
  1. double check that stacklevel=2 is the best option we could use?
  2. should we use similar stacklevel and category options for other warnings in plotly.py?
    
Thank you!
@emilyklemilyklNov 25, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe stacklevel=2 is the correct option in this case -- it causes the warning to appear to be emitted at the place in the user's code where they have called the deprecated function, for example:
Making a go.Choroplethmapbox figure...
/Users/ekl/code/plotly.py/my_script.py:32: DeprecationWarning:
*choroplethmapbox* is deprecated! Use *choroplethmap* instead. Learn more at: https://plotly.com/python/mapbox-to-maplibre/

(Also, for DeprecationWarning specifically, using any other stacklevel for these deprecations causes the warning to not appear at all.)
It's just coincidence that stacklevel=2 is the correct option in this case for both the go and px deprecations... the correct stacklevel will differ in every case depending on exactly where the warning is being emitted.
I don't think it's worth the effort to go through the codebase and clean up existing warnings, but I do think it makes sense to use stacklevel and category consistently going forward. It seems at least some of the warnings already in place in Plotly.py are using them correctly.
 )
"""
 )

 # Return source string
 # --------------------
 return buffer.getvalue()
Expand Down

38 changes: 38 additions & 0 deletions
packages/python/plotly/plotly/express/_chart_types.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from warnings import warn

from ._core import make_figure
from ._doc import make_docstring
import plotly.graph_objs as go
Expand DownExpand Up@@ -1415,9 +1417,18 @@ def scatter_mapbox(
 height=None,
) -> go.Figure:
 """
 *scatter_mapbox* is deprecated! Use *scatter_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox scatter plot, each row of `data_frame` is represented by a
 symbol mark on a Mapbox map.
 """
 warn(
 "*scatter_mapbox* is deprecated!"
 + " Use *scatter_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(args=locals(), constructor=go.Scattermapbox)


Expand DownExpand Up@@ -1453,9 +1464,18 @@ def choropleth_mapbox(
 height=None,
) -> go.Figure:
 """
 *choropleth_mapbox* is deprecated! Use *choropleth_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox choropleth map, each row of `data_frame` is represented by a
 colored region on a Mapbox map.
 """
 warn(
 "*choropleth_mapbox* is deprecated!"
 + " Use *choropleth_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(args=locals(), constructor=go.Choroplethmapbox)


Expand DownExpand Up@@ -1489,9 +1509,18 @@ def density_mapbox(
 height=None,
) -> go.Figure:
 """
 *density_mapbox* is deprecated! Use *density_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox density map, each row of `data_frame` contributes to the intensity of
 the color of the region around the corresponding point on the map
 """
 warn(
 "*density_mapbox* is deprecated!"
 + " Use *density_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(
 args=locals(), constructor=go.Densitymapbox, trace_patch=dict(radius=radius)
 )
Expand DownExpand Up@@ -1526,9 +1555,18 @@ def line_mapbox(
 height=None,
) -> go.Figure:
 """
 *line_mapbox* is deprecated! Use *line_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox line plot, each row of `data_frame` is represented as
 a vertex of a polyline mark on a Mapbox map.
 """
 warn(
 "*line_mapbox* is deprecated!"
 + " Use *line_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(args=locals(), constructor=go.Scattermapbox)


Expand Down

9 changes: 9 additions & 0 deletions
packages/python/plotly/plotly/graph_objs/_choroplethmapbox.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Choroplethmapbox(_BaseTraceType):
Expand DownExpand Up@@ -2378,3 +2379,11 @@ 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,
 category=DeprecationWarning,
 )

9 changes: 9 additions & 0 deletions
packages/python/plotly/plotly/graph_objs/_densitymapbox.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Densitymapbox(_BaseTraceType):
Expand DownExpand Up@@ -2319,3 +2320,11 @@ 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,
 category=DeprecationWarning,
 )

9 changes: 9 additions & 0 deletions
packages/python/plotly/plotly/graph_objs/_scattermapbox.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Scattermapbox(_BaseTraceType):
Expand DownExpand Up@@ -2292,3 +2293,11 @@ 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,
 category=DeprecationWarning,
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Fix: Display deprecated warnings for mapbox traces by archmoj · Pull Request #4900 · plotly/plotly.py · GitHub
Skip to content
Fix: Display deprecated warnings for mapbox traces#4900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

archmoj
merged 8 commits into

from

Nov 25, 2024
 Merged


Fix: Display deprecated warnings for mapbox traces
#4900
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
aba3ab2

display deprecated warnings for mapbox traces and skip their validati…


archmoj Nov 12, 2024
4010260

add DeprecationWarning warning type in codegen


emilykl Nov 25, 2024
c187794

capitalization


emilykl Nov 25, 2024
cb3dba7

clean up basedatatypes (return to previous)


emilykl Nov 25, 2024
9908d72

add deprecation warnings to px mapbox functions


emilykl Nov 25, 2024
3b31f3a

formatting


emilykl Nov 25, 2024
e688d28

Merge branch 'master' into v6-mapbox-deprecated-warning


emilykl Nov 25, 2024
5d113b9

cleanup


emilykl Nov 25, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


23 changes: 23 additions & 0 deletions
packages/python/plotly/codegen/datatypes.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand DownExpand Up@@ -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(
Expand DownExpand Up@@ -400,6 +410,19 @@ 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,
 category=DeprecationWarning,
@archmojarchmojNov 25, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@emilykl Good improvement. And I can approve this PR.

As follow ups to this PR:

Could you possibly
  1. double check that stacklevel=2 is the best option we could use?
  2. should we use similar stacklevel and category options for other warnings in plotly.py?
    
Thank you!
@emilyklemilyklNov 25, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe stacklevel=2 is the correct option in this case -- it causes the warning to appear to be emitted at the place in the user's code where they have called the deprecated function, for example:
Making a go.Choroplethmapbox figure...
/Users/ekl/code/plotly.py/my_script.py:32: DeprecationWarning:
*choroplethmapbox* is deprecated! Use *choroplethmap* instead. Learn more at: https://plotly.com/python/mapbox-to-maplibre/

(Also, for DeprecationWarning specifically, using any other stacklevel for these deprecations causes the warning to not appear at all.)
It's just coincidence that stacklevel=2 is the correct option in this case for both the go and px deprecations... the correct stacklevel will differ in every case depending on exactly where the warning is being emitted.
I don't think it's worth the effort to go through the codebase and clean up existing warnings, but I do think it makes sense to use stacklevel and category consistently going forward. It seems at least some of the warnings already in place in Plotly.py are using them correctly.
 )
"""
 )

 # Return source string
 # --------------------
 return buffer.getvalue()
Expand Down

38 changes: 38 additions & 0 deletions
packages/python/plotly/plotly/express/_chart_types.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from warnings import warn

from ._core import make_figure
from ._doc import make_docstring
import plotly.graph_objs as go
Expand DownExpand Up@@ -1415,9 +1417,18 @@ def scatter_mapbox(
 height=None,
) -> go.Figure:
 """
 *scatter_mapbox* is deprecated! Use *scatter_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox scatter plot, each row of `data_frame` is represented by a
 symbol mark on a Mapbox map.
 """
 warn(
 "*scatter_mapbox* is deprecated!"
 + " Use *scatter_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(args=locals(), constructor=go.Scattermapbox)


Expand DownExpand Up@@ -1453,9 +1464,18 @@ def choropleth_mapbox(
 height=None,
) -> go.Figure:
 """
 *choropleth_mapbox* is deprecated! Use *choropleth_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox choropleth map, each row of `data_frame` is represented by a
 colored region on a Mapbox map.
 """
 warn(
 "*choropleth_mapbox* is deprecated!"
 + " Use *choropleth_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(args=locals(), constructor=go.Choroplethmapbox)


Expand DownExpand Up@@ -1489,9 +1509,18 @@ def density_mapbox(
 height=None,
) -> go.Figure:
 """
 *density_mapbox* is deprecated! Use *density_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox density map, each row of `data_frame` contributes to the intensity of
 the color of the region around the corresponding point on the map
 """
 warn(
 "*density_mapbox* is deprecated!"
 + " Use *density_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(
 args=locals(), constructor=go.Densitymapbox, trace_patch=dict(radius=radius)
 )
Expand DownExpand Up@@ -1526,9 +1555,18 @@ def line_mapbox(
 height=None,
) -> go.Figure:
 """
 *line_mapbox* is deprecated! Use *line_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox line plot, each row of `data_frame` is represented as
 a vertex of a polyline mark on a Mapbox map.
 """
 warn(
 "*line_mapbox* is deprecated!"
 + " Use *line_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(args=locals(), constructor=go.Scattermapbox)


Expand Down

9 changes: 9 additions & 0 deletions
packages/python/plotly/plotly/graph_objs/_choroplethmapbox.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Choroplethmapbox(_BaseTraceType):
Expand DownExpand Up@@ -2378,3 +2379,11 @@ 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,
 category=DeprecationWarning,
 )

9 changes: 9 additions & 0 deletions
packages/python/plotly/plotly/graph_objs/_densitymapbox.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Densitymapbox(_BaseTraceType):
Expand DownExpand Up@@ -2319,3 +2320,11 @@ 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,
 category=DeprecationWarning,
 )

9 changes: 9 additions & 0 deletions
packages/python/plotly/plotly/graph_objs/_scattermapbox.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Scattermapbox(_BaseTraceType):
Expand DownExpand Up@@ -2292,3 +2293,11 @@ 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,
 category=DeprecationWarning,
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Fix: Display deprecated warnings for mapbox traces by archmoj · Pull Request #4900 · plotly/plotly.py · GitHub
Skip to content
Fix: Display deprecated warnings for mapbox traces#4900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

archmoj
merged 8 commits into

from

Nov 25, 2024
 Merged


Fix: Display deprecated warnings for mapbox traces
#4900
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
aba3ab2

display deprecated warnings for mapbox traces and skip their validati…


archmoj Nov 12, 2024
4010260

add DeprecationWarning warning type in codegen


emilykl Nov 25, 2024
c187794

capitalization


emilykl Nov 25, 2024
cb3dba7

clean up basedatatypes (return to previous)


emilykl Nov 25, 2024
9908d72

add deprecation warnings to px mapbox functions


emilykl Nov 25, 2024
3b31f3a

formatting


emilykl Nov 25, 2024
e688d28

Merge branch 'master' into v6-mapbox-deprecated-warning


emilykl Nov 25, 2024
5d113b9

cleanup


emilykl Nov 25, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


23 changes: 23 additions & 0 deletions
packages/python/plotly/codegen/datatypes.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand DownExpand Up@@ -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(
Expand DownExpand Up@@ -400,6 +410,19 @@ 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,
 category=DeprecationWarning,
@archmojarchmojNov 25, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@emilykl Good improvement. And I can approve this PR.

As follow ups to this PR:

Could you possibly
  1. double check that stacklevel=2 is the best option we could use?
  2. should we use similar stacklevel and category options for other warnings in plotly.py?
    
Thank you!
@emilyklemilyklNov 25, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe stacklevel=2 is the correct option in this case -- it causes the warning to appear to be emitted at the place in the user's code where they have called the deprecated function, for example:
Making a go.Choroplethmapbox figure...
/Users/ekl/code/plotly.py/my_script.py:32: DeprecationWarning:
*choroplethmapbox* is deprecated! Use *choroplethmap* instead. Learn more at: https://plotly.com/python/mapbox-to-maplibre/

(Also, for DeprecationWarning specifically, using any other stacklevel for these deprecations causes the warning to not appear at all.)
It's just coincidence that stacklevel=2 is the correct option in this case for both the go and px deprecations... the correct stacklevel will differ in every case depending on exactly where the warning is being emitted.
I don't think it's worth the effort to go through the codebase and clean up existing warnings, but I do think it makes sense to use stacklevel and category consistently going forward. It seems at least some of the warnings already in place in Plotly.py are using them correctly.
 )
"""
 )

 # Return source string
 # --------------------
 return buffer.getvalue()
Expand Down

38 changes: 38 additions & 0 deletions
packages/python/plotly/plotly/express/_chart_types.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from warnings import warn

from ._core import make_figure
from ._doc import make_docstring
import plotly.graph_objs as go
Expand DownExpand Up@@ -1415,9 +1417,18 @@ def scatter_mapbox(
 height=None,
) -> go.Figure:
 """
 *scatter_mapbox* is deprecated! Use *scatter_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox scatter plot, each row of `data_frame` is represented by a
 symbol mark on a Mapbox map.
 """
 warn(
 "*scatter_mapbox* is deprecated!"
 + " Use *scatter_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(args=locals(), constructor=go.Scattermapbox)


Expand DownExpand Up@@ -1453,9 +1464,18 @@ def choropleth_mapbox(
 height=None,
) -> go.Figure:
 """
 *choropleth_mapbox* is deprecated! Use *choropleth_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox choropleth map, each row of `data_frame` is represented by a
 colored region on a Mapbox map.
 """
 warn(
 "*choropleth_mapbox* is deprecated!"
 + " Use *choropleth_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(args=locals(), constructor=go.Choroplethmapbox)


Expand DownExpand Up@@ -1489,9 +1509,18 @@ def density_mapbox(
 height=None,
) -> go.Figure:
 """
 *density_mapbox* is deprecated! Use *density_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox density map, each row of `data_frame` contributes to the intensity of
 the color of the region around the corresponding point on the map
 """
 warn(
 "*density_mapbox* is deprecated!"
 + " Use *density_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(
 args=locals(), constructor=go.Densitymapbox, trace_patch=dict(radius=radius)
 )
Expand DownExpand Up@@ -1526,9 +1555,18 @@ def line_mapbox(
 height=None,
) -> go.Figure:
 """
 *line_mapbox* is deprecated! Use *line_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox line plot, each row of `data_frame` is represented as
 a vertex of a polyline mark on a Mapbox map.
 """
 warn(
 "*line_mapbox* is deprecated!"
 + " Use *line_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(args=locals(), constructor=go.Scattermapbox)


Expand Down

9 changes: 9 additions & 0 deletions
packages/python/plotly/plotly/graph_objs/_choroplethmapbox.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Choroplethmapbox(_BaseTraceType):
Expand DownExpand Up@@ -2378,3 +2379,11 @@ 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,
 category=DeprecationWarning,
 )

9 changes: 9 additions & 0 deletions
packages/python/plotly/plotly/graph_objs/_densitymapbox.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Densitymapbox(_BaseTraceType):
Expand DownExpand Up@@ -2319,3 +2320,11 @@ 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,
 category=DeprecationWarning,
 )

9 changes: 9 additions & 0 deletions
packages/python/plotly/plotly/graph_objs/_scattermapbox.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Scattermapbox(_BaseTraceType):
Expand DownExpand Up@@ -2292,3 +2293,11 @@ 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,
 category=DeprecationWarning,
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Fix: Display deprecated warnings for mapbox traces by archmoj · Pull Request #4900 · plotly/plotly.py · GitHub
Skip to content
Fix: Display deprecated warnings for mapbox traces#4900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

archmoj
merged 8 commits into

from

Nov 25, 2024
 Merged


Fix: Display deprecated warnings for mapbox traces
#4900
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
aba3ab2

display deprecated warnings for mapbox traces and skip their validati…


archmoj Nov 12, 2024
4010260

add DeprecationWarning warning type in codegen


emilykl Nov 25, 2024
c187794

capitalization


emilykl Nov 25, 2024
cb3dba7

clean up basedatatypes (return to previous)


emilykl Nov 25, 2024
9908d72

add deprecation warnings to px mapbox functions


emilykl Nov 25, 2024
3b31f3a

formatting


emilykl Nov 25, 2024
e688d28

Merge branch 'master' into v6-mapbox-deprecated-warning


emilykl Nov 25, 2024
5d113b9

cleanup


emilykl Nov 25, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


23 changes: 23 additions & 0 deletions
packages/python/plotly/codegen/datatypes.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand DownExpand Up@@ -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(
Expand DownExpand Up@@ -400,6 +410,19 @@ 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,
 category=DeprecationWarning,
@archmojarchmojNov 25, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@emilykl Good improvement. And I can approve this PR.

As follow ups to this PR:

Could you possibly
  1. double check that stacklevel=2 is the best option we could use?
  2. should we use similar stacklevel and category options for other warnings in plotly.py?
    
Thank you!
@emilyklemilyklNov 25, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe stacklevel=2 is the correct option in this case -- it causes the warning to appear to be emitted at the place in the user's code where they have called the deprecated function, for example:
Making a go.Choroplethmapbox figure...
/Users/ekl/code/plotly.py/my_script.py:32: DeprecationWarning:
*choroplethmapbox* is deprecated! Use *choroplethmap* instead. Learn more at: https://plotly.com/python/mapbox-to-maplibre/

(Also, for DeprecationWarning specifically, using any other stacklevel for these deprecations causes the warning to not appear at all.)
It's just coincidence that stacklevel=2 is the correct option in this case for both the go and px deprecations... the correct stacklevel will differ in every case depending on exactly where the warning is being emitted.
I don't think it's worth the effort to go through the codebase and clean up existing warnings, but I do think it makes sense to use stacklevel and category consistently going forward. It seems at least some of the warnings already in place in Plotly.py are using them correctly.
 )
"""
 )

 # Return source string
 # --------------------
 return buffer.getvalue()
Expand Down

38 changes: 38 additions & 0 deletions
packages/python/plotly/plotly/express/_chart_types.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
from warnings import warn

from ._core import make_figure
from ._doc import make_docstring
import plotly.graph_objs as go
Expand DownExpand Up@@ -1415,9 +1417,18 @@ def scatter_mapbox(
 height=None,
) -> go.Figure:
 """
 *scatter_mapbox* is deprecated! Use *scatter_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox scatter plot, each row of `data_frame` is represented by a
 symbol mark on a Mapbox map.
 """
 warn(
 "*scatter_mapbox* is deprecated!"
 + " Use *scatter_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(args=locals(), constructor=go.Scattermapbox)


Expand DownExpand Up@@ -1453,9 +1464,18 @@ def choropleth_mapbox(
 height=None,
) -> go.Figure:
 """
 *choropleth_mapbox* is deprecated! Use *choropleth_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox choropleth map, each row of `data_frame` is represented by a
 colored region on a Mapbox map.
 """
 warn(
 "*choropleth_mapbox* is deprecated!"
 + " Use *choropleth_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(args=locals(), constructor=go.Choroplethmapbox)


Expand DownExpand Up@@ -1489,9 +1509,18 @@ def density_mapbox(
 height=None,
) -> go.Figure:
 """
 *density_mapbox* is deprecated! Use *density_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox density map, each row of `data_frame` contributes to the intensity of
 the color of the region around the corresponding point on the map
 """
 warn(
 "*density_mapbox* is deprecated!"
 + " Use *density_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(
 args=locals(), constructor=go.Densitymapbox, trace_patch=dict(radius=radius)
 )
Expand DownExpand Up@@ -1526,9 +1555,18 @@ def line_mapbox(
 height=None,
) -> go.Figure:
 """
 *line_mapbox* is deprecated! Use *line_map* instead.
 Learn more at: https://plotly.com/python/mapbox-to-maplibre/
 In a Mapbox line plot, each row of `data_frame` is represented as
 a vertex of a polyline mark on a Mapbox map.
 """
 warn(
 "*line_mapbox* is deprecated!"
 + " Use *line_map* instead."
 + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/",
 stacklevel=2,
 category=DeprecationWarning,
 )
 return make_figure(args=locals(), constructor=go.Scattermapbox)


Expand Down

9 changes: 9 additions & 0 deletions
packages/python/plotly/plotly/graph_objs/_choroplethmapbox.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Choroplethmapbox(_BaseTraceType):
Expand DownExpand Up@@ -2378,3 +2379,11 @@ 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,
 category=DeprecationWarning,
 )

9 changes: 9 additions & 0 deletions
packages/python/plotly/plotly/graph_objs/_densitymapbox.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Densitymapbox(_BaseTraceType):
Expand DownExpand Up@@ -2319,3 +2320,11 @@ 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,
 category=DeprecationWarning,
 )

9 changes: 9 additions & 0 deletions
packages/python/plotly/plotly/graph_objs/_scattermapbox.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
from warnings import warn


class Scattermapbox(_BaseTraceType):
Expand DownExpand Up@@ -2292,3 +2293,11 @@ 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,
 category=DeprecationWarning,
 )