Introduce skip_invalid argument to figure #1162
Merged
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
When set to True (Default is False) all invalid properties (invalid by name or by value) will be skipped an no exception will be raised due to schema violations. The option applies recursively to all child objects, but it only applies within the scope of the constructor. Still TODO: add the skip_invalid option to the figure constructor. propagate this state to trace, layout, and frames validators during figure construction.
Added docstring documentatin of skip_invalid, and added new tests. When set to True (Default is False) all invalid properties (invalid by name or by value) will be skipped an no exception will be raised due to schema violations. The option applies recursively to all child objects, but it only applies within the scope of the constructor.
This restores the pre v3 behavior of silently ignoring invalid properties when retrieving a figure from plot.ly
…re`" This will take a bit more thought. We'll get back to this during the develop,ent of plotly.io. This reverts commit 744d947.
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.
This PR introduces a new public
skip_invalidkwarg toFigureandFigureWidget.When set to
False(the default) invalid properties in the specification ofdata,layout, orframeswill raise aValueError. This is the current behavior.When set to
True, invalid properties in the figure specification (invalid by property name or by property value) will be silently skipped, and noValueErrorwill be raised.This new property serves a similar function to the pre-v3 internal
_raisekwarg. But it's been renamed and made public as I expect it to be a useful option to expose to users, especially in the context of loading a figure specification from an outside source.See discussion in #1158
cc: @scjody