Suppress DeprecationWarning when updating template.data
#5080
+87
−5
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gvwilson
approved these changes
Mar 12, 2025
| # go.Scattermapbox trace object to be created during validation. | ||
| # In order to prevent false deprecation warnings from surfacing, | ||
| # we suppress deprecation warnings for this line only. | ||
| with warnings.catch_warnings(): |
| @@ -394,3 +396,49 @@ def test_load_px_data(return_type): | |||
| else: | |||
| df = getattr(px.data, fname)(return_type=return_type) | |||
| assert len(df) > 0 | |||
|
|
|||
|
|
|||
| def test_warn_on_deprecated_mapbox_px_constructors(): | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #4997
The Mapbox deprecation warning added to
go.Scattermapboxin #4900 is falsely triggered whenever apxfigure is created, because the default template contains a'scattermapbox'key intemplate.data, which causes ago.Scattermapboxtrace object to be created during validation.The Python warning filters suppress these warnings by default since they are not emitted at the top level, but they may surface in Pytest (which enables all warnings) or for anyone using custom warnings settings.
This PR edits the
Templateconstructor to ignoreDeprecationWarnings emitted while settingtemplate.data. It also adds tests to verify that deprecation warnings are correctly emitted.Note: I've also opened #5081 to track work for removing
mapboxand made a note to remove'scattermapbox'from templates as part of that work.This reduces the warning noise in our own unit tests as well.
test_optionalonmain:test_optionalon this branch: