Raise a clear error for unsupported marginal plot types#5625
Open
eugen-goebel wants to merge 2 commits into
Open
Raise a clear error for unsupported marginal plot types#5625eugen-goebel wants to merge 2 commits into
eugen-goebel wants to merge 2 commits into
Conversation
Closes plotly#4654. Passing an unsupported value to marginal_x, marginal_y or marginal in Plotly Express (for example marginal_x="density") left trace_spec as None in make_trace_spec, which later failed deep inside make_figure with a confusing "'NoneType' object has no attribute 'constructor'". make_trace_spec now raises a ValueError naming the offending value and listing the supported marginal plot types: rug, box, violin and histogram. The singular `marginal` argument is normalised to marginal_x or marginal_y before this point, so the single check covers all three parameters. Adds a regression test in tests/test_optional/test_px/test_marginals.py.
This file contains hidden or 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
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.
Link to issue
Closes #4654
Description of change
make_trace_specnow raises a clearValueErrorlisting the supported marginal plot types when an unsupported value is passed tomarginal_x,marginal_yormarginal, instead of failing later with a cryptic'NoneType' object has no attribute 'constructor'.Demo
Before:
After:
Testing strategy
Adds
test_unsupported_marginal_raises_clear_errorintests/test_optional/test_px/test_marginals.py, which asserts that an unsupported value formarginal_x,marginal_yand the singularmarginalargument raises aValueError. The existing marginal tests still pass.Additional information (optional)
The singular
marginalargument is normalised tomarginal_x/marginal_ybeforemake_trace_specruns, so a single check covers all three parameters.Guidelines