Support setting plotly.js path for Kaleido v1 image export#5207

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.

Sign up for GitHub

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
emilykl merged 5 commits into from
Jun 3, 2025
Merged

Support setting plotly.js path for Kaleido v1 image export #5207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6837831
support setting plotly.js path
emilykl May 27, 2025
f0aba76
improve pio.defaults test
emilykl Jun 2, 2025
bdf8f05
format
emilykl Jun 2, 2025
2e66fb0
add actual image generation step in test
emilykl Jun 3, 2025
fdab92c
bump kaleido rc version in pyproject.toml and test_requirements
emilykl Jun 3, 2025
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
1 change: 1 addition & 0 deletions plotly/io/_defaults.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ def __init__(self):
self.default_scale = 1
self.mathjax = None
self.topojson = None
self.plotlyjs = None


defaults = _Defaults()
27 changes: 13 additions & 14 deletions plotly/io/_kaleido.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -369,6 +369,12 @@ def to_image(
from kaleido.errors import ChromeNotFoundError

try:
kopts = {}
if defaults.plotlyjs:
kopts["plotlyjs"] = defaults.plotlyjs
if defaults.mathjax:
kopts["mathjax"] = defaults.mathjax

# TODO: Refactor to make it possible to use a shared Kaleido instance here
img_bytes = kaleido.calc_fig_sync(
fig_dict,
Expand All@@ -379,13 +385,7 @@ def to_image(
scale=scale or defaults.default_scale,
),
topojson=defaults.topojson,
kopts=(
dict(
mathjax=defaults.mathjax,
)
if defaults.mathjax
else None
),
kopts=kopts,
)
except ChromeNotFoundError:
raise RuntimeError(PLOTLY_GET_CHROME_ERROR_MSG)
Expand DownExpand Up@@ -692,15 +692,14 @@ def write_images(
from kaleido.errors import ChromeNotFoundError

try:
kopts = {}
if defaults.plotlyjs:
kopts["plotlyjs"] = defaults.plotlyjs
if defaults.mathjax:
kopts["mathjax"] = defaults.mathjax
kaleido.write_fig_from_object_sync(
kaleido_specs,
kopts=(
dict(
mathjax=defaults.mathjax,
)
if defaults.mathjax
else None
),
kopts=kopts,
)
except ChromeNotFoundError:
raise RuntimeError(PLOTLY_GET_CHROME_ERROR_MSG)
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ dependencies = [

[project.optional-dependencies]
express = ["numpy"]
kaleido = ["kaleido==1.0.0rc13"]
kaleido = ["kaleido==1.0.0rc15"]
dev = ["black==25.1.0"]

[project.scripts]
Expand Down
2 changes: 1 addition & 1 deletion test_requirements/requirements_optional.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ matplotlib
scikit-image
psutil
# kaleido>=1.0.0 # Uncomment and delete line below once Kaleido v1 is released
kaleido==1.0.0rc13
kaleido==1.0.0rc15
orjson
polars[timezone]
pyarrow
Expand Down
94 changes: 92 additions & 2 deletions tests/test_optional/test_kaleido/test_kaleido.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,15 +154,105 @@ def test_bytesio():

def test_defaults():
"""Test that image output defaults can be set using pio.defaults.*"""
test_fig = go.Figure(fig)
test_image_bytes = b"mock image data"

# Check initial defaults
assert pio.defaults.default_format == "png"
assert pio.defaults.default_width == 700
assert pio.defaults.default_height == 500
assert pio.defaults.default_scale == 1
assert pio.defaults.mathjax is None
assert pio.defaults.topojson is None
assert pio.defaults.plotlyjs is None

try:
assert pio.defaults.default_format == "png"
# Set new defaults
pio.defaults.default_format = "svg"
pio.defaults.default_width = 701
pio.defaults.default_height = 501
pio.defaults.default_scale = 2
pio.defaults.mathjax = (
"https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
)
pio.defaults.topojson = "path/to/topojson/files/"
pio.defaults.plotlyjs = "https://cdn.plot.ly/plotly-3.0.0.js"

# Check that new defaults are saved
assert pio.defaults.default_format == "svg"
result = pio.to_image(fig, format="svg", validate=False)
assert pio.defaults.default_width == 701
assert pio.defaults.default_height == 501
assert pio.defaults.default_scale == 2
assert (
pio.defaults.mathjax
== "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
)
assert pio.defaults.topojson == "path/to/topojson/files/"
assert pio.defaults.plotlyjs == "https://cdn.plot.ly/plotly-3.0.0.js"

if kaleido_major() > 0:
# Check that all the defaults values are passed through to the function call to calc_fig_sync
with patch(
"plotly.io._kaleido.kaleido.calc_fig_sync",
return_value=test_image_bytes,
) as mock_calc_fig:
result = pio.to_image(test_fig, validate=False)

# Verify calc_fig_sync was called with correct args
# taken from pio.defaults
mock_calc_fig.assert_called_once()
args, kwargs = mock_calc_fig.call_args
assert args[0] == test_fig.to_dict()
assert kwargs["opts"]["format"] == "svg"
assert kwargs["opts"]["width"] == 701
assert kwargs["opts"]["height"] == 501
assert kwargs["opts"]["scale"] == 2
assert kwargs["topojson"] == "path/to/topojson/files/"
# mathjax and plotlyjs are passed through in kopts
assert (
kwargs["kopts"]["mathjax"]
== "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
)
assert (
kwargs["kopts"]["plotlyjs"] == "https://cdn.plot.ly/plotly-3.0.0.js"
)

else:
# Check that all the default values have been set in pio._kaleido.scope
assert pio._kaleido.scope.default_format == "svg"
assert pio._kaleido.scope.default_width == 701
assert pio._kaleido.scope.default_height == 501
assert pio._kaleido.scope.default_scale == 2
assert (
pio._kaleido.scope.mathjax
== "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
)
assert pio._kaleido.scope.topojson == "path/to/topojson/files/"
assert pio._kaleido.scope.plotlyjs == "https://cdn.plot.ly/plotly-3.0.0.js"

# Set topojson default back to None
# (otherwise image generation will fail)
pio.defaults.topojson = None
# Generate image for real and make sure it's an SVG
result = test_fig.to_image(format="svg", validate=False)
assert result.startswith(b"<svg")

finally:
# Reset defaults to original values and check that they are restored
pio.defaults.default_format = "png"
pio.defaults.default_width = 700
pio.defaults.default_height = 500
pio.defaults.default_scale = 1
pio.defaults.mathjax = None
pio.defaults.topojson = None
pio.defaults.plotlyjs = None
assert pio.defaults.default_format == "png"
assert pio.defaults.default_width == 700
assert pio.defaults.default_height == 500
assert pio.defaults.default_scale == 1
assert pio.defaults.mathjax is None
assert pio.defaults.topojson is None
assert pio.defaults.plotlyjs is None


def test_fig_write_image():
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Support setting plotly.js path for Kaleido v1 image export#5207

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.

 Sign up for GitHub

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

emilykl
merged 5 commits into

from

Jun 3, 2025
 Merged


Support setting plotly.js path for Kaleido v1 image export
#5207
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
6837831

support setting plotly.js path


emilykl May 27, 2025
f0aba76

improve pio.defaults test


emilykl Jun 2, 2025
bdf8f05

format


emilykl Jun 2, 2025
2e66fb0

add actual image generation step in test


emilykl Jun 3, 2025
fdab92c

bump kaleido rc version in pyproject.toml and test_requirements


emilykl Jun 3, 2025

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


1 change: 1 addition & 0 deletions
plotly/io/_defaults.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ def __init__(self):
 self.default_scale = 1
 self.mathjax = None
 self.topojson = None
 self.plotlyjs = None


defaults = _Defaults()

27 changes: 13 additions & 14 deletions
plotly/io/_kaleido.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -369,6 +369,12 @@ def to_image(
 from kaleido.errors import ChromeNotFoundError

 try:
 kopts = {}
 if defaults.plotlyjs:
 kopts["plotlyjs"] = defaults.plotlyjs
 if defaults.mathjax:
 kopts["mathjax"] = defaults.mathjax

 # TODO: Refactor to make it possible to use a shared Kaleido instance here
 img_bytes = kaleido.calc_fig_sync(
 fig_dict,
Expand All@@ -379,13 +385,7 @@ def to_image(
 scale=scale or defaults.default_scale,
 ),
 topojson=defaults.topojson,
 kopts=(
 dict(
 mathjax=defaults.mathjax,
 )
 if defaults.mathjax
 else None
 ),
 kopts=kopts,
 )
 except ChromeNotFoundError:
 raise RuntimeError(PLOTLY_GET_CHROME_ERROR_MSG)
Expand DownExpand Up@@ -692,15 +692,14 @@ def write_images(
 from kaleido.errors import ChromeNotFoundError

 try:
 kopts = {}
 if defaults.plotlyjs:
 kopts["plotlyjs"] = defaults.plotlyjs
 if defaults.mathjax:
 kopts["mathjax"] = defaults.mathjax
 kaleido.write_fig_from_object_sync(
 kaleido_specs,
 kopts=(
 dict(
 mathjax=defaults.mathjax,
 )
 if defaults.mathjax
 else None
 ),
 kopts=kopts,
 )
 except ChromeNotFoundError:
 raise RuntimeError(PLOTLY_GET_CHROME_ERROR_MSG)
Expand Down

2 changes: 1 addition & 1 deletion
pyproject.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ dependencies = [

[project.optional-dependencies]
express = ["numpy"]
kaleido = ["kaleido==1.0.0rc13"]
kaleido = ["kaleido==1.0.0rc15"]
dev = ["black==25.1.0"]

[project.scripts]
Expand Down

2 changes: 1 addition & 1 deletion
test_requirements/requirements_optional.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ matplotlib
scikit-image
psutil
# kaleido>=1.0.0 # Uncomment and delete line below once Kaleido v1 is released
kaleido==1.0.0rc13
kaleido==1.0.0rc15
orjson
polars[timezone]
pyarrow
Expand Down

94 changes: 92 additions & 2 deletions
tests/test_optional/test_kaleido/test_kaleido.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,15 +154,105 @@ def test_bytesio():

def test_defaults():
 """Test that image output defaults can be set using pio.defaults.*"""
 test_fig = go.Figure(fig)
 test_image_bytes = b"mock image data"

 # Check initial defaults
 assert pio.defaults.default_format == "png"
 assert pio.defaults.default_width == 700
 assert pio.defaults.default_height == 500
 assert pio.defaults.default_scale == 1
 assert pio.defaults.mathjax is None
 assert pio.defaults.topojson is None
 assert pio.defaults.plotlyjs is None

 try:
assert pio.defaults.default_format == "png"
# Set new defaults
 pio.defaults.default_format = "svg"
 pio.defaults.default_width = 701
 pio.defaults.default_height = 501
 pio.defaults.default_scale = 2
 pio.defaults.mathjax = (
 "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 pio.defaults.topojson = "path/to/topojson/files/"
 pio.defaults.plotlyjs = "https://cdn.plot.ly/plotly-3.0.0.js"

 # Check that new defaults are saved
 assert pio.defaults.default_format == "svg"
 result = pio.to_image(fig, format="svg", validate=False)
 assert pio.defaults.default_width == 701
 assert pio.defaults.default_height == 501
 assert pio.defaults.default_scale == 2
 assert (
 pio.defaults.mathjax
 == "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 assert pio.defaults.topojson == "path/to/topojson/files/"
 assert pio.defaults.plotlyjs == "https://cdn.plot.ly/plotly-3.0.0.js"

 if kaleido_major() > 0:
 # Check that all the defaults values are passed through to the function call to calc_fig_sync
 with patch(
 "plotly.io._kaleido.kaleido.calc_fig_sync",
 return_value=test_image_bytes,
 ) as mock_calc_fig:
 result = pio.to_image(test_fig, validate=False)

 # Verify calc_fig_sync was called with correct args
 # taken from pio.defaults
 mock_calc_fig.assert_called_once()
 args, kwargs = mock_calc_fig.call_args
 assert args[0] == test_fig.to_dict()
 assert kwargs["opts"]["format"] == "svg"
 assert kwargs["opts"]["width"] == 701
 assert kwargs["opts"]["height"] == 501
 assert kwargs["opts"]["scale"] == 2
 assert kwargs["topojson"] == "path/to/topojson/files/"
 # mathjax and plotlyjs are passed through in kopts
 assert (
 kwargs["kopts"]["mathjax"]
 == "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 assert (
 kwargs["kopts"]["plotlyjs"] == "https://cdn.plot.ly/plotly-3.0.0.js"
 )

 else:
 # Check that all the default values have been set in pio._kaleido.scope
 assert pio._kaleido.scope.default_format == "svg"
 assert pio._kaleido.scope.default_width == 701
 assert pio._kaleido.scope.default_height == 501
 assert pio._kaleido.scope.default_scale == 2
 assert (
 pio._kaleido.scope.mathjax
 == "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 assert pio._kaleido.scope.topojson == "path/to/topojson/files/"
 assert pio._kaleido.scope.plotlyjs == "https://cdn.plot.ly/plotly-3.0.0.js"

 # Set topojson default back to None
 # (otherwise image generation will fail)
 pio.defaults.topojson = None
 # Generate image for real and make sure it's an SVG
 result = test_fig.to_image(format="svg", validate=False)
 assert result.startswith(b"<svg")

 finally:
 # Reset defaults to original values and check that they are restored
 pio.defaults.default_format = "png"
 pio.defaults.default_width = 700
 pio.defaults.default_height = 500
 pio.defaults.default_scale = 1
 pio.defaults.mathjax = None
 pio.defaults.topojson = None
 pio.defaults.plotlyjs = None
 assert pio.defaults.default_format == "png"
 assert pio.defaults.default_width == 700
 assert pio.defaults.default_height == 500
 assert pio.defaults.default_scale == 1
 assert pio.defaults.mathjax is None
 assert pio.defaults.topojson is None
 assert pio.defaults.plotlyjs is None


def test_fig_write_image():
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Support setting plotly.js path for Kaleido v1 image export#5207

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.

 Sign up for GitHub

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

emilykl
merged 5 commits into

from

Jun 3, 2025
 Merged


Support setting plotly.js path for Kaleido v1 image export
#5207
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
6837831

support setting plotly.js path


emilykl May 27, 2025
f0aba76

improve pio.defaults test


emilykl Jun 2, 2025
bdf8f05

format


emilykl Jun 2, 2025
2e66fb0

add actual image generation step in test


emilykl Jun 3, 2025
fdab92c

bump kaleido rc version in pyproject.toml and test_requirements


emilykl Jun 3, 2025

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


1 change: 1 addition & 0 deletions
plotly/io/_defaults.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ def __init__(self):
 self.default_scale = 1
 self.mathjax = None
 self.topojson = None
 self.plotlyjs = None


defaults = _Defaults()

27 changes: 13 additions & 14 deletions
plotly/io/_kaleido.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -369,6 +369,12 @@ def to_image(
 from kaleido.errors import ChromeNotFoundError

 try:
 kopts = {}
 if defaults.plotlyjs:
 kopts["plotlyjs"] = defaults.plotlyjs
 if defaults.mathjax:
 kopts["mathjax"] = defaults.mathjax

 # TODO: Refactor to make it possible to use a shared Kaleido instance here
 img_bytes = kaleido.calc_fig_sync(
 fig_dict,
Expand All@@ -379,13 +385,7 @@ def to_image(
 scale=scale or defaults.default_scale,
 ),
 topojson=defaults.topojson,
 kopts=(
 dict(
 mathjax=defaults.mathjax,
 )
 if defaults.mathjax
 else None
 ),
 kopts=kopts,
 )
 except ChromeNotFoundError:
 raise RuntimeError(PLOTLY_GET_CHROME_ERROR_MSG)
Expand DownExpand Up@@ -692,15 +692,14 @@ def write_images(
 from kaleido.errors import ChromeNotFoundError

 try:
 kopts = {}
 if defaults.plotlyjs:
 kopts["plotlyjs"] = defaults.plotlyjs
 if defaults.mathjax:
 kopts["mathjax"] = defaults.mathjax
 kaleido.write_fig_from_object_sync(
 kaleido_specs,
 kopts=(
 dict(
 mathjax=defaults.mathjax,
 )
 if defaults.mathjax
 else None
 ),
 kopts=kopts,
 )
 except ChromeNotFoundError:
 raise RuntimeError(PLOTLY_GET_CHROME_ERROR_MSG)
Expand Down

2 changes: 1 addition & 1 deletion
pyproject.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ dependencies = [

[project.optional-dependencies]
express = ["numpy"]
kaleido = ["kaleido==1.0.0rc13"]
kaleido = ["kaleido==1.0.0rc15"]
dev = ["black==25.1.0"]

[project.scripts]
Expand Down

2 changes: 1 addition & 1 deletion
test_requirements/requirements_optional.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ matplotlib
scikit-image
psutil
# kaleido>=1.0.0 # Uncomment and delete line below once Kaleido v1 is released
kaleido==1.0.0rc13
kaleido==1.0.0rc15
orjson
polars[timezone]
pyarrow
Expand Down

94 changes: 92 additions & 2 deletions
tests/test_optional/test_kaleido/test_kaleido.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,15 +154,105 @@ def test_bytesio():

def test_defaults():
 """Test that image output defaults can be set using pio.defaults.*"""
 test_fig = go.Figure(fig)
 test_image_bytes = b"mock image data"

 # Check initial defaults
 assert pio.defaults.default_format == "png"
 assert pio.defaults.default_width == 700
 assert pio.defaults.default_height == 500
 assert pio.defaults.default_scale == 1
 assert pio.defaults.mathjax is None
 assert pio.defaults.topojson is None
 assert pio.defaults.plotlyjs is None

 try:
assert pio.defaults.default_format == "png"
# Set new defaults
 pio.defaults.default_format = "svg"
 pio.defaults.default_width = 701
 pio.defaults.default_height = 501
 pio.defaults.default_scale = 2
 pio.defaults.mathjax = (
 "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 pio.defaults.topojson = "path/to/topojson/files/"
 pio.defaults.plotlyjs = "https://cdn.plot.ly/plotly-3.0.0.js"

 # Check that new defaults are saved
 assert pio.defaults.default_format == "svg"
 result = pio.to_image(fig, format="svg", validate=False)
 assert pio.defaults.default_width == 701
 assert pio.defaults.default_height == 501
 assert pio.defaults.default_scale == 2
 assert (
 pio.defaults.mathjax
 == "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 assert pio.defaults.topojson == "path/to/topojson/files/"
 assert pio.defaults.plotlyjs == "https://cdn.plot.ly/plotly-3.0.0.js"

 if kaleido_major() > 0:
 # Check that all the defaults values are passed through to the function call to calc_fig_sync
 with patch(
 "plotly.io._kaleido.kaleido.calc_fig_sync",
 return_value=test_image_bytes,
 ) as mock_calc_fig:
 result = pio.to_image(test_fig, validate=False)

 # Verify calc_fig_sync was called with correct args
 # taken from pio.defaults
 mock_calc_fig.assert_called_once()
 args, kwargs = mock_calc_fig.call_args
 assert args[0] == test_fig.to_dict()
 assert kwargs["opts"]["format"] == "svg"
 assert kwargs["opts"]["width"] == 701
 assert kwargs["opts"]["height"] == 501
 assert kwargs["opts"]["scale"] == 2
 assert kwargs["topojson"] == "path/to/topojson/files/"
 # mathjax and plotlyjs are passed through in kopts
 assert (
 kwargs["kopts"]["mathjax"]
 == "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 assert (
 kwargs["kopts"]["plotlyjs"] == "https://cdn.plot.ly/plotly-3.0.0.js"
 )

 else:
 # Check that all the default values have been set in pio._kaleido.scope
 assert pio._kaleido.scope.default_format == "svg"
 assert pio._kaleido.scope.default_width == 701
 assert pio._kaleido.scope.default_height == 501
 assert pio._kaleido.scope.default_scale == 2
 assert (
 pio._kaleido.scope.mathjax
 == "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 assert pio._kaleido.scope.topojson == "path/to/topojson/files/"
 assert pio._kaleido.scope.plotlyjs == "https://cdn.plot.ly/plotly-3.0.0.js"

 # Set topojson default back to None
 # (otherwise image generation will fail)
 pio.defaults.topojson = None
 # Generate image for real and make sure it's an SVG
 result = test_fig.to_image(format="svg", validate=False)
 assert result.startswith(b"<svg")

 finally:
 # Reset defaults to original values and check that they are restored
 pio.defaults.default_format = "png"
 pio.defaults.default_width = 700
 pio.defaults.default_height = 500
 pio.defaults.default_scale = 1
 pio.defaults.mathjax = None
 pio.defaults.topojson = None
 pio.defaults.plotlyjs = None
 assert pio.defaults.default_format == "png"
 assert pio.defaults.default_width == 700
 assert pio.defaults.default_height == 500
 assert pio.defaults.default_scale == 1
 assert pio.defaults.mathjax is None
 assert pio.defaults.topojson is None
 assert pio.defaults.plotlyjs is None


def test_fig_write_image():
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Support setting plotly.js path for Kaleido v1 image export#5207

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.

 Sign up for GitHub

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

emilykl
merged 5 commits into

from

Jun 3, 2025
 Merged


Support setting plotly.js path for Kaleido v1 image export
#5207
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
6837831

support setting plotly.js path


emilykl May 27, 2025
f0aba76

improve pio.defaults test


emilykl Jun 2, 2025
bdf8f05

format


emilykl Jun 2, 2025
2e66fb0

add actual image generation step in test


emilykl Jun 3, 2025
fdab92c

bump kaleido rc version in pyproject.toml and test_requirements


emilykl Jun 3, 2025

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


1 change: 1 addition & 0 deletions
plotly/io/_defaults.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ def __init__(self):
 self.default_scale = 1
 self.mathjax = None
 self.topojson = None
 self.plotlyjs = None


defaults = _Defaults()

27 changes: 13 additions & 14 deletions
plotly/io/_kaleido.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -369,6 +369,12 @@ def to_image(
 from kaleido.errors import ChromeNotFoundError

 try:
 kopts = {}
 if defaults.plotlyjs:
 kopts["plotlyjs"] = defaults.plotlyjs
 if defaults.mathjax:
 kopts["mathjax"] = defaults.mathjax

 # TODO: Refactor to make it possible to use a shared Kaleido instance here
 img_bytes = kaleido.calc_fig_sync(
 fig_dict,
Expand All@@ -379,13 +385,7 @@ def to_image(
 scale=scale or defaults.default_scale,
 ),
 topojson=defaults.topojson,
 kopts=(
 dict(
 mathjax=defaults.mathjax,
 )
 if defaults.mathjax
 else None
 ),
 kopts=kopts,
 )
 except ChromeNotFoundError:
 raise RuntimeError(PLOTLY_GET_CHROME_ERROR_MSG)
Expand DownExpand Up@@ -692,15 +692,14 @@ def write_images(
 from kaleido.errors import ChromeNotFoundError

 try:
 kopts = {}
 if defaults.plotlyjs:
 kopts["plotlyjs"] = defaults.plotlyjs
 if defaults.mathjax:
 kopts["mathjax"] = defaults.mathjax
 kaleido.write_fig_from_object_sync(
 kaleido_specs,
 kopts=(
 dict(
 mathjax=defaults.mathjax,
 )
 if defaults.mathjax
 else None
 ),
 kopts=kopts,
 )
 except ChromeNotFoundError:
 raise RuntimeError(PLOTLY_GET_CHROME_ERROR_MSG)
Expand Down

2 changes: 1 addition & 1 deletion
pyproject.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ dependencies = [

[project.optional-dependencies]
express = ["numpy"]
kaleido = ["kaleido==1.0.0rc13"]
kaleido = ["kaleido==1.0.0rc15"]
dev = ["black==25.1.0"]

[project.scripts]
Expand Down

2 changes: 1 addition & 1 deletion
test_requirements/requirements_optional.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ matplotlib
scikit-image
psutil
# kaleido>=1.0.0 # Uncomment and delete line below once Kaleido v1 is released
kaleido==1.0.0rc13
kaleido==1.0.0rc15
orjson
polars[timezone]
pyarrow
Expand Down

94 changes: 92 additions & 2 deletions
tests/test_optional/test_kaleido/test_kaleido.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,15 +154,105 @@ def test_bytesio():

def test_defaults():
 """Test that image output defaults can be set using pio.defaults.*"""
 test_fig = go.Figure(fig)
 test_image_bytes = b"mock image data"

 # Check initial defaults
 assert pio.defaults.default_format == "png"
 assert pio.defaults.default_width == 700
 assert pio.defaults.default_height == 500
 assert pio.defaults.default_scale == 1
 assert pio.defaults.mathjax is None
 assert pio.defaults.topojson is None
 assert pio.defaults.plotlyjs is None

 try:
assert pio.defaults.default_format == "png"
# Set new defaults
 pio.defaults.default_format = "svg"
 pio.defaults.default_width = 701
 pio.defaults.default_height = 501
 pio.defaults.default_scale = 2
 pio.defaults.mathjax = (
 "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 pio.defaults.topojson = "path/to/topojson/files/"
 pio.defaults.plotlyjs = "https://cdn.plot.ly/plotly-3.0.0.js"

 # Check that new defaults are saved
 assert pio.defaults.default_format == "svg"
 result = pio.to_image(fig, format="svg", validate=False)
 assert pio.defaults.default_width == 701
 assert pio.defaults.default_height == 501
 assert pio.defaults.default_scale == 2
 assert (
 pio.defaults.mathjax
 == "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 assert pio.defaults.topojson == "path/to/topojson/files/"
 assert pio.defaults.plotlyjs == "https://cdn.plot.ly/plotly-3.0.0.js"

 if kaleido_major() > 0:
 # Check that all the defaults values are passed through to the function call to calc_fig_sync
 with patch(
 "plotly.io._kaleido.kaleido.calc_fig_sync",
 return_value=test_image_bytes,
 ) as mock_calc_fig:
 result = pio.to_image(test_fig, validate=False)

 # Verify calc_fig_sync was called with correct args
 # taken from pio.defaults
 mock_calc_fig.assert_called_once()
 args, kwargs = mock_calc_fig.call_args
 assert args[0] == test_fig.to_dict()
 assert kwargs["opts"]["format"] == "svg"
 assert kwargs["opts"]["width"] == 701
 assert kwargs["opts"]["height"] == 501
 assert kwargs["opts"]["scale"] == 2
 assert kwargs["topojson"] == "path/to/topojson/files/"
 # mathjax and plotlyjs are passed through in kopts
 assert (
 kwargs["kopts"]["mathjax"]
 == "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 assert (
 kwargs["kopts"]["plotlyjs"] == "https://cdn.plot.ly/plotly-3.0.0.js"
 )

 else:
 # Check that all the default values have been set in pio._kaleido.scope
 assert pio._kaleido.scope.default_format == "svg"
 assert pio._kaleido.scope.default_width == 701
 assert pio._kaleido.scope.default_height == 501
 assert pio._kaleido.scope.default_scale == 2
 assert (
 pio._kaleido.scope.mathjax
 == "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 assert pio._kaleido.scope.topojson == "path/to/topojson/files/"
 assert pio._kaleido.scope.plotlyjs == "https://cdn.plot.ly/plotly-3.0.0.js"

 # Set topojson default back to None
 # (otherwise image generation will fail)
 pio.defaults.topojson = None
 # Generate image for real and make sure it's an SVG
 result = test_fig.to_image(format="svg", validate=False)
 assert result.startswith(b"<svg")

 finally:
 # Reset defaults to original values and check that they are restored
 pio.defaults.default_format = "png"
 pio.defaults.default_width = 700
 pio.defaults.default_height = 500
 pio.defaults.default_scale = 1
 pio.defaults.mathjax = None
 pio.defaults.topojson = None
 pio.defaults.plotlyjs = None
 assert pio.defaults.default_format == "png"
 assert pio.defaults.default_width == 700
 assert pio.defaults.default_height == 500
 assert pio.defaults.default_scale == 1
 assert pio.defaults.mathjax is None
 assert pio.defaults.topojson is None
 assert pio.defaults.plotlyjs is None


def test_fig_write_image():
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Support setting plotly.js path for Kaleido v1 image export#5207

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.

 Sign up for GitHub

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

emilykl
merged 5 commits into

from

Jun 3, 2025
 Merged


Support setting plotly.js path for Kaleido v1 image export
#5207
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
6837831

support setting plotly.js path


emilykl May 27, 2025
f0aba76

improve pio.defaults test


emilykl Jun 2, 2025
bdf8f05

format


emilykl Jun 2, 2025
2e66fb0

add actual image generation step in test


emilykl Jun 3, 2025
fdab92c

bump kaleido rc version in pyproject.toml and test_requirements


emilykl Jun 3, 2025

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


1 change: 1 addition & 0 deletions
plotly/io/_defaults.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ def __init__(self):
 self.default_scale = 1
 self.mathjax = None
 self.topojson = None
 self.plotlyjs = None


defaults = _Defaults()

27 changes: 13 additions & 14 deletions
plotly/io/_kaleido.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -369,6 +369,12 @@ def to_image(
 from kaleido.errors import ChromeNotFoundError

 try:
 kopts = {}
 if defaults.plotlyjs:
 kopts["plotlyjs"] = defaults.plotlyjs
 if defaults.mathjax:
 kopts["mathjax"] = defaults.mathjax

 # TODO: Refactor to make it possible to use a shared Kaleido instance here
 img_bytes = kaleido.calc_fig_sync(
 fig_dict,
Expand All@@ -379,13 +385,7 @@ def to_image(
 scale=scale or defaults.default_scale,
 ),
 topojson=defaults.topojson,
 kopts=(
 dict(
 mathjax=defaults.mathjax,
 )
 if defaults.mathjax
 else None
 ),
 kopts=kopts,
 )
 except ChromeNotFoundError:
 raise RuntimeError(PLOTLY_GET_CHROME_ERROR_MSG)
Expand DownExpand Up@@ -692,15 +692,14 @@ def write_images(
 from kaleido.errors import ChromeNotFoundError

 try:
 kopts = {}
 if defaults.plotlyjs:
 kopts["plotlyjs"] = defaults.plotlyjs
 if defaults.mathjax:
 kopts["mathjax"] = defaults.mathjax
 kaleido.write_fig_from_object_sync(
 kaleido_specs,
 kopts=(
 dict(
 mathjax=defaults.mathjax,
 )
 if defaults.mathjax
 else None
 ),
 kopts=kopts,
 )
 except ChromeNotFoundError:
 raise RuntimeError(PLOTLY_GET_CHROME_ERROR_MSG)
Expand Down

2 changes: 1 addition & 1 deletion
pyproject.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ dependencies = [

[project.optional-dependencies]
express = ["numpy"]
kaleido = ["kaleido==1.0.0rc13"]
kaleido = ["kaleido==1.0.0rc15"]
dev = ["black==25.1.0"]

[project.scripts]
Expand Down

2 changes: 1 addition & 1 deletion
test_requirements/requirements_optional.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ matplotlib
scikit-image
psutil
# kaleido>=1.0.0 # Uncomment and delete line below once Kaleido v1 is released
kaleido==1.0.0rc13
kaleido==1.0.0rc15
orjson
polars[timezone]
pyarrow
Expand Down

94 changes: 92 additions & 2 deletions
tests/test_optional/test_kaleido/test_kaleido.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,15 +154,105 @@ def test_bytesio():

def test_defaults():
 """Test that image output defaults can be set using pio.defaults.*"""
 test_fig = go.Figure(fig)
 test_image_bytes = b"mock image data"

 # Check initial defaults
 assert pio.defaults.default_format == "png"
 assert pio.defaults.default_width == 700
 assert pio.defaults.default_height == 500
 assert pio.defaults.default_scale == 1
 assert pio.defaults.mathjax is None
 assert pio.defaults.topojson is None
 assert pio.defaults.plotlyjs is None

 try:
assert pio.defaults.default_format == "png"
# Set new defaults
 pio.defaults.default_format = "svg"
 pio.defaults.default_width = 701
 pio.defaults.default_height = 501
 pio.defaults.default_scale = 2
 pio.defaults.mathjax = (
 "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 pio.defaults.topojson = "path/to/topojson/files/"
 pio.defaults.plotlyjs = "https://cdn.plot.ly/plotly-3.0.0.js"

 # Check that new defaults are saved
 assert pio.defaults.default_format == "svg"
 result = pio.to_image(fig, format="svg", validate=False)
 assert pio.defaults.default_width == 701
 assert pio.defaults.default_height == 501
 assert pio.defaults.default_scale == 2
 assert (
 pio.defaults.mathjax
 == "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 assert pio.defaults.topojson == "path/to/topojson/files/"
 assert pio.defaults.plotlyjs == "https://cdn.plot.ly/plotly-3.0.0.js"

 if kaleido_major() > 0:
 # Check that all the defaults values are passed through to the function call to calc_fig_sync
 with patch(
 "plotly.io._kaleido.kaleido.calc_fig_sync",
 return_value=test_image_bytes,
 ) as mock_calc_fig:
 result = pio.to_image(test_fig, validate=False)

 # Verify calc_fig_sync was called with correct args
 # taken from pio.defaults
 mock_calc_fig.assert_called_once()
 args, kwargs = mock_calc_fig.call_args
 assert args[0] == test_fig.to_dict()
 assert kwargs["opts"]["format"] == "svg"
 assert kwargs["opts"]["width"] == 701
 assert kwargs["opts"]["height"] == 501
 assert kwargs["opts"]["scale"] == 2
 assert kwargs["topojson"] == "path/to/topojson/files/"
 # mathjax and plotlyjs are passed through in kopts
 assert (
 kwargs["kopts"]["mathjax"]
 == "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 assert (
 kwargs["kopts"]["plotlyjs"] == "https://cdn.plot.ly/plotly-3.0.0.js"
 )

 else:
 # Check that all the default values have been set in pio._kaleido.scope
 assert pio._kaleido.scope.default_format == "svg"
 assert pio._kaleido.scope.default_width == 701
 assert pio._kaleido.scope.default_height == 501
 assert pio._kaleido.scope.default_scale == 2
 assert (
 pio._kaleido.scope.mathjax
 == "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 assert pio._kaleido.scope.topojson == "path/to/topojson/files/"
 assert pio._kaleido.scope.plotlyjs == "https://cdn.plot.ly/plotly-3.0.0.js"

 # Set topojson default back to None
 # (otherwise image generation will fail)
 pio.defaults.topojson = None
 # Generate image for real and make sure it's an SVG
 result = test_fig.to_image(format="svg", validate=False)
 assert result.startswith(b"<svg")

 finally:
 # Reset defaults to original values and check that they are restored
 pio.defaults.default_format = "png"
 pio.defaults.default_width = 700
 pio.defaults.default_height = 500
 pio.defaults.default_scale = 1
 pio.defaults.mathjax = None
 pio.defaults.topojson = None
 pio.defaults.plotlyjs = None
 assert pio.defaults.default_format == "png"
 assert pio.defaults.default_width == 700
 assert pio.defaults.default_height == 500
 assert pio.defaults.default_scale == 1
 assert pio.defaults.mathjax is None
 assert pio.defaults.topojson is None
 assert pio.defaults.plotlyjs is None


def test_fig_write_image():
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Support setting plotly.js path for Kaleido v1 image export#5207

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.

 Sign up for GitHub

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

emilykl
merged 5 commits into

from

Jun 3, 2025
 Merged


Support setting plotly.js path for Kaleido v1 image export
#5207
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
6837831

support setting plotly.js path


emilykl May 27, 2025
f0aba76

improve pio.defaults test


emilykl Jun 2, 2025
bdf8f05

format


emilykl Jun 2, 2025
2e66fb0

add actual image generation step in test


emilykl Jun 3, 2025
fdab92c

bump kaleido rc version in pyproject.toml and test_requirements


emilykl Jun 3, 2025

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


1 change: 1 addition & 0 deletions
plotly/io/_defaults.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ def __init__(self):
 self.default_scale = 1
 self.mathjax = None
 self.topojson = None
 self.plotlyjs = None


defaults = _Defaults()

27 changes: 13 additions & 14 deletions
plotly/io/_kaleido.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -369,6 +369,12 @@ def to_image(
 from kaleido.errors import ChromeNotFoundError

 try:
 kopts = {}
 if defaults.plotlyjs:
 kopts["plotlyjs"] = defaults.plotlyjs
 if defaults.mathjax:
 kopts["mathjax"] = defaults.mathjax

 # TODO: Refactor to make it possible to use a shared Kaleido instance here
 img_bytes = kaleido.calc_fig_sync(
 fig_dict,
Expand All@@ -379,13 +385,7 @@ def to_image(
 scale=scale or defaults.default_scale,
 ),
 topojson=defaults.topojson,
 kopts=(
 dict(
 mathjax=defaults.mathjax,
 )
 if defaults.mathjax
 else None
 ),
 kopts=kopts,
 )
 except ChromeNotFoundError:
 raise RuntimeError(PLOTLY_GET_CHROME_ERROR_MSG)
Expand DownExpand Up@@ -692,15 +692,14 @@ def write_images(
 from kaleido.errors import ChromeNotFoundError

 try:
 kopts = {}
 if defaults.plotlyjs:
 kopts["plotlyjs"] = defaults.plotlyjs
 if defaults.mathjax:
 kopts["mathjax"] = defaults.mathjax
 kaleido.write_fig_from_object_sync(
 kaleido_specs,
 kopts=(
 dict(
 mathjax=defaults.mathjax,
 )
 if defaults.mathjax
 else None
 ),
 kopts=kopts,
 )
 except ChromeNotFoundError:
 raise RuntimeError(PLOTLY_GET_CHROME_ERROR_MSG)
Expand Down

2 changes: 1 addition & 1 deletion
pyproject.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ dependencies = [

[project.optional-dependencies]
express = ["numpy"]
kaleido = ["kaleido==1.0.0rc13"]
kaleido = ["kaleido==1.0.0rc15"]
dev = ["black==25.1.0"]

[project.scripts]
Expand Down

2 changes: 1 addition & 1 deletion
test_requirements/requirements_optional.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ matplotlib
scikit-image
psutil
# kaleido>=1.0.0 # Uncomment and delete line below once Kaleido v1 is released
kaleido==1.0.0rc13
kaleido==1.0.0rc15
orjson
polars[timezone]
pyarrow
Expand Down

94 changes: 92 additions & 2 deletions
tests/test_optional/test_kaleido/test_kaleido.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,15 +154,105 @@ def test_bytesio():

def test_defaults():
 """Test that image output defaults can be set using pio.defaults.*"""
 test_fig = go.Figure(fig)
 test_image_bytes = b"mock image data"

 # Check initial defaults
 assert pio.defaults.default_format == "png"
 assert pio.defaults.default_width == 700
 assert pio.defaults.default_height == 500
 assert pio.defaults.default_scale == 1
 assert pio.defaults.mathjax is None
 assert pio.defaults.topojson is None
 assert pio.defaults.plotlyjs is None

 try:
assert pio.defaults.default_format == "png"
# Set new defaults
 pio.defaults.default_format = "svg"
 pio.defaults.default_width = 701
 pio.defaults.default_height = 501
 pio.defaults.default_scale = 2
 pio.defaults.mathjax = (
 "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 pio.defaults.topojson = "path/to/topojson/files/"
 pio.defaults.plotlyjs = "https://cdn.plot.ly/plotly-3.0.0.js"

 # Check that new defaults are saved
 assert pio.defaults.default_format == "svg"
 result = pio.to_image(fig, format="svg", validate=False)
 assert pio.defaults.default_width == 701
 assert pio.defaults.default_height == 501
 assert pio.defaults.default_scale == 2
 assert (
 pio.defaults.mathjax
 == "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 assert pio.defaults.topojson == "path/to/topojson/files/"
 assert pio.defaults.plotlyjs == "https://cdn.plot.ly/plotly-3.0.0.js"

 if kaleido_major() > 0:
 # Check that all the defaults values are passed through to the function call to calc_fig_sync
 with patch(
 "plotly.io._kaleido.kaleido.calc_fig_sync",
 return_value=test_image_bytes,
 ) as mock_calc_fig:
 result = pio.to_image(test_fig, validate=False)

 # Verify calc_fig_sync was called with correct args
 # taken from pio.defaults
 mock_calc_fig.assert_called_once()
 args, kwargs = mock_calc_fig.call_args
 assert args[0] == test_fig.to_dict()
 assert kwargs["opts"]["format"] == "svg"
 assert kwargs["opts"]["width"] == 701
 assert kwargs["opts"]["height"] == 501
 assert kwargs["opts"]["scale"] == 2
 assert kwargs["topojson"] == "path/to/topojson/files/"
 # mathjax and plotlyjs are passed through in kopts
 assert (
 kwargs["kopts"]["mathjax"]
 == "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 assert (
 kwargs["kopts"]["plotlyjs"] == "https://cdn.plot.ly/plotly-3.0.0.js"
 )

 else:
 # Check that all the default values have been set in pio._kaleido.scope
 assert pio._kaleido.scope.default_format == "svg"
 assert pio._kaleido.scope.default_width == 701
 assert pio._kaleido.scope.default_height == 501
 assert pio._kaleido.scope.default_scale == 2
 assert (
 pio._kaleido.scope.mathjax
 == "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 assert pio._kaleido.scope.topojson == "path/to/topojson/files/"
 assert pio._kaleido.scope.plotlyjs == "https://cdn.plot.ly/plotly-3.0.0.js"

 # Set topojson default back to None
 # (otherwise image generation will fail)
 pio.defaults.topojson = None
 # Generate image for real and make sure it's an SVG
 result = test_fig.to_image(format="svg", validate=False)
 assert result.startswith(b"<svg")

 finally:
 # Reset defaults to original values and check that they are restored
 pio.defaults.default_format = "png"
 pio.defaults.default_width = 700
 pio.defaults.default_height = 500
 pio.defaults.default_scale = 1
 pio.defaults.mathjax = None
 pio.defaults.topojson = None
 pio.defaults.plotlyjs = None
 assert pio.defaults.default_format == "png"
 assert pio.defaults.default_width == 700
 assert pio.defaults.default_height == 500
 assert pio.defaults.default_scale == 1
 assert pio.defaults.mathjax is None
 assert pio.defaults.topojson is None
 assert pio.defaults.plotlyjs is None


def test_fig_write_image():
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Support setting plotly.js path for Kaleido v1 image export#5207

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.

 Sign up for GitHub

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

emilykl
merged 5 commits into

from

Jun 3, 2025
 Merged


Support setting plotly.js path for Kaleido v1 image export
#5207
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
6837831

support setting plotly.js path


emilykl May 27, 2025
f0aba76

improve pio.defaults test


emilykl Jun 2, 2025
bdf8f05

format


emilykl Jun 2, 2025
2e66fb0

add actual image generation step in test


emilykl Jun 3, 2025
fdab92c

bump kaleido rc version in pyproject.toml and test_requirements


emilykl Jun 3, 2025

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


1 change: 1 addition & 0 deletions
plotly/io/_defaults.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ def __init__(self):
 self.default_scale = 1
 self.mathjax = None
 self.topojson = None
 self.plotlyjs = None


defaults = _Defaults()

27 changes: 13 additions & 14 deletions
plotly/io/_kaleido.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -369,6 +369,12 @@ def to_image(
 from kaleido.errors import ChromeNotFoundError

 try:
 kopts = {}
 if defaults.plotlyjs:
 kopts["plotlyjs"] = defaults.plotlyjs
 if defaults.mathjax:
 kopts["mathjax"] = defaults.mathjax

 # TODO: Refactor to make it possible to use a shared Kaleido instance here
 img_bytes = kaleido.calc_fig_sync(
 fig_dict,
Expand All@@ -379,13 +385,7 @@ def to_image(
 scale=scale or defaults.default_scale,
 ),
 topojson=defaults.topojson,
 kopts=(
 dict(
 mathjax=defaults.mathjax,
 )
 if defaults.mathjax
 else None
 ),
 kopts=kopts,
 )
 except ChromeNotFoundError:
 raise RuntimeError(PLOTLY_GET_CHROME_ERROR_MSG)
Expand DownExpand Up@@ -692,15 +692,14 @@ def write_images(
 from kaleido.errors import ChromeNotFoundError

 try:
 kopts = {}
 if defaults.plotlyjs:
 kopts["plotlyjs"] = defaults.plotlyjs
 if defaults.mathjax:
 kopts["mathjax"] = defaults.mathjax
 kaleido.write_fig_from_object_sync(
 kaleido_specs,
 kopts=(
 dict(
 mathjax=defaults.mathjax,
 )
 if defaults.mathjax
 else None
 ),
 kopts=kopts,
 )
 except ChromeNotFoundError:
 raise RuntimeError(PLOTLY_GET_CHROME_ERROR_MSG)
Expand Down

2 changes: 1 addition & 1 deletion
pyproject.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ dependencies = [

[project.optional-dependencies]
express = ["numpy"]
kaleido = ["kaleido==1.0.0rc13"]
kaleido = ["kaleido==1.0.0rc15"]
dev = ["black==25.1.0"]

[project.scripts]
Expand Down

2 changes: 1 addition & 1 deletion
test_requirements/requirements_optional.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ matplotlib
scikit-image
psutil
# kaleido>=1.0.0 # Uncomment and delete line below once Kaleido v1 is released
kaleido==1.0.0rc13
kaleido==1.0.0rc15
orjson
polars[timezone]
pyarrow
Expand Down

94 changes: 92 additions & 2 deletions
tests/test_optional/test_kaleido/test_kaleido.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,15 +154,105 @@ def test_bytesio():

def test_defaults():
 """Test that image output defaults can be set using pio.defaults.*"""
 test_fig = go.Figure(fig)
 test_image_bytes = b"mock image data"

 # Check initial defaults
 assert pio.defaults.default_format == "png"
 assert pio.defaults.default_width == 700
 assert pio.defaults.default_height == 500
 assert pio.defaults.default_scale == 1
 assert pio.defaults.mathjax is None
 assert pio.defaults.topojson is None
 assert pio.defaults.plotlyjs is None

 try:
assert pio.defaults.default_format == "png"
# Set new defaults
 pio.defaults.default_format = "svg"
 pio.defaults.default_width = 701
 pio.defaults.default_height = 501
 pio.defaults.default_scale = 2
 pio.defaults.mathjax = (
 "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 pio.defaults.topojson = "path/to/topojson/files/"
 pio.defaults.plotlyjs = "https://cdn.plot.ly/plotly-3.0.0.js"

 # Check that new defaults are saved
 assert pio.defaults.default_format == "svg"
 result = pio.to_image(fig, format="svg", validate=False)
 assert pio.defaults.default_width == 701
 assert pio.defaults.default_height == 501
 assert pio.defaults.default_scale == 2
 assert (
 pio.defaults.mathjax
 == "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 assert pio.defaults.topojson == "path/to/topojson/files/"
 assert pio.defaults.plotlyjs == "https://cdn.plot.ly/plotly-3.0.0.js"

 if kaleido_major() > 0:
 # Check that all the defaults values are passed through to the function call to calc_fig_sync
 with patch(
 "plotly.io._kaleido.kaleido.calc_fig_sync",
 return_value=test_image_bytes,
 ) as mock_calc_fig:
 result = pio.to_image(test_fig, validate=False)

 # Verify calc_fig_sync was called with correct args
 # taken from pio.defaults
 mock_calc_fig.assert_called_once()
 args, kwargs = mock_calc_fig.call_args
 assert args[0] == test_fig.to_dict()
 assert kwargs["opts"]["format"] == "svg"
 assert kwargs["opts"]["width"] == 701
 assert kwargs["opts"]["height"] == 501
 assert kwargs["opts"]["scale"] == 2
 assert kwargs["topojson"] == "path/to/topojson/files/"
 # mathjax and plotlyjs are passed through in kopts
 assert (
 kwargs["kopts"]["mathjax"]
 == "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 assert (
 kwargs["kopts"]["plotlyjs"] == "https://cdn.plot.ly/plotly-3.0.0.js"
 )

 else:
 # Check that all the default values have been set in pio._kaleido.scope
 assert pio._kaleido.scope.default_format == "svg"
 assert pio._kaleido.scope.default_width == 701
 assert pio._kaleido.scope.default_height == 501
 assert pio._kaleido.scope.default_scale == 2
 assert (
 pio._kaleido.scope.mathjax
 == "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 assert pio._kaleido.scope.topojson == "path/to/topojson/files/"
 assert pio._kaleido.scope.plotlyjs == "https://cdn.plot.ly/plotly-3.0.0.js"

 # Set topojson default back to None
 # (otherwise image generation will fail)
 pio.defaults.topojson = None
 # Generate image for real and make sure it's an SVG
 result = test_fig.to_image(format="svg", validate=False)
 assert result.startswith(b"<svg")

 finally:
 # Reset defaults to original values and check that they are restored
 pio.defaults.default_format = "png"
 pio.defaults.default_width = 700
 pio.defaults.default_height = 500
 pio.defaults.default_scale = 1
 pio.defaults.mathjax = None
 pio.defaults.topojson = None
 pio.defaults.plotlyjs = None
 assert pio.defaults.default_format == "png"
 assert pio.defaults.default_width == 700
 assert pio.defaults.default_height == 500
 assert pio.defaults.default_scale == 1
 assert pio.defaults.mathjax is None
 assert pio.defaults.topojson is None
 assert pio.defaults.plotlyjs is None


def test_fig_write_image():
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Support setting plotly.js path for Kaleido v1 image export#5207

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.

 Sign up for GitHub

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

emilykl
merged 5 commits into

from

Jun 3, 2025
 Merged


Support setting plotly.js path for Kaleido v1 image export
#5207
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
6837831

support setting plotly.js path


emilykl May 27, 2025
f0aba76

improve pio.defaults test


emilykl Jun 2, 2025
bdf8f05

format


emilykl Jun 2, 2025
2e66fb0

add actual image generation step in test


emilykl Jun 3, 2025
fdab92c

bump kaleido rc version in pyproject.toml and test_requirements


emilykl Jun 3, 2025

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


1 change: 1 addition & 0 deletions
plotly/io/_defaults.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ def __init__(self):
 self.default_scale = 1
 self.mathjax = None
 self.topojson = None
 self.plotlyjs = None


defaults = _Defaults()

27 changes: 13 additions & 14 deletions
plotly/io/_kaleido.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -369,6 +369,12 @@ def to_image(
 from kaleido.errors import ChromeNotFoundError

 try:
 kopts = {}
 if defaults.plotlyjs:
 kopts["plotlyjs"] = defaults.plotlyjs
 if defaults.mathjax:
 kopts["mathjax"] = defaults.mathjax

 # TODO: Refactor to make it possible to use a shared Kaleido instance here
 img_bytes = kaleido.calc_fig_sync(
 fig_dict,
Expand All@@ -379,13 +385,7 @@ def to_image(
 scale=scale or defaults.default_scale,
 ),
 topojson=defaults.topojson,
 kopts=(
 dict(
 mathjax=defaults.mathjax,
 )
 if defaults.mathjax
 else None
 ),
 kopts=kopts,
 )
 except ChromeNotFoundError:
 raise RuntimeError(PLOTLY_GET_CHROME_ERROR_MSG)
Expand DownExpand Up@@ -692,15 +692,14 @@ def write_images(
 from kaleido.errors import ChromeNotFoundError

 try:
 kopts = {}
 if defaults.plotlyjs:
 kopts["plotlyjs"] = defaults.plotlyjs
 if defaults.mathjax:
 kopts["mathjax"] = defaults.mathjax
 kaleido.write_fig_from_object_sync(
 kaleido_specs,
 kopts=(
 dict(
 mathjax=defaults.mathjax,
 )
 if defaults.mathjax
 else None
 ),
 kopts=kopts,
 )
 except ChromeNotFoundError:
 raise RuntimeError(PLOTLY_GET_CHROME_ERROR_MSG)
Expand Down

2 changes: 1 addition & 1 deletion
pyproject.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ dependencies = [

[project.optional-dependencies]
express = ["numpy"]
kaleido = ["kaleido==1.0.0rc13"]
kaleido = ["kaleido==1.0.0rc15"]
dev = ["black==25.1.0"]

[project.scripts]
Expand Down

2 changes: 1 addition & 1 deletion
test_requirements/requirements_optional.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ matplotlib
scikit-image
psutil
# kaleido>=1.0.0 # Uncomment and delete line below once Kaleido v1 is released
kaleido==1.0.0rc13
kaleido==1.0.0rc15
orjson
polars[timezone]
pyarrow
Expand Down

94 changes: 92 additions & 2 deletions
tests/test_optional/test_kaleido/test_kaleido.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,15 +154,105 @@ def test_bytesio():

def test_defaults():
 """Test that image output defaults can be set using pio.defaults.*"""
 test_fig = go.Figure(fig)
 test_image_bytes = b"mock image data"

 # Check initial defaults
 assert pio.defaults.default_format == "png"
 assert pio.defaults.default_width == 700
 assert pio.defaults.default_height == 500
 assert pio.defaults.default_scale == 1
 assert pio.defaults.mathjax is None
 assert pio.defaults.topojson is None
 assert pio.defaults.plotlyjs is None

 try:
assert pio.defaults.default_format == "png"
# Set new defaults
 pio.defaults.default_format = "svg"
 pio.defaults.default_width = 701
 pio.defaults.default_height = 501
 pio.defaults.default_scale = 2
 pio.defaults.mathjax = (
 "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 pio.defaults.topojson = "path/to/topojson/files/"
 pio.defaults.plotlyjs = "https://cdn.plot.ly/plotly-3.0.0.js"

 # Check that new defaults are saved
 assert pio.defaults.default_format == "svg"
 result = pio.to_image(fig, format="svg", validate=False)
 assert pio.defaults.default_width == 701
 assert pio.defaults.default_height == 501
 assert pio.defaults.default_scale == 2
 assert (
 pio.defaults.mathjax
 == "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 assert pio.defaults.topojson == "path/to/topojson/files/"
 assert pio.defaults.plotlyjs == "https://cdn.plot.ly/plotly-3.0.0.js"

 if kaleido_major() > 0:
 # Check that all the defaults values are passed through to the function call to calc_fig_sync
 with patch(
 "plotly.io._kaleido.kaleido.calc_fig_sync",
 return_value=test_image_bytes,
 ) as mock_calc_fig:
 result = pio.to_image(test_fig, validate=False)

 # Verify calc_fig_sync was called with correct args
 # taken from pio.defaults
 mock_calc_fig.assert_called_once()
 args, kwargs = mock_calc_fig.call_args
 assert args[0] == test_fig.to_dict()
 assert kwargs["opts"]["format"] == "svg"
 assert kwargs["opts"]["width"] == 701
 assert kwargs["opts"]["height"] == 501
 assert kwargs["opts"]["scale"] == 2
 assert kwargs["topojson"] == "path/to/topojson/files/"
 # mathjax and plotlyjs are passed through in kopts
 assert (
 kwargs["kopts"]["mathjax"]
 == "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 assert (
 kwargs["kopts"]["plotlyjs"] == "https://cdn.plot.ly/plotly-3.0.0.js"
 )

 else:
 # Check that all the default values have been set in pio._kaleido.scope
 assert pio._kaleido.scope.default_format == "svg"
 assert pio._kaleido.scope.default_width == 701
 assert pio._kaleido.scope.default_height == 501
 assert pio._kaleido.scope.default_scale == 2
 assert (
 pio._kaleido.scope.mathjax
 == "https://cdn.jsdelivr.net/npm/mathjax@3.1.2/es5/tex-svg.js"
 )
 assert pio._kaleido.scope.topojson == "path/to/topojson/files/"
 assert pio._kaleido.scope.plotlyjs == "https://cdn.plot.ly/plotly-3.0.0.js"

 # Set topojson default back to None
 # (otherwise image generation will fail)
 pio.defaults.topojson = None
 # Generate image for real and make sure it's an SVG
 result = test_fig.to_image(format="svg", validate=False)
 assert result.startswith(b"<svg")

 finally:
 # Reset defaults to original values and check that they are restored
 pio.defaults.default_format = "png"
 pio.defaults.default_width = 700
 pio.defaults.default_height = 500
 pio.defaults.default_scale = 1
 pio.defaults.mathjax = None
 pio.defaults.topojson = None
 pio.defaults.plotlyjs = None
 assert pio.defaults.default_format == "png"
 assert pio.defaults.default_width == 700
 assert pio.defaults.default_height == 500
 assert pio.defaults.default_scale == 1
 assert pio.defaults.mathjax is None
 assert pio.defaults.topojson is None
 assert pio.defaults.plotlyjs is None


def test_fig_write_image():
Expand Down