Introduce skip_invalid argument to figure #1162
Merged
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_invalid
kwarg toFigure
andFigureWidget
.When set to
False
(the default) invalid properties in the specification ofdata
,layout
, orframes
will 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 noValueError
will be raised.This new property serves a similar function to the pre-v3 internal
_raise
kwarg. 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