Skip to content

Add note on version compatibility #5308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 4, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions plotly/io/_json.py
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,9 @@ def to_json(fig, validate=True, pretty=False, remove_uids=True, engine=None):
def write_json(fig, file, validate=True, pretty=False, remove_uids=True, engine=None):
"""
Convert a figure to JSON and write it to a file or writeable
object
object.

Note: A figure converted to JSON with one version of Plotly.py may not be compatible with another version.

Parameters
----------
Expand Down Expand Up @@ -414,7 +416,9 @@ def from_json(value, output_type="Figure", skip_invalid=False, engine=None):
def read_json(file, output_type="Figure", skip_invalid=False, engine=None):
"""
Construct a figure from the JSON contents of a local file or readable
Python object
Python object.

Note: A figure converted to JSON with one version of Plotly.py may not be compatible with another version.

Parameters
----------
Expand Down