') + ')', '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('^' + ".*" + ', '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" + ', '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('^' + ".*" + ', '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); } })(); })(); 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

Merged
archmoj merged 8 commits into
masterfrom
v6-mapbox-deprecated-warning
Nov 25, 2024
Merged

Fix: Display deprecated warnings for mapbox traces#4900
archmoj merged 8 commits into
masterfrom
v6-mapbox-deprecated-warning

Conversation

@archmoj

@archmojarchmoj commented Nov 22, 2024•
edited by emilykl
Loading

Copy link
Copy Markdown
Contributor

Closes#4730.

Adds deprecation warnings which are printed to the console when using one of the following objects / functions:

graph objects:

  • go.Choroplethmapbox
  • go.Densitymapbox
  • go.Scattermapbox

express:

  • px.choropleth_mapbox
  • px.density_mapbox
  • px.scatter_mapbox
  • px.line_mapbox

Since the graph objects files are generated by codegen, this PR also modifies the codegen process to automatically add the deprecation warnings to the generated files.

@archmoj
archmoj requested a review from emilyklNovember 22, 2024 11:24
@emilyklemilykl changed the title Fix: Display deprecated warnings for mapbox traces and skip their template validationFix: Display deprecated warnings for mapbox tracesNov 25, 2024
@emilykl

emilykl commented Nov 25, 2024

Copy link
Copy Markdown
Contributor

@LiamConnors When you have a chance, could you sanity check whether the warnings are working as expected for you on this branch? I.e. that we see a warning when using the deprecated traces, but no warnings otherwise.

@LiamConnors

LiamConnors commented Nov 25, 2024

Copy link
Copy Markdown
Contributor

It's working as expected. Looks good to me.

@emilykl

emilykl commented Nov 25, 2024

Copy link
Copy Markdown
Contributor

Thanks Liam. @archmoj@gvwilson This is ready for review.

gvwilson
gvwilson approved these changes Nov 25, 2024
View reviewed changes

@gvwilsongvwilson left a comment

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.

thank you

archmoj
archmoj commented Nov 25, 2024
View reviewed changes
Comment threadpackages/python/plotly/codegen/datatypes.py
+ " 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.

@archmoj
archmoj merged commit 4a21e76 into masterNov 25, 2024
@archmoj
archmoj deleted the v6-mapbox-deprecated-warning branch November 25, 2024 17:07
@karrmagadgeteer2karrmagadgeteer2 mentioned this pull request Jan 29, 2025
Closed
@emilyklemilykl mentioned this pull request Mar 12, 2025
Merged
@LiamConnorsLiamConnors mentioned this pull request Aug 25, 2025
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@emilyklemilyklAwaiting requested review from emilykl
@LiamConnorsLiamConnorsAwaiting requested review from LiamConnors
1 more reviewer
@gvwilsongvwilsongvwilson approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add deprecation warning for Mapbox traces

4 participants

@archmoj@emilykl@LiamConnors@gvwilson