Skip to content

Drop support for Kaleido v0.x, and Orca - #5677

Merged
emilykl merged 15 commits into
v7.0from
drop-kaleido-v0
Jul 28, 2026
Merged

Drop support for Kaleido v0.x, and Orca#5677
emilykl merged 15 commits into
v7.0from
drop-kaleido-v0

Conversation

@emilykl

@emilykl emilykl commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Link to issue

Closes #5623, closes #5371

Description of change

  • Drop support for Kaleido v0.x (only Kaleido v1.0 and greater are now supported)
  • Drop support for Orca
  • Remove deprecated engine argument from image IO functions
  • Update tests accordingly
    • Add tests that expected errors are raised when Kaleido v0.x is installed

Note: plotly.js dev build CI job is expected to fail, and docs build will fail until docs are updated by #5678.

Testing strategy

  • Updated existing tests according to the changes
  • Added new test suite test_kaleido_v0_error.py which verifies that the expected error is raised when image IO functions are called with Kaleido v0.x installed

To test locally:

  1. Pull this branch and run `pip install -e . ".[dev]"
  2. Check that calling fig.write_image(px.scatter(y=[1,2,3]), "fig.png") works as expected and produces an image
  3. Run pip install "kaleido<1"
  4. Check that calling fig.write_image(px.scatter(y=[1,2,3]), "fig.png") raises a RuntimeError saying that only Kaleido version 1 and greater is supported

Guidelines

@emilykl
emilykl force-pushed the drop-kaleido-v0 branch 2 times, most recently from 0cfbbf4 to 6684995 Compare July 28, 2026 01:15
@emilykl
emilykl marked this pull request as ready for review July 28, 2026 13:06

@camdecoster camdecoster left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good overall, but I have a few suggestions. Could you take a look at _sg_scraper.py? I think that might need to be updated since the Orca option with Sphinx Gallery was removed.

Comment thread plotly/io/_kaleido.py Outdated
Comment thread plotly/io/_kaleido.py
Comment thread plotly/io/_kaleido.py
Comment thread plotly/basedatatypes.py Outdated
Comment thread plotly/basedatatypes.py Outdated
Comment on lines +3770 to +3772
fig:
Figure object or dict representing a figure

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
fig:
Figure object or dict representing a figure

Comment thread tests/test_optional/test_kaleido/test_kaleido_v0_error.py
Comment thread CHANGELOG.md Outdated
Comment thread plotly/io/_base_renderers.py
emilykl and others added 2 commits July 28, 2026 17:56
@emilykl
emilykl merged commit 7ef02ae into v7.0 Jul 28, 2026
19 of 21 checks passed
@emilykl
emilykl deleted the drop-kaleido-v0 branch July 28, 2026 22:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants