Try using Kaleido v1 for image tests - #7412

Closed
emilykl wants to merge 34 commits into
masterfrom
use-new-kaleido-for-image-tests
Closed

Try using Kaleido v1 for image tests#7412
emilykl wants to merge 34 commits into
masterfrom
use-new-kaleido-for-image-tests

Conversation

@emilykl

@emilyklemilykl commented Apr 30, 2025

Copy link
Copy Markdown
Contributor

No description provided.

@gvwilsongvwilson added P2 considered for next cycle infrastructure build process etc. labels May 8, 2025
@ayjayt

ayjayt commented May 29, 2025

Copy link
Copy Markdown
Contributor

Hi @emilykl, any interest in assigning me as well?

@emilykl

emilykl commented May 29, 2025

Copy link
Copy Markdown
ContributorAuthor

@ayjayt You're welcome to try on your own branch if you like -- I believe this task is blocked by plotly/plotly.py#5207 though which I'm still testing

emilykl added 17 commits May 29, 2025 16:07
@emilykl
add apt-get update step
94335b8
@emilykl
does it work with '-browsers' images?
86f0a3e
@emilykl
use cimg instead of circleci
30c39f4
@emilykl
use python instead of python3
279af99
@emilykl
Revert "use python instead of python3"
ecb2c0c
This reverts commit 279af99.
@emilykl
ensurepip
97b5f29
@emilykl
Revert "ensurepip"
18f0a67
This reverts commit 97b5f29.
@emilykl
'python' rather than 'sudo python3'
3f13771
@emilykl
try python3 without sudo
fae9f08
@emilykl
pip install requests
d0fa346
@emilykl
update kaleido ref
03a53b6
@emilykl
temporarily blacklist 'gl3d_streamtube_reversed_ranges' baseline
99eb4b5
@emilykl
temporarily blacklist 'mathjax' baseline
fcafd40
@emilykl
temporarily blacklist 'map_predefined-styles2' baseline
41172b3
@emilykl
remove eps from make_exports
0ec3ba1
@emilykl
temporarily blacklist 'map_predefined-styles1' and 'grid_subplot_type…
ff45414
…s' baselines
@emilykl
temporarily blacklist 'map_fonts-supported-metropolis' baseline
340fd9e
@emilykl

emilykl commented May 30, 2025

Copy link
Copy Markdown
ContributorAuthor

@ayjayt There are two figures which are failing consistently with an error in Kaleido v1 -- could you investigate?

These are the two figures:

gl3d_streamtube_reversed_ranges
mathjax

(There are a few others which are failing intermittently but I think that's due to instability in the pipeline, not anything to do with Kaleido)

Here is an archive containing:

  1. The JSON figure representations for the failing figures
  2. A script which attempts to generate an image from each, and prints the traceback on failure.

failing_figures_kaleido_v1.zip

You'll need to pip install a few things in your environment to run the script:

python -m pip install "git+https://github.com/plotly/plotly.py.git@6837831"
python -m pip install "git+https://github.com/plotly/Kaleido.git@v1.0.0rc14#subdirectory=src/py"
python -m pip install numpy

Below is the output generated by running python generate_images.py from inside the root directory of the archive:

Error output
(make_baseline) (base) ekl@Emilys-MacBook-Air-2 failing_figures_kaleido_v1 % python generate_images.py
=============
=== Failed to generate image for gl3d_streamtube_reversed_ranges ===
=============
Traceback (most recent call last):
File "generate_images.py", line 32, in <module>
pio.write_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 509, in write_image
img_data = to_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 379, in to_image
img_bytes = kaleido.calc_fig_sync(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 145, in calc_fig_sync
return _async_thread_run(calc_fig, args=args, kwargs=kwargs)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 138, in _async_thread_run
raise res
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 129, in run
q.put(asyncio.run(func(*args, **kwargs)))
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/runners.py", line 44, in run
return loop.run_until_complete(main)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/base_events.py", line 616, in run_until_complete
return future.result()
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 55, in calc_fig
return await k.calc_fig(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/kaleido.py", line 319, in calc_fig
spec, full_path = build_fig_spec(fig, path, opts)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 144, in build_fig_spec
name = _next_filename(directory, prefix, ext)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 94, in _next_filename
re_number = re.compile(r"^" + prefix + r"-(\d+)\." + ext + r"$")
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 252, in compile
return _compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 304, in _compile
p = sre_compile.compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_compile.py", line 764, in compile
p = sre_parse.parse(p, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 948, in parse
p = _parse_sub(source, state, flags & SRE_FLAG_VERBOSE, 0)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 443, in _parse_sub
itemsappend(_parse(source, state, verbose, nested + 1,
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 598, in _parse
raise source.error(msg, len(this) + 1 + len(that))
re.error: bad character range _-2 at position 94
=============
=============
=== Failed to generate image for mathjax ===
=============
Traceback (most recent call last):
File "generate_images.py", line 32, in <module>
pio.write_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 509, in write_image
img_data = to_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 379, in to_image
img_bytes = kaleido.calc_fig_sync(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 145, in calc_fig_sync
return _async_thread_run(calc_fig, args=args, kwargs=kwargs)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 138, in _async_thread_run
raise res
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 129, in run
q.put(asyncio.run(func(*args, **kwargs)))
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/runners.py", line 44, in run
return loop.run_until_complete(main)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/base_events.py", line 616, in run_until_complete
return future.result()
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 55, in calc_fig
return await k.calc_fig(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/kaleido.py", line 319, in calc_fig
spec, full_path = build_fig_spec(fig, path, opts)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 144, in build_fig_spec
name = _next_filename(directory, prefix, ext)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 94, in _next_filename
re_number = re.compile(r"^" + prefix + r"-(\d+)\." + ext + r"$")
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 252, in compile
return _compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 304, in _compile
p = sre_compile.compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_compile.py", line 764, in compile
p = sre_parse.parse(p, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 948, in parse
p = _parse_sub(source, state, flags & SRE_FLAG_VERBOSE, 0)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 443, in _parse_sub
itemsappend(_parse(source, state, verbose, nested + 1,
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 525, in _parse
code = _escape(source, this, state)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 426, in _escape
raise source.error("bad escape %s" % escape, len(escape))
re.error: bad escape \h at position 3
=============

@ayjaytayjayt mentioned this pull request Jun 2, 2025
Merged
@ayjayt

ayjayt commented Jun 2, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

@emilykl

plotly/Kaleido#339 makes it work for me

here's a uv script preamble to build in the build steps (will redownload stuff) right in generate_images

# /// script# requires-python = ">=3.13"# dependencies = [# "kaleido",# "numpy",# "plotly",# ]## [tool.uv.sources]# plotly = { git = "https://github.com/plotly/plotly.py.git", rev = "6837831" }# ///

@archmoj

archmoj commented Jun 4, 2025

Copy link
Copy Markdown
Contributor

@emilykl After I viewed most significant changes on my dev branch I suggest you drop the a426afa commit (possibly by force pushing i.e. to reduce the size of changes) and instead commit the changes of the following baselines:

test/image/baselines/mathjax.png
test/image/baselines/ternary-mathjax-title-place-subtitle.png
test/image/baselines/legend_mathjax_title_and_items.png
test/image/baselines/world-cals.png
test/image/baselines/worldcup.png
test/image/baselines/funnel_horizontal_group_basic.png
test/image/baselines/font-decorline-scatter.png
test/image/baselines/text_on_shapes_basic.png
test/image/baselines/indicator_scatter.png

Thank you 🙏

@emilykl
emilyklforce-pushed the use-new-kaleido-for-image-tests branch from b1f16e0 to 6bab84dCompareJune 4, 2025 14:58
@archmojarchmoj mentioned this pull request Jul 7, 2025
Closed
@archmojarchmoj mentioned this pull request Jul 17, 2025
Merged
@emilykl

emilykl commented Jul 28, 2025

Copy link
Copy Markdown
ContributorAuthor

Closing in favor of #7498.

@emilyklemilykl closed this Jul 28, 2025
@archmoj
archmoj deleted the use-new-kaleido-for-image-tests branch July 28, 2025 21:38
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@emilyklemilykl

@ayjaytayjayt

Labels

infrastructurebuild process etc.P2considered for next cycle

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@emilykl@ayjayt@archmoj@gvwilson
, '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
Try using Kaleido v1 for image tests - #7412
Closed
emilykl wants to merge 34 commits into
masterfrom 
use-new-kaleido-for-image-tests
Closed
Try using Kaleido v1 for image tests#7412
emilykl wants to merge 34 commits into
masterfrom 
use-new-kaleido-for-image-tests
Conversation
@emilykl
@emilyklemilykl
commented
Apr 30, 2025

Copy link


Copy Markdown

Contributor
 No description provided. 
@gvwilsongvwilson
added

P2
considered for next cycle
infrastructure
build process etc.
labels
May 8, 2025
@ayjayt
ayjayt
commented
May 29, 2025

Copy link


Copy Markdown

Contributor
Hi @emilykl, any interest in assigning me as well?
@emilykl
emilykl
commented
May 29, 2025

Copy link


Copy Markdown

ContributorAuthor
@ayjayt You're welcome to try on your own branch if you like -- I believe this task is blocked by plotly/plotly.py#5207 though which I'm still testing
emilykl
added 17 commits
May 29, 2025 16:07
@emilykl
add apt-get update step
94335b8
@emilykl
does it work with '-browsers' images?
86f0a3e
@emilykl
use cimg instead of circleci
30c39f4
@emilykl
use python instead of python3
279af99
@emilykl
Revert "use python instead of python3"
ecb2c0c
This reverts commit 279af99.
@emilykl
ensurepip
97b5f29
@emilykl
Revert "ensurepip"
18f0a67
This reverts commit 97b5f29.
@emilykl
'python' rather than 'sudo python3'
3f13771
@emilykl
try python3 without sudo
fae9f08
@emilykl
pip install requests
d0fa346
@emilykl
update kaleido ref
03a53b6
@emilykl
temporarily blacklist 'gl3d_streamtube_reversed_ranges' baseline
99eb4b5
@emilykl
temporarily blacklist 'mathjax' baseline
fcafd40
@emilykl
temporarily blacklist 'map_predefined-styles2' baseline
41172b3
@emilykl
remove eps from make_exports
0ec3ba1
@emilykl
temporarily blacklist 'map_predefined-styles1' and 'grid_subplot_type…
ff45414
…s' baselines
@emilykl
temporarily blacklist 'map_fonts-supported-metropolis' baseline
340fd9e
@emilykl
emilykl
commented
May 30, 2025

Copy link


Copy Markdown

ContributorAuthor
@ayjayt There are two figures which are failing consistently with an error in Kaleido v1 -- could you investigate?
These are the two figures:
gl3d_streamtube_reversed_ranges
mathjax

(There are a few others which are failing intermittently but I think that's due to instability in the pipeline, not anything to do with Kaleido)
Here is an archive containing:
  1. The JSON figure representations for the failing figures
  2. A script which attempts to generate an image from each, and prints the traceback on failure.
failing_figures_kaleido_v1.zip
You'll need to pip install a few things in your environment to run the script:
python -m pip install "git+https://github.com/plotly/plotly.py.git@6837831"
python -m pip install "git+https://github.com/plotly/Kaleido.git@v1.0.0rc14#subdirectory=src/py"
python -m pip install numpy

Below is the output generated by running python generate_images.py from inside the root directory of the archive:
Error output
(make_baseline) (base) ekl@Emilys-MacBook-Air-2 failing_figures_kaleido_v1 % python generate_images.py
=============
=== Failed to generate image for gl3d_streamtube_reversed_ranges ===
=============
Traceback (most recent call last):
File "generate_images.py", line 32, in <module>
pio.write_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 509, in write_image
img_data = to_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 379, in to_image
img_bytes = kaleido.calc_fig_sync(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 145, in calc_fig_sync
return _async_thread_run(calc_fig, args=args, kwargs=kwargs)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 138, in _async_thread_run
raise res
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 129, in run
q.put(asyncio.run(func(*args, **kwargs)))
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/runners.py", line 44, in run
return loop.run_until_complete(main)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/base_events.py", line 616, in run_until_complete
return future.result()
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 55, in calc_fig
return await k.calc_fig(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/kaleido.py", line 319, in calc_fig
spec, full_path = build_fig_spec(fig, path, opts)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 144, in build_fig_spec
name = _next_filename(directory, prefix, ext)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 94, in _next_filename
re_number = re.compile(r"^" + prefix + r"-(\d+)\." + ext + r"$")
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 252, in compile
return _compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 304, in _compile
p = sre_compile.compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_compile.py", line 764, in compile
p = sre_parse.parse(p, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 948, in parse
p = _parse_sub(source, state, flags & SRE_FLAG_VERBOSE, 0)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 443, in _parse_sub
itemsappend(_parse(source, state, verbose, nested + 1,
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 598, in _parse
raise source.error(msg, len(this) + 1 + len(that))
re.error: bad character range _-2 at position 94
=============
=============
=== Failed to generate image for mathjax ===
=============
Traceback (most recent call last):
File "generate_images.py", line 32, in <module>
pio.write_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 509, in write_image
img_data = to_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 379, in to_image
img_bytes = kaleido.calc_fig_sync(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 145, in calc_fig_sync
return _async_thread_run(calc_fig, args=args, kwargs=kwargs)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 138, in _async_thread_run
raise res
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 129, in run
q.put(asyncio.run(func(*args, **kwargs)))
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/runners.py", line 44, in run
return loop.run_until_complete(main)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/base_events.py", line 616, in run_until_complete
return future.result()
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 55, in calc_fig
return await k.calc_fig(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/kaleido.py", line 319, in calc_fig
spec, full_path = build_fig_spec(fig, path, opts)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 144, in build_fig_spec
name = _next_filename(directory, prefix, ext)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 94, in _next_filename
re_number = re.compile(r"^" + prefix + r"-(\d+)\." + ext + r"$")
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 252, in compile
return _compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 304, in _compile
p = sre_compile.compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_compile.py", line 764, in compile
p = sre_parse.parse(p, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 948, in parse
p = _parse_sub(source, state, flags & SRE_FLAG_VERBOSE, 0)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 443, in _parse_sub
itemsappend(_parse(source, state, verbose, nested + 1,
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 525, in _parse
code = _escape(source, this, state)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 426, in _escape
raise source.error("bad escape %s" % escape, len(escape))
re.error: bad escape \h at position 3
=============

@ayjaytayjayt
mentioned this pull request
Jun 2, 2025
 Merged

@ayjayt
ayjayt
commented
Jun 2, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
@emilykl
plotly/Kaleido#339 makes it work for me
here's a uv script preamble to build in the build steps (will redownload stuff) right in generate_images
# /// script# requires-python = ">=3.13"# dependencies = [# "kaleido",# "numpy",# "plotly",# ]## [tool.uv.sources]# plotly = { git = "https://github.com/plotly/plotly.py.git", rev = "6837831" }# ///
@archmoj
archmoj
commented
Jun 4, 2025

Copy link


Copy Markdown

Contributor
@emilykl After I viewed most significant changes on my dev branch I suggest you drop the a426afa commit (possibly by force pushing i.e. to reduce the size of changes) and instead commit the changes of the following baselines:
test/image/baselines/mathjax.png
test/image/baselines/ternary-mathjax-title-place-subtitle.png
test/image/baselines/legend_mathjax_title_and_items.png
test/image/baselines/world-cals.png
test/image/baselines/worldcup.png
test/image/baselines/funnel_horizontal_group_basic.png
test/image/baselines/font-decorline-scatter.png
test/image/baselines/text_on_shapes_basic.png
test/image/baselines/indicator_scatter.png

Thank you 🙏
@emilykl
emilyklforce-pushed
the
use-new-kaleido-for-image-tests
branch
from
b1f16e0 to
6bab84dCompareJune 4, 2025 14:58
@archmojarchmoj
mentioned this pull request
Jul 7, 2025
 Closed

@archmojarchmoj
mentioned this pull request
Jul 17, 2025
 Merged

@emilykl
emilykl
commented
Jul 28, 2025

Copy link


Copy Markdown

ContributorAuthor
Closing in favor of #7498.
@emilyklemilykl
closed this
Jul 28, 2025
@archmoj
archmoj
deleted the

use-new-kaleido-for-image-tests

branch
July 28, 2025 21:38
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees

@emilyklemilykl
@ayjaytayjayt

Labels

infrastructurebuild process etc.P2considered for next cycle

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

4 participants

@emilykl@ayjayt@archmoj@gvwilson

, '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
Try using Kaleido v1 for image tests - #7412
Closed
emilykl wants to merge 34 commits into
masterfrom 
use-new-kaleido-for-image-tests
Closed
Try using Kaleido v1 for image tests#7412
emilykl wants to merge 34 commits into
masterfrom 
use-new-kaleido-for-image-tests
Conversation
@emilykl
@emilyklemilykl
commented
Apr 30, 2025

Copy link


Copy Markdown

Contributor
 No description provided. 
@gvwilsongvwilson
added

P2
considered for next cycle
infrastructure
build process etc.
labels
May 8, 2025
@ayjayt
ayjayt
commented
May 29, 2025

Copy link


Copy Markdown

Contributor
Hi @emilykl, any interest in assigning me as well?
@emilykl
emilykl
commented
May 29, 2025

Copy link


Copy Markdown

ContributorAuthor
@ayjayt You're welcome to try on your own branch if you like -- I believe this task is blocked by plotly/plotly.py#5207 though which I'm still testing
emilykl
added 17 commits
May 29, 2025 16:07
@emilykl
add apt-get update step
94335b8
@emilykl
does it work with '-browsers' images?
86f0a3e
@emilykl
use cimg instead of circleci
30c39f4
@emilykl
use python instead of python3
279af99
@emilykl
Revert "use python instead of python3"
ecb2c0c
This reverts commit 279af99.
@emilykl
ensurepip
97b5f29
@emilykl
Revert "ensurepip"
18f0a67
This reverts commit 97b5f29.
@emilykl
'python' rather than 'sudo python3'
3f13771
@emilykl
try python3 without sudo
fae9f08
@emilykl
pip install requests
d0fa346
@emilykl
update kaleido ref
03a53b6
@emilykl
temporarily blacklist 'gl3d_streamtube_reversed_ranges' baseline
99eb4b5
@emilykl
temporarily blacklist 'mathjax' baseline
fcafd40
@emilykl
temporarily blacklist 'map_predefined-styles2' baseline
41172b3
@emilykl
remove eps from make_exports
0ec3ba1
@emilykl
temporarily blacklist 'map_predefined-styles1' and 'grid_subplot_type…
ff45414
…s' baselines
@emilykl
temporarily blacklist 'map_fonts-supported-metropolis' baseline
340fd9e
@emilykl
emilykl
commented
May 30, 2025

Copy link


Copy Markdown

ContributorAuthor
@ayjayt There are two figures which are failing consistently with an error in Kaleido v1 -- could you investigate?
These are the two figures:
gl3d_streamtube_reversed_ranges
mathjax

(There are a few others which are failing intermittently but I think that's due to instability in the pipeline, not anything to do with Kaleido)
Here is an archive containing:
  1. The JSON figure representations for the failing figures
  2. A script which attempts to generate an image from each, and prints the traceback on failure.
failing_figures_kaleido_v1.zip
You'll need to pip install a few things in your environment to run the script:
python -m pip install "git+https://github.com/plotly/plotly.py.git@6837831"
python -m pip install "git+https://github.com/plotly/Kaleido.git@v1.0.0rc14#subdirectory=src/py"
python -m pip install numpy

Below is the output generated by running python generate_images.py from inside the root directory of the archive:
Error output
(make_baseline) (base) ekl@Emilys-MacBook-Air-2 failing_figures_kaleido_v1 % python generate_images.py
=============
=== Failed to generate image for gl3d_streamtube_reversed_ranges ===
=============
Traceback (most recent call last):
File "generate_images.py", line 32, in <module>
pio.write_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 509, in write_image
img_data = to_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 379, in to_image
img_bytes = kaleido.calc_fig_sync(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 145, in calc_fig_sync
return _async_thread_run(calc_fig, args=args, kwargs=kwargs)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 138, in _async_thread_run
raise res
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 129, in run
q.put(asyncio.run(func(*args, **kwargs)))
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/runners.py", line 44, in run
return loop.run_until_complete(main)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/base_events.py", line 616, in run_until_complete
return future.result()
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 55, in calc_fig
return await k.calc_fig(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/kaleido.py", line 319, in calc_fig
spec, full_path = build_fig_spec(fig, path, opts)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 144, in build_fig_spec
name = _next_filename(directory, prefix, ext)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 94, in _next_filename
re_number = re.compile(r"^" + prefix + r"-(\d+)\." + ext + r"$")
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 252, in compile
return _compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 304, in _compile
p = sre_compile.compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_compile.py", line 764, in compile
p = sre_parse.parse(p, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 948, in parse
p = _parse_sub(source, state, flags & SRE_FLAG_VERBOSE, 0)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 443, in _parse_sub
itemsappend(_parse(source, state, verbose, nested + 1,
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 598, in _parse
raise source.error(msg, len(this) + 1 + len(that))
re.error: bad character range _-2 at position 94
=============
=============
=== Failed to generate image for mathjax ===
=============
Traceback (most recent call last):
File "generate_images.py", line 32, in <module>
pio.write_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 509, in write_image
img_data = to_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 379, in to_image
img_bytes = kaleido.calc_fig_sync(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 145, in calc_fig_sync
return _async_thread_run(calc_fig, args=args, kwargs=kwargs)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 138, in _async_thread_run
raise res
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 129, in run
q.put(asyncio.run(func(*args, **kwargs)))
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/runners.py", line 44, in run
return loop.run_until_complete(main)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/base_events.py", line 616, in run_until_complete
return future.result()
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 55, in calc_fig
return await k.calc_fig(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/kaleido.py", line 319, in calc_fig
spec, full_path = build_fig_spec(fig, path, opts)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 144, in build_fig_spec
name = _next_filename(directory, prefix, ext)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 94, in _next_filename
re_number = re.compile(r"^" + prefix + r"-(\d+)\." + ext + r"$")
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 252, in compile
return _compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 304, in _compile
p = sre_compile.compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_compile.py", line 764, in compile
p = sre_parse.parse(p, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 948, in parse
p = _parse_sub(source, state, flags & SRE_FLAG_VERBOSE, 0)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 443, in _parse_sub
itemsappend(_parse(source, state, verbose, nested + 1,
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 525, in _parse
code = _escape(source, this, state)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 426, in _escape
raise source.error("bad escape %s" % escape, len(escape))
re.error: bad escape \h at position 3
=============

@ayjaytayjayt
mentioned this pull request
Jun 2, 2025
 Merged

@ayjayt
ayjayt
commented
Jun 2, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
@emilykl
plotly/Kaleido#339 makes it work for me
here's a uv script preamble to build in the build steps (will redownload stuff) right in generate_images
# /// script# requires-python = ">=3.13"# dependencies = [# "kaleido",# "numpy",# "plotly",# ]## [tool.uv.sources]# plotly = { git = "https://github.com/plotly/plotly.py.git", rev = "6837831" }# ///
@archmoj
archmoj
commented
Jun 4, 2025

Copy link


Copy Markdown

Contributor
@emilykl After I viewed most significant changes on my dev branch I suggest you drop the a426afa commit (possibly by force pushing i.e. to reduce the size of changes) and instead commit the changes of the following baselines:
test/image/baselines/mathjax.png
test/image/baselines/ternary-mathjax-title-place-subtitle.png
test/image/baselines/legend_mathjax_title_and_items.png
test/image/baselines/world-cals.png
test/image/baselines/worldcup.png
test/image/baselines/funnel_horizontal_group_basic.png
test/image/baselines/font-decorline-scatter.png
test/image/baselines/text_on_shapes_basic.png
test/image/baselines/indicator_scatter.png

Thank you 🙏
@emilykl
emilyklforce-pushed
the
use-new-kaleido-for-image-tests
branch
from
b1f16e0 to
6bab84dCompareJune 4, 2025 14:58
@archmojarchmoj
mentioned this pull request
Jul 7, 2025
 Closed

@archmojarchmoj
mentioned this pull request
Jul 17, 2025
 Merged

@emilykl
emilykl
commented
Jul 28, 2025

Copy link


Copy Markdown

ContributorAuthor
Closing in favor of #7498.
@emilyklemilykl
closed this
Jul 28, 2025
@archmoj
archmoj
deleted the

use-new-kaleido-for-image-tests

branch
July 28, 2025 21:38
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees

@emilyklemilykl
@ayjaytayjayt

Labels

infrastructurebuild process etc.P2considered for next cycle

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

4 participants

@emilykl@ayjayt@archmoj@gvwilson

, '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
Try using Kaleido v1 for image tests - #7412
Closed
emilykl wants to merge 34 commits into
masterfrom 
use-new-kaleido-for-image-tests
Closed
Try using Kaleido v1 for image tests#7412
emilykl wants to merge 34 commits into
masterfrom 
use-new-kaleido-for-image-tests
Conversation
@emilykl
@emilyklemilykl
commented
Apr 30, 2025

Copy link


Copy Markdown

Contributor
 No description provided. 
@gvwilsongvwilson
added

P2
considered for next cycle
infrastructure
build process etc.
labels
May 8, 2025
@ayjayt
ayjayt
commented
May 29, 2025

Copy link


Copy Markdown

Contributor
Hi @emilykl, any interest in assigning me as well?
@emilykl
emilykl
commented
May 29, 2025

Copy link


Copy Markdown

ContributorAuthor
@ayjayt You're welcome to try on your own branch if you like -- I believe this task is blocked by plotly/plotly.py#5207 though which I'm still testing
emilykl
added 17 commits
May 29, 2025 16:07
@emilykl
add apt-get update step
94335b8
@emilykl
does it work with '-browsers' images?
86f0a3e
@emilykl
use cimg instead of circleci
30c39f4
@emilykl
use python instead of python3
279af99
@emilykl
Revert "use python instead of python3"
ecb2c0c
This reverts commit 279af99.
@emilykl
ensurepip
97b5f29
@emilykl
Revert "ensurepip"
18f0a67
This reverts commit 97b5f29.
@emilykl
'python' rather than 'sudo python3'
3f13771
@emilykl
try python3 without sudo
fae9f08
@emilykl
pip install requests
d0fa346
@emilykl
update kaleido ref
03a53b6
@emilykl
temporarily blacklist 'gl3d_streamtube_reversed_ranges' baseline
99eb4b5
@emilykl
temporarily blacklist 'mathjax' baseline
fcafd40
@emilykl
temporarily blacklist 'map_predefined-styles2' baseline
41172b3
@emilykl
remove eps from make_exports
0ec3ba1
@emilykl
temporarily blacklist 'map_predefined-styles1' and 'grid_subplot_type…
ff45414
…s' baselines
@emilykl
temporarily blacklist 'map_fonts-supported-metropolis' baseline
340fd9e
@emilykl
emilykl
commented
May 30, 2025

Copy link


Copy Markdown

ContributorAuthor
@ayjayt There are two figures which are failing consistently with an error in Kaleido v1 -- could you investigate?
These are the two figures:
gl3d_streamtube_reversed_ranges
mathjax

(There are a few others which are failing intermittently but I think that's due to instability in the pipeline, not anything to do with Kaleido)
Here is an archive containing:
  1. The JSON figure representations for the failing figures
  2. A script which attempts to generate an image from each, and prints the traceback on failure.
failing_figures_kaleido_v1.zip
You'll need to pip install a few things in your environment to run the script:
python -m pip install "git+https://github.com/plotly/plotly.py.git@6837831"
python -m pip install "git+https://github.com/plotly/Kaleido.git@v1.0.0rc14#subdirectory=src/py"
python -m pip install numpy

Below is the output generated by running python generate_images.py from inside the root directory of the archive:
Error output
(make_baseline) (base) ekl@Emilys-MacBook-Air-2 failing_figures_kaleido_v1 % python generate_images.py
=============
=== Failed to generate image for gl3d_streamtube_reversed_ranges ===
=============
Traceback (most recent call last):
File "generate_images.py", line 32, in <module>
pio.write_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 509, in write_image
img_data = to_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 379, in to_image
img_bytes = kaleido.calc_fig_sync(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 145, in calc_fig_sync
return _async_thread_run(calc_fig, args=args, kwargs=kwargs)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 138, in _async_thread_run
raise res
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 129, in run
q.put(asyncio.run(func(*args, **kwargs)))
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/runners.py", line 44, in run
return loop.run_until_complete(main)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/base_events.py", line 616, in run_until_complete
return future.result()
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 55, in calc_fig
return await k.calc_fig(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/kaleido.py", line 319, in calc_fig
spec, full_path = build_fig_spec(fig, path, opts)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 144, in build_fig_spec
name = _next_filename(directory, prefix, ext)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 94, in _next_filename
re_number = re.compile(r"^" + prefix + r"-(\d+)\." + ext + r"$")
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 252, in compile
return _compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 304, in _compile
p = sre_compile.compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_compile.py", line 764, in compile
p = sre_parse.parse(p, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 948, in parse
p = _parse_sub(source, state, flags & SRE_FLAG_VERBOSE, 0)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 443, in _parse_sub
itemsappend(_parse(source, state, verbose, nested + 1,
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 598, in _parse
raise source.error(msg, len(this) + 1 + len(that))
re.error: bad character range _-2 at position 94
=============
=============
=== Failed to generate image for mathjax ===
=============
Traceback (most recent call last):
File "generate_images.py", line 32, in <module>
pio.write_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 509, in write_image
img_data = to_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 379, in to_image
img_bytes = kaleido.calc_fig_sync(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 145, in calc_fig_sync
return _async_thread_run(calc_fig, args=args, kwargs=kwargs)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 138, in _async_thread_run
raise res
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 129, in run
q.put(asyncio.run(func(*args, **kwargs)))
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/runners.py", line 44, in run
return loop.run_until_complete(main)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/base_events.py", line 616, in run_until_complete
return future.result()
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 55, in calc_fig
return await k.calc_fig(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/kaleido.py", line 319, in calc_fig
spec, full_path = build_fig_spec(fig, path, opts)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 144, in build_fig_spec
name = _next_filename(directory, prefix, ext)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 94, in _next_filename
re_number = re.compile(r"^" + prefix + r"-(\d+)\." + ext + r"$")
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 252, in compile
return _compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 304, in _compile
p = sre_compile.compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_compile.py", line 764, in compile
p = sre_parse.parse(p, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 948, in parse
p = _parse_sub(source, state, flags & SRE_FLAG_VERBOSE, 0)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 443, in _parse_sub
itemsappend(_parse(source, state, verbose, nested + 1,
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 525, in _parse
code = _escape(source, this, state)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 426, in _escape
raise source.error("bad escape %s" % escape, len(escape))
re.error: bad escape \h at position 3
=============

@ayjaytayjayt
mentioned this pull request
Jun 2, 2025
 Merged

@ayjayt
ayjayt
commented
Jun 2, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
@emilykl
plotly/Kaleido#339 makes it work for me
here's a uv script preamble to build in the build steps (will redownload stuff) right in generate_images
# /// script# requires-python = ">=3.13"# dependencies = [# "kaleido",# "numpy",# "plotly",# ]## [tool.uv.sources]# plotly = { git = "https://github.com/plotly/plotly.py.git", rev = "6837831" }# ///
@archmoj
archmoj
commented
Jun 4, 2025

Copy link


Copy Markdown

Contributor
@emilykl After I viewed most significant changes on my dev branch I suggest you drop the a426afa commit (possibly by force pushing i.e. to reduce the size of changes) and instead commit the changes of the following baselines:
test/image/baselines/mathjax.png
test/image/baselines/ternary-mathjax-title-place-subtitle.png
test/image/baselines/legend_mathjax_title_and_items.png
test/image/baselines/world-cals.png
test/image/baselines/worldcup.png
test/image/baselines/funnel_horizontal_group_basic.png
test/image/baselines/font-decorline-scatter.png
test/image/baselines/text_on_shapes_basic.png
test/image/baselines/indicator_scatter.png

Thank you 🙏
@emilykl
emilyklforce-pushed
the
use-new-kaleido-for-image-tests
branch
from
b1f16e0 to
6bab84dCompareJune 4, 2025 14:58
@archmojarchmoj
mentioned this pull request
Jul 7, 2025
 Closed

@archmojarchmoj
mentioned this pull request
Jul 17, 2025
 Merged

@emilykl
emilykl
commented
Jul 28, 2025

Copy link


Copy Markdown

ContributorAuthor
Closing in favor of #7498.
@emilyklemilykl
closed this
Jul 28, 2025
@archmoj
archmoj
deleted the

use-new-kaleido-for-image-tests

branch
July 28, 2025 21:38
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees

@emilyklemilykl
@ayjaytayjayt

Labels

infrastructurebuild process etc.P2considered for next cycle

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

4 participants

@emilykl@ayjayt@archmoj@gvwilson

, '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
Try using Kaleido v1 for image tests - #7412
Closed
emilykl wants to merge 34 commits into
masterfrom 
use-new-kaleido-for-image-tests
Closed
Try using Kaleido v1 for image tests#7412
emilykl wants to merge 34 commits into
masterfrom 
use-new-kaleido-for-image-tests
Conversation
@emilykl
@emilyklemilykl
commented
Apr 30, 2025

Copy link


Copy Markdown

Contributor
 No description provided. 
@gvwilsongvwilson
added

P2
considered for next cycle
infrastructure
build process etc.
labels
May 8, 2025
@ayjayt
ayjayt
commented
May 29, 2025

Copy link


Copy Markdown

Contributor
Hi @emilykl, any interest in assigning me as well?
@emilykl
emilykl
commented
May 29, 2025

Copy link


Copy Markdown

ContributorAuthor
@ayjayt You're welcome to try on your own branch if you like -- I believe this task is blocked by plotly/plotly.py#5207 though which I'm still testing
emilykl
added 17 commits
May 29, 2025 16:07
@emilykl
add apt-get update step
94335b8
@emilykl
does it work with '-browsers' images?
86f0a3e
@emilykl
use cimg instead of circleci
30c39f4
@emilykl
use python instead of python3
279af99
@emilykl
Revert "use python instead of python3"
ecb2c0c
This reverts commit 279af99.
@emilykl
ensurepip
97b5f29
@emilykl
Revert "ensurepip"
18f0a67
This reverts commit 97b5f29.
@emilykl
'python' rather than 'sudo python3'
3f13771
@emilykl
try python3 without sudo
fae9f08
@emilykl
pip install requests
d0fa346
@emilykl
update kaleido ref
03a53b6
@emilykl
temporarily blacklist 'gl3d_streamtube_reversed_ranges' baseline
99eb4b5
@emilykl
temporarily blacklist 'mathjax' baseline
fcafd40
@emilykl
temporarily blacklist 'map_predefined-styles2' baseline
41172b3
@emilykl
remove eps from make_exports
0ec3ba1
@emilykl
temporarily blacklist 'map_predefined-styles1' and 'grid_subplot_type…
ff45414
…s' baselines
@emilykl
temporarily blacklist 'map_fonts-supported-metropolis' baseline
340fd9e
@emilykl
emilykl
commented
May 30, 2025

Copy link


Copy Markdown

ContributorAuthor
@ayjayt There are two figures which are failing consistently with an error in Kaleido v1 -- could you investigate?
These are the two figures:
gl3d_streamtube_reversed_ranges
mathjax

(There are a few others which are failing intermittently but I think that's due to instability in the pipeline, not anything to do with Kaleido)
Here is an archive containing:
  1. The JSON figure representations for the failing figures
  2. A script which attempts to generate an image from each, and prints the traceback on failure.
failing_figures_kaleido_v1.zip
You'll need to pip install a few things in your environment to run the script:
python -m pip install "git+https://github.com/plotly/plotly.py.git@6837831"
python -m pip install "git+https://github.com/plotly/Kaleido.git@v1.0.0rc14#subdirectory=src/py"
python -m pip install numpy

Below is the output generated by running python generate_images.py from inside the root directory of the archive:
Error output
(make_baseline) (base) ekl@Emilys-MacBook-Air-2 failing_figures_kaleido_v1 % python generate_images.py
=============
=== Failed to generate image for gl3d_streamtube_reversed_ranges ===
=============
Traceback (most recent call last):
File "generate_images.py", line 32, in <module>
pio.write_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 509, in write_image
img_data = to_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 379, in to_image
img_bytes = kaleido.calc_fig_sync(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 145, in calc_fig_sync
return _async_thread_run(calc_fig, args=args, kwargs=kwargs)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 138, in _async_thread_run
raise res
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 129, in run
q.put(asyncio.run(func(*args, **kwargs)))
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/runners.py", line 44, in run
return loop.run_until_complete(main)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/base_events.py", line 616, in run_until_complete
return future.result()
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 55, in calc_fig
return await k.calc_fig(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/kaleido.py", line 319, in calc_fig
spec, full_path = build_fig_spec(fig, path, opts)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 144, in build_fig_spec
name = _next_filename(directory, prefix, ext)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 94, in _next_filename
re_number = re.compile(r"^" + prefix + r"-(\d+)\." + ext + r"$")
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 252, in compile
return _compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 304, in _compile
p = sre_compile.compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_compile.py", line 764, in compile
p = sre_parse.parse(p, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 948, in parse
p = _parse_sub(source, state, flags & SRE_FLAG_VERBOSE, 0)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 443, in _parse_sub
itemsappend(_parse(source, state, verbose, nested + 1,
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 598, in _parse
raise source.error(msg, len(this) + 1 + len(that))
re.error: bad character range _-2 at position 94
=============
=============
=== Failed to generate image for mathjax ===
=============
Traceback (most recent call last):
File "generate_images.py", line 32, in <module>
pio.write_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 509, in write_image
img_data = to_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 379, in to_image
img_bytes = kaleido.calc_fig_sync(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 145, in calc_fig_sync
return _async_thread_run(calc_fig, args=args, kwargs=kwargs)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 138, in _async_thread_run
raise res
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 129, in run
q.put(asyncio.run(func(*args, **kwargs)))
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/runners.py", line 44, in run
return loop.run_until_complete(main)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/base_events.py", line 616, in run_until_complete
return future.result()
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 55, in calc_fig
return await k.calc_fig(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/kaleido.py", line 319, in calc_fig
spec, full_path = build_fig_spec(fig, path, opts)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 144, in build_fig_spec
name = _next_filename(directory, prefix, ext)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 94, in _next_filename
re_number = re.compile(r"^" + prefix + r"-(\d+)\." + ext + r"$")
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 252, in compile
return _compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 304, in _compile
p = sre_compile.compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_compile.py", line 764, in compile
p = sre_parse.parse(p, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 948, in parse
p = _parse_sub(source, state, flags & SRE_FLAG_VERBOSE, 0)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 443, in _parse_sub
itemsappend(_parse(source, state, verbose, nested + 1,
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 525, in _parse
code = _escape(source, this, state)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 426, in _escape
raise source.error("bad escape %s" % escape, len(escape))
re.error: bad escape \h at position 3
=============

@ayjaytayjayt
mentioned this pull request
Jun 2, 2025
 Merged

@ayjayt
ayjayt
commented
Jun 2, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
@emilykl
plotly/Kaleido#339 makes it work for me
here's a uv script preamble to build in the build steps (will redownload stuff) right in generate_images
# /// script# requires-python = ">=3.13"# dependencies = [# "kaleido",# "numpy",# "plotly",# ]## [tool.uv.sources]# plotly = { git = "https://github.com/plotly/plotly.py.git", rev = "6837831" }# ///
@archmoj
archmoj
commented
Jun 4, 2025

Copy link


Copy Markdown

Contributor
@emilykl After I viewed most significant changes on my dev branch I suggest you drop the a426afa commit (possibly by force pushing i.e. to reduce the size of changes) and instead commit the changes of the following baselines:
test/image/baselines/mathjax.png
test/image/baselines/ternary-mathjax-title-place-subtitle.png
test/image/baselines/legend_mathjax_title_and_items.png
test/image/baselines/world-cals.png
test/image/baselines/worldcup.png
test/image/baselines/funnel_horizontal_group_basic.png
test/image/baselines/font-decorline-scatter.png
test/image/baselines/text_on_shapes_basic.png
test/image/baselines/indicator_scatter.png

Thank you 🙏
@emilykl
emilyklforce-pushed
the
use-new-kaleido-for-image-tests
branch
from
b1f16e0 to
6bab84dCompareJune 4, 2025 14:58
@archmojarchmoj
mentioned this pull request
Jul 7, 2025
 Closed

@archmojarchmoj
mentioned this pull request
Jul 17, 2025
 Merged

@emilykl
emilykl
commented
Jul 28, 2025

Copy link


Copy Markdown

ContributorAuthor
Closing in favor of #7498.
@emilyklemilykl
closed this
Jul 28, 2025
@archmoj
archmoj
deleted the

use-new-kaleido-for-image-tests

branch
July 28, 2025 21:38
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees

@emilyklemilykl
@ayjaytayjayt

Labels

infrastructurebuild process etc.P2considered for next cycle

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

4 participants

@emilykl@ayjayt@archmoj@gvwilson

, '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
Try using Kaleido v1 for image tests - #7412
Closed
emilykl wants to merge 34 commits into
masterfrom 
use-new-kaleido-for-image-tests
Closed
Try using Kaleido v1 for image tests#7412
emilykl wants to merge 34 commits into
masterfrom 
use-new-kaleido-for-image-tests
Conversation
@emilykl
@emilyklemilykl
commented
Apr 30, 2025

Copy link


Copy Markdown

Contributor
 No description provided. 
@gvwilsongvwilson
added

P2
considered for next cycle
infrastructure
build process etc.
labels
May 8, 2025
@ayjayt
ayjayt
commented
May 29, 2025

Copy link


Copy Markdown

Contributor
Hi @emilykl, any interest in assigning me as well?
@emilykl
emilykl
commented
May 29, 2025

Copy link


Copy Markdown

ContributorAuthor
@ayjayt You're welcome to try on your own branch if you like -- I believe this task is blocked by plotly/plotly.py#5207 though which I'm still testing
emilykl
added 17 commits
May 29, 2025 16:07
@emilykl
add apt-get update step
94335b8
@emilykl
does it work with '-browsers' images?
86f0a3e
@emilykl
use cimg instead of circleci
30c39f4
@emilykl
use python instead of python3
279af99
@emilykl
Revert "use python instead of python3"
ecb2c0c
This reverts commit 279af99.
@emilykl
ensurepip
97b5f29
@emilykl
Revert "ensurepip"
18f0a67
This reverts commit 97b5f29.
@emilykl
'python' rather than 'sudo python3'
3f13771
@emilykl
try python3 without sudo
fae9f08
@emilykl
pip install requests
d0fa346
@emilykl
update kaleido ref
03a53b6
@emilykl
temporarily blacklist 'gl3d_streamtube_reversed_ranges' baseline
99eb4b5
@emilykl
temporarily blacklist 'mathjax' baseline
fcafd40
@emilykl
temporarily blacklist 'map_predefined-styles2' baseline
41172b3
@emilykl
remove eps from make_exports
0ec3ba1
@emilykl
temporarily blacklist 'map_predefined-styles1' and 'grid_subplot_type…
ff45414
…s' baselines
@emilykl
temporarily blacklist 'map_fonts-supported-metropolis' baseline
340fd9e
@emilykl
emilykl
commented
May 30, 2025

Copy link


Copy Markdown

ContributorAuthor
@ayjayt There are two figures which are failing consistently with an error in Kaleido v1 -- could you investigate?
These are the two figures:
gl3d_streamtube_reversed_ranges
mathjax

(There are a few others which are failing intermittently but I think that's due to instability in the pipeline, not anything to do with Kaleido)
Here is an archive containing:
  1. The JSON figure representations for the failing figures
  2. A script which attempts to generate an image from each, and prints the traceback on failure.
failing_figures_kaleido_v1.zip
You'll need to pip install a few things in your environment to run the script:
python -m pip install "git+https://github.com/plotly/plotly.py.git@6837831"
python -m pip install "git+https://github.com/plotly/Kaleido.git@v1.0.0rc14#subdirectory=src/py"
python -m pip install numpy

Below is the output generated by running python generate_images.py from inside the root directory of the archive:
Error output
(make_baseline) (base) ekl@Emilys-MacBook-Air-2 failing_figures_kaleido_v1 % python generate_images.py
=============
=== Failed to generate image for gl3d_streamtube_reversed_ranges ===
=============
Traceback (most recent call last):
File "generate_images.py", line 32, in <module>
pio.write_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 509, in write_image
img_data = to_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 379, in to_image
img_bytes = kaleido.calc_fig_sync(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 145, in calc_fig_sync
return _async_thread_run(calc_fig, args=args, kwargs=kwargs)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 138, in _async_thread_run
raise res
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 129, in run
q.put(asyncio.run(func(*args, **kwargs)))
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/runners.py", line 44, in run
return loop.run_until_complete(main)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/base_events.py", line 616, in run_until_complete
return future.result()
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 55, in calc_fig
return await k.calc_fig(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/kaleido.py", line 319, in calc_fig
spec, full_path = build_fig_spec(fig, path, opts)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 144, in build_fig_spec
name = _next_filename(directory, prefix, ext)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 94, in _next_filename
re_number = re.compile(r"^" + prefix + r"-(\d+)\." + ext + r"$")
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 252, in compile
return _compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 304, in _compile
p = sre_compile.compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_compile.py", line 764, in compile
p = sre_parse.parse(p, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 948, in parse
p = _parse_sub(source, state, flags & SRE_FLAG_VERBOSE, 0)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 443, in _parse_sub
itemsappend(_parse(source, state, verbose, nested + 1,
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 598, in _parse
raise source.error(msg, len(this) + 1 + len(that))
re.error: bad character range _-2 at position 94
=============
=============
=== Failed to generate image for mathjax ===
=============
Traceback (most recent call last):
File "generate_images.py", line 32, in <module>
pio.write_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 509, in write_image
img_data = to_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 379, in to_image
img_bytes = kaleido.calc_fig_sync(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 145, in calc_fig_sync
return _async_thread_run(calc_fig, args=args, kwargs=kwargs)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 138, in _async_thread_run
raise res
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 129, in run
q.put(asyncio.run(func(*args, **kwargs)))
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/runners.py", line 44, in run
return loop.run_until_complete(main)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/base_events.py", line 616, in run_until_complete
return future.result()
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 55, in calc_fig
return await k.calc_fig(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/kaleido.py", line 319, in calc_fig
spec, full_path = build_fig_spec(fig, path, opts)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 144, in build_fig_spec
name = _next_filename(directory, prefix, ext)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 94, in _next_filename
re_number = re.compile(r"^" + prefix + r"-(\d+)\." + ext + r"$")
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 252, in compile
return _compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 304, in _compile
p = sre_compile.compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_compile.py", line 764, in compile
p = sre_parse.parse(p, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 948, in parse
p = _parse_sub(source, state, flags & SRE_FLAG_VERBOSE, 0)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 443, in _parse_sub
itemsappend(_parse(source, state, verbose, nested + 1,
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 525, in _parse
code = _escape(source, this, state)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 426, in _escape
raise source.error("bad escape %s" % escape, len(escape))
re.error: bad escape \h at position 3
=============

@ayjaytayjayt
mentioned this pull request
Jun 2, 2025
 Merged

@ayjayt
ayjayt
commented
Jun 2, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
@emilykl
plotly/Kaleido#339 makes it work for me
here's a uv script preamble to build in the build steps (will redownload stuff) right in generate_images
# /// script# requires-python = ">=3.13"# dependencies = [# "kaleido",# "numpy",# "plotly",# ]## [tool.uv.sources]# plotly = { git = "https://github.com/plotly/plotly.py.git", rev = "6837831" }# ///
@archmoj
archmoj
commented
Jun 4, 2025

Copy link


Copy Markdown

Contributor
@emilykl After I viewed most significant changes on my dev branch I suggest you drop the a426afa commit (possibly by force pushing i.e. to reduce the size of changes) and instead commit the changes of the following baselines:
test/image/baselines/mathjax.png
test/image/baselines/ternary-mathjax-title-place-subtitle.png
test/image/baselines/legend_mathjax_title_and_items.png
test/image/baselines/world-cals.png
test/image/baselines/worldcup.png
test/image/baselines/funnel_horizontal_group_basic.png
test/image/baselines/font-decorline-scatter.png
test/image/baselines/text_on_shapes_basic.png
test/image/baselines/indicator_scatter.png

Thank you 🙏
@emilykl
emilyklforce-pushed
the
use-new-kaleido-for-image-tests
branch
from
b1f16e0 to
6bab84dCompareJune 4, 2025 14:58
@archmojarchmoj
mentioned this pull request
Jul 7, 2025
 Closed

@archmojarchmoj
mentioned this pull request
Jul 17, 2025
 Merged

@emilykl
emilykl
commented
Jul 28, 2025

Copy link


Copy Markdown

ContributorAuthor
Closing in favor of #7498.
@emilyklemilykl
closed this
Jul 28, 2025
@archmoj
archmoj
deleted the

use-new-kaleido-for-image-tests

branch
July 28, 2025 21:38
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees

@emilyklemilykl
@ayjaytayjayt

Labels

infrastructurebuild process etc.P2considered for next cycle

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

4 participants

@emilykl@ayjayt@archmoj@gvwilson

, '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
Try using Kaleido v1 for image tests - #7412
Closed
emilykl wants to merge 34 commits into
masterfrom 
use-new-kaleido-for-image-tests
Closed
Try using Kaleido v1 for image tests#7412
emilykl wants to merge 34 commits into
masterfrom 
use-new-kaleido-for-image-tests
Conversation
@emilykl
@emilyklemilykl
commented
Apr 30, 2025

Copy link


Copy Markdown

Contributor
 No description provided. 
@gvwilsongvwilson
added

P2
considered for next cycle
infrastructure
build process etc.
labels
May 8, 2025
@ayjayt
ayjayt
commented
May 29, 2025

Copy link


Copy Markdown

Contributor
Hi @emilykl, any interest in assigning me as well?
@emilykl
emilykl
commented
May 29, 2025

Copy link


Copy Markdown

ContributorAuthor
@ayjayt You're welcome to try on your own branch if you like -- I believe this task is blocked by plotly/plotly.py#5207 though which I'm still testing
emilykl
added 17 commits
May 29, 2025 16:07
@emilykl
add apt-get update step
94335b8
@emilykl
does it work with '-browsers' images?
86f0a3e
@emilykl
use cimg instead of circleci
30c39f4
@emilykl
use python instead of python3
279af99
@emilykl
Revert "use python instead of python3"
ecb2c0c
This reverts commit 279af99.
@emilykl
ensurepip
97b5f29
@emilykl
Revert "ensurepip"
18f0a67
This reverts commit 97b5f29.
@emilykl
'python' rather than 'sudo python3'
3f13771
@emilykl
try python3 without sudo
fae9f08
@emilykl
pip install requests
d0fa346
@emilykl
update kaleido ref
03a53b6
@emilykl
temporarily blacklist 'gl3d_streamtube_reversed_ranges' baseline
99eb4b5
@emilykl
temporarily blacklist 'mathjax' baseline
fcafd40
@emilykl
temporarily blacklist 'map_predefined-styles2' baseline
41172b3
@emilykl
remove eps from make_exports
0ec3ba1
@emilykl
temporarily blacklist 'map_predefined-styles1' and 'grid_subplot_type…
ff45414
…s' baselines
@emilykl
temporarily blacklist 'map_fonts-supported-metropolis' baseline
340fd9e
@emilykl
emilykl
commented
May 30, 2025

Copy link


Copy Markdown

ContributorAuthor
@ayjayt There are two figures which are failing consistently with an error in Kaleido v1 -- could you investigate?
These are the two figures:
gl3d_streamtube_reversed_ranges
mathjax

(There are a few others which are failing intermittently but I think that's due to instability in the pipeline, not anything to do with Kaleido)
Here is an archive containing:
  1. The JSON figure representations for the failing figures
  2. A script which attempts to generate an image from each, and prints the traceback on failure.
failing_figures_kaleido_v1.zip
You'll need to pip install a few things in your environment to run the script:
python -m pip install "git+https://github.com/plotly/plotly.py.git@6837831"
python -m pip install "git+https://github.com/plotly/Kaleido.git@v1.0.0rc14#subdirectory=src/py"
python -m pip install numpy

Below is the output generated by running python generate_images.py from inside the root directory of the archive:
Error output
(make_baseline) (base) ekl@Emilys-MacBook-Air-2 failing_figures_kaleido_v1 % python generate_images.py
=============
=== Failed to generate image for gl3d_streamtube_reversed_ranges ===
=============
Traceback (most recent call last):
File "generate_images.py", line 32, in <module>
pio.write_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 509, in write_image
img_data = to_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 379, in to_image
img_bytes = kaleido.calc_fig_sync(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 145, in calc_fig_sync
return _async_thread_run(calc_fig, args=args, kwargs=kwargs)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 138, in _async_thread_run
raise res
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 129, in run
q.put(asyncio.run(func(*args, **kwargs)))
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/runners.py", line 44, in run
return loop.run_until_complete(main)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/base_events.py", line 616, in run_until_complete
return future.result()
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 55, in calc_fig
return await k.calc_fig(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/kaleido.py", line 319, in calc_fig
spec, full_path = build_fig_spec(fig, path, opts)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 144, in build_fig_spec
name = _next_filename(directory, prefix, ext)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 94, in _next_filename
re_number = re.compile(r"^" + prefix + r"-(\d+)\." + ext + r"$")
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 252, in compile
return _compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 304, in _compile
p = sre_compile.compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_compile.py", line 764, in compile
p = sre_parse.parse(p, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 948, in parse
p = _parse_sub(source, state, flags & SRE_FLAG_VERBOSE, 0)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 443, in _parse_sub
itemsappend(_parse(source, state, verbose, nested + 1,
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 598, in _parse
raise source.error(msg, len(this) + 1 + len(that))
re.error: bad character range _-2 at position 94
=============
=============
=== Failed to generate image for mathjax ===
=============
Traceback (most recent call last):
File "generate_images.py", line 32, in <module>
pio.write_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 509, in write_image
img_data = to_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 379, in to_image
img_bytes = kaleido.calc_fig_sync(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 145, in calc_fig_sync
return _async_thread_run(calc_fig, args=args, kwargs=kwargs)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 138, in _async_thread_run
raise res
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 129, in run
q.put(asyncio.run(func(*args, **kwargs)))
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/runners.py", line 44, in run
return loop.run_until_complete(main)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/base_events.py", line 616, in run_until_complete
return future.result()
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 55, in calc_fig
return await k.calc_fig(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/kaleido.py", line 319, in calc_fig
spec, full_path = build_fig_spec(fig, path, opts)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 144, in build_fig_spec
name = _next_filename(directory, prefix, ext)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 94, in _next_filename
re_number = re.compile(r"^" + prefix + r"-(\d+)\." + ext + r"$")
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 252, in compile
return _compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 304, in _compile
p = sre_compile.compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_compile.py", line 764, in compile
p = sre_parse.parse(p, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 948, in parse
p = _parse_sub(source, state, flags & SRE_FLAG_VERBOSE, 0)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 443, in _parse_sub
itemsappend(_parse(source, state, verbose, nested + 1,
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 525, in _parse
code = _escape(source, this, state)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 426, in _escape
raise source.error("bad escape %s" % escape, len(escape))
re.error: bad escape \h at position 3
=============

@ayjaytayjayt
mentioned this pull request
Jun 2, 2025
 Merged

@ayjayt
ayjayt
commented
Jun 2, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
@emilykl
plotly/Kaleido#339 makes it work for me
here's a uv script preamble to build in the build steps (will redownload stuff) right in generate_images
# /// script# requires-python = ">=3.13"# dependencies = [# "kaleido",# "numpy",# "plotly",# ]## [tool.uv.sources]# plotly = { git = "https://github.com/plotly/plotly.py.git", rev = "6837831" }# ///
@archmoj
archmoj
commented
Jun 4, 2025

Copy link


Copy Markdown

Contributor
@emilykl After I viewed most significant changes on my dev branch I suggest you drop the a426afa commit (possibly by force pushing i.e. to reduce the size of changes) and instead commit the changes of the following baselines:
test/image/baselines/mathjax.png
test/image/baselines/ternary-mathjax-title-place-subtitle.png
test/image/baselines/legend_mathjax_title_and_items.png
test/image/baselines/world-cals.png
test/image/baselines/worldcup.png
test/image/baselines/funnel_horizontal_group_basic.png
test/image/baselines/font-decorline-scatter.png
test/image/baselines/text_on_shapes_basic.png
test/image/baselines/indicator_scatter.png

Thank you 🙏
@emilykl
emilyklforce-pushed
the
use-new-kaleido-for-image-tests
branch
from
b1f16e0 to
6bab84dCompareJune 4, 2025 14:58
@archmojarchmoj
mentioned this pull request
Jul 7, 2025
 Closed

@archmojarchmoj
mentioned this pull request
Jul 17, 2025
 Merged

@emilykl
emilykl
commented
Jul 28, 2025

Copy link


Copy Markdown

ContributorAuthor
Closing in favor of #7498.
@emilyklemilykl
closed this
Jul 28, 2025
@archmoj
archmoj
deleted the

use-new-kaleido-for-image-tests

branch
July 28, 2025 21:38
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees

@emilyklemilykl
@ayjaytayjayt

Labels

infrastructurebuild process etc.P2considered for next cycle

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

4 participants

@emilykl@ayjayt@archmoj@gvwilson

, '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
Try using Kaleido v1 for image tests - #7412
Closed
emilykl wants to merge 34 commits into
masterfrom 
use-new-kaleido-for-image-tests
Closed
Try using Kaleido v1 for image tests#7412
emilykl wants to merge 34 commits into
masterfrom 
use-new-kaleido-for-image-tests
Conversation
@emilykl
@emilyklemilykl
commented
Apr 30, 2025

Copy link


Copy Markdown

Contributor
 No description provided. 
@gvwilsongvwilson
added

P2
considered for next cycle
infrastructure
build process etc.
labels
May 8, 2025
@ayjayt
ayjayt
commented
May 29, 2025

Copy link


Copy Markdown

Contributor
Hi @emilykl, any interest in assigning me as well?
@emilykl
emilykl
commented
May 29, 2025

Copy link


Copy Markdown

ContributorAuthor
@ayjayt You're welcome to try on your own branch if you like -- I believe this task is blocked by plotly/plotly.py#5207 though which I'm still testing
emilykl
added 17 commits
May 29, 2025 16:07
@emilykl
add apt-get update step
94335b8
@emilykl
does it work with '-browsers' images?
86f0a3e
@emilykl
use cimg instead of circleci
30c39f4
@emilykl
use python instead of python3
279af99
@emilykl
Revert "use python instead of python3"
ecb2c0c
This reverts commit 279af99.
@emilykl
ensurepip
97b5f29
@emilykl
Revert "ensurepip"
18f0a67
This reverts commit 97b5f29.
@emilykl
'python' rather than 'sudo python3'
3f13771
@emilykl
try python3 without sudo
fae9f08
@emilykl
pip install requests
d0fa346
@emilykl
update kaleido ref
03a53b6
@emilykl
temporarily blacklist 'gl3d_streamtube_reversed_ranges' baseline
99eb4b5
@emilykl
temporarily blacklist 'mathjax' baseline
fcafd40
@emilykl
temporarily blacklist 'map_predefined-styles2' baseline
41172b3
@emilykl
remove eps from make_exports
0ec3ba1
@emilykl
temporarily blacklist 'map_predefined-styles1' and 'grid_subplot_type…
ff45414
…s' baselines
@emilykl
temporarily blacklist 'map_fonts-supported-metropolis' baseline
340fd9e
@emilykl
emilykl
commented
May 30, 2025

Copy link


Copy Markdown

ContributorAuthor
@ayjayt There are two figures which are failing consistently with an error in Kaleido v1 -- could you investigate?
These are the two figures:
gl3d_streamtube_reversed_ranges
mathjax

(There are a few others which are failing intermittently but I think that's due to instability in the pipeline, not anything to do with Kaleido)
Here is an archive containing:
  1. The JSON figure representations for the failing figures
  2. A script which attempts to generate an image from each, and prints the traceback on failure.
failing_figures_kaleido_v1.zip
You'll need to pip install a few things in your environment to run the script:
python -m pip install "git+https://github.com/plotly/plotly.py.git@6837831"
python -m pip install "git+https://github.com/plotly/Kaleido.git@v1.0.0rc14#subdirectory=src/py"
python -m pip install numpy

Below is the output generated by running python generate_images.py from inside the root directory of the archive:
Error output
(make_baseline) (base) ekl@Emilys-MacBook-Air-2 failing_figures_kaleido_v1 % python generate_images.py
=============
=== Failed to generate image for gl3d_streamtube_reversed_ranges ===
=============
Traceback (most recent call last):
File "generate_images.py", line 32, in <module>
pio.write_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 509, in write_image
img_data = to_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 379, in to_image
img_bytes = kaleido.calc_fig_sync(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 145, in calc_fig_sync
return _async_thread_run(calc_fig, args=args, kwargs=kwargs)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 138, in _async_thread_run
raise res
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 129, in run
q.put(asyncio.run(func(*args, **kwargs)))
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/runners.py", line 44, in run
return loop.run_until_complete(main)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/base_events.py", line 616, in run_until_complete
return future.result()
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 55, in calc_fig
return await k.calc_fig(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/kaleido.py", line 319, in calc_fig
spec, full_path = build_fig_spec(fig, path, opts)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 144, in build_fig_spec
name = _next_filename(directory, prefix, ext)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 94, in _next_filename
re_number = re.compile(r"^" + prefix + r"-(\d+)\." + ext + r"$")
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 252, in compile
return _compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 304, in _compile
p = sre_compile.compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_compile.py", line 764, in compile
p = sre_parse.parse(p, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 948, in parse
p = _parse_sub(source, state, flags & SRE_FLAG_VERBOSE, 0)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 443, in _parse_sub
itemsappend(_parse(source, state, verbose, nested + 1,
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 598, in _parse
raise source.error(msg, len(this) + 1 + len(that))
re.error: bad character range _-2 at position 94
=============
=============
=== Failed to generate image for mathjax ===
=============
Traceback (most recent call last):
File "generate_images.py", line 32, in <module>
pio.write_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 509, in write_image
img_data = to_image(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/plotly/io/_kaleido.py", line 379, in to_image
img_bytes = kaleido.calc_fig_sync(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 145, in calc_fig_sync
return _async_thread_run(calc_fig, args=args, kwargs=kwargs)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 138, in _async_thread_run
raise res
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 129, in run
q.put(asyncio.run(func(*args, **kwargs)))
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/runners.py", line 44, in run
return loop.run_until_complete(main)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/asyncio/base_events.py", line 616, in run_until_complete
return future.result()
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/__init__.py", line 55, in calc_fig
return await k.calc_fig(
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/kaleido.py", line 319, in calc_fig
spec, full_path = build_fig_spec(fig, path, opts)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 144, in build_fig_spec
name = _next_filename(directory, prefix, ext)
File "/Users/ekl/code/plotly.js/venv/make_baseline/lib/python3.8/site-packages/kaleido/_fig_tools.py", line 94, in _next_filename
re_number = re.compile(r"^" + prefix + r"-(\d+)\." + ext + r"$")
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 252, in compile
return _compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/re.py", line 304, in _compile
p = sre_compile.compile(pattern, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_compile.py", line 764, in compile
p = sre_parse.parse(p, flags)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 948, in parse
p = _parse_sub(source, state, flags & SRE_FLAG_VERBOSE, 0)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 443, in _parse_sub
itemsappend(_parse(source, state, verbose, nested + 1,
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 525, in _parse
code = _escape(source, this, state)
File "/Users/ekl/.local/share/uv/python/cpython-3.8.20-macos-aarch64-none/lib/python3.8/sre_parse.py", line 426, in _escape
raise source.error("bad escape %s" % escape, len(escape))
re.error: bad escape \h at position 3
=============

@ayjaytayjayt
mentioned this pull request
Jun 2, 2025
 Merged

@ayjayt
ayjayt
commented
Jun 2, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
@emilykl
plotly/Kaleido#339 makes it work for me
here's a uv script preamble to build in the build steps (will redownload stuff) right in generate_images
# /// script# requires-python = ">=3.13"# dependencies = [# "kaleido",# "numpy",# "plotly",# ]## [tool.uv.sources]# plotly = { git = "https://github.com/plotly/plotly.py.git", rev = "6837831" }# ///
@archmoj
archmoj
commented
Jun 4, 2025

Copy link


Copy Markdown

Contributor
@emilykl After I viewed most significant changes on my dev branch I suggest you drop the a426afa commit (possibly by force pushing i.e. to reduce the size of changes) and instead commit the changes of the following baselines:
test/image/baselines/mathjax.png
test/image/baselines/ternary-mathjax-title-place-subtitle.png
test/image/baselines/legend_mathjax_title_and_items.png
test/image/baselines/world-cals.png
test/image/baselines/worldcup.png
test/image/baselines/funnel_horizontal_group_basic.png
test/image/baselines/font-decorline-scatter.png
test/image/baselines/text_on_shapes_basic.png
test/image/baselines/indicator_scatter.png

Thank you 🙏
@emilykl
emilyklforce-pushed
the
use-new-kaleido-for-image-tests
branch
from
b1f16e0 to
6bab84dCompareJune 4, 2025 14:58
@archmojarchmoj
mentioned this pull request
Jul 7, 2025
 Closed

@archmojarchmoj
mentioned this pull request
Jul 17, 2025
 Merged

@emilykl
emilykl
commented
Jul 28, 2025

Copy link


Copy Markdown

ContributorAuthor
Closing in favor of #7498.
@emilyklemilykl
closed this
Jul 28, 2025
@archmoj
archmoj
deleted the

use-new-kaleido-for-image-tests

branch
July 28, 2025 21:38
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees

@emilyklemilykl
@ayjaytayjayt

Labels

infrastructurebuild process etc.P2considered for next cycle

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

4 participants

@emilykl@ayjayt@archmoj@gvwilson