v6.1.0 breaks fig.write_image()

[petrchmelar]

Hi, it seems that setting the ENABLE_KALEIDO_V0_DEPRECATION_WARNINGS = False broke the write_image() method.

plotly.py/plotly/basedatatypes.py

Lines 3898 to 3912 in 1462f3f

	if ENABLE_KALEIDO_V0_DEPRECATION_WARNINGS:
	if (
	kwargs.get("engine", None) in {None, "auto", "kaleido"}
	and kaleido_available()
	and kaleido_major() < 1
	):
	warnings.warn(KALEIDO_DEPRECATION_MSG, DeprecationWarning, stacklevel=2)
	if kwargs.get("engine", None) == "orca":
	warnings.warn(ORCA_DEPRECATION_MSG, DeprecationWarning, stacklevel=2)
	if kwargs.get("engine", None):
	warnings.warn(
	ENGINE_PARAM_DEPRECATION_MSG, DeprecationWarning, stacklevel=2
	)
	return pio.write_image(self, *args, **kwargs)

https://github.com/plotly/plotly.py/pull/5177/files#diff-e30d1d28e90c51821f0eeed0db68656f4317c0754deaec93c3365b8a93b4caefR14

[ErikPGJ]

I see this problem too (it broke CI tests). I am not familiar with the source code but superficially, it works if one removes one level of indentation for return pio.write_image(self, *args, **kwargs).

[Remi-Gau]

regression test

import plotly.graph_objects as go
import numpy as np

def test_write_image(tmp_path):

    np.random.seed(1)

    N = 100
    x = np.random.rand(N)
    y = np.random.rand(N)

    fig = go.Figure()
    fig.add_trace(go.Scatter(
        x=x,
        y=y,
        mode="markers",
    ))

    fig.write_image(tmp_path / "fig1.png")

    assert (tmp_path /"fig1.png").exists()

E       AssertionError: assert False
E        +  where False = exists()
E        +    where exists = (PosixPath('/tmp/pytest-of-remi-gau/pytest-9/test_write_image0') / 'fig1.png').exists

Version tested

plotly	kaleido	test
6.0.1	0.2.1	✅
6.1.0	0.2.1	❌
6.1.0	1.0.0rc13	❌

Also note that kaleido extra dependency

plotly.py/pyproject.toml

Line 49 in 1462f3f

kaleido = ["kaleido==1.0.0rc13"]

will only work if the use ask for --prerelease.

Without this, pip install effectively falls back to 6.0.1.

$ pip install 'plotly[kaleido]' 

Resolved 3 packages in 6ms
Installed 3 packages in 291ms
 + narwhals==1.39.1
 + packaging==25.0
 + plotly==6.0.1
warning: The package `plotly==6.0.1` does not have an extra named `kaleido`

$ pip install --prerelease 'plotly[kaleido]'

Resolved 8 packages in 10ms
Installed 6 packages in 189ms
 + choreographer==1.0.7
 + kaleido==1.0.0rc13
 + logistro==1.1.0
 + orjson==3.10.18
 + plotly==6.1.0
 + simplejson==3.20.1

[zndr27]

Same issue. When I call write_image with plotly 6.1.0 it silently fails to write an image (no error is raised). Reverting to plotly 6.0.1 resolves the issue.

I strongly suggest pulling 6.1.0 from PyPi because of the fact that this happens silently.

[gvwilson]

cc @emilykl @ayjayt

[emilykl]

@petrchmelar @zndr27 This issue has been fixed and released in Plotly.py 6.1.1. Thank you for reporting.

[petrchmelar]

Thanks a lot!