Update to_plotly_json docstring, and add new to_json_string helper method #4301
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
alexcjohnson
approved these changes
Aug 21, 2023
There was a problem hiding this comment.
💃 This looks great @itsluketwist - other than my one comment above, just add a changelog entry and we'll be good to merge 🎉
|
@alexcjohnson - all fixed up, should be ready to go! 😄 Issue #4281 can also be closed too. |
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 aims to resolve some pain points raised in issue 4281, regarding JSON serialization.
The
to_plotly_jsonmethod simply returns a dictionary, it is not necessarily JSON compatible (it can have invalid data-types included), plotly does provide an encoder - but this isn't immediately obvious.I've updated the docstring of
to_plotly_jsonto include a warning about the above, and point at the available encoder, as well as adding a simple utility method that performs the JSON serialization toBasePlotlyType, to keep in line with theBaseFigureinterface.