Try using Kaleido v1 for image tests#7412

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
emilykl wants to merge 34 commits into from
Closed

Try using Kaleido v1 for image tests #7412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
9a078e3
try using Kaleido v1 for image tests
emilykl Apr 30, 2025
f7f5a03
Update Plotly version
emilykl May 2, 2025
5595393
Merge branch 'master' into use-new-kaleido-for-image-tests
emilykl May 27, 2025
afafaf2
update version
emilykl May 27, 2025
8c84e4b
update to new pio API and use unreleased Plotly and Kaleido
emilykl May 29, 2025
14298d8
typo
emilykl May 29, 2025
09a0f4f
install chrome for make-baselines jobs
emilykl May 29, 2025
94335b8
add apt-get update step
emilykl May 29, 2025
86f0a3e
does it work with '-browsers' images?
emilykl May 29, 2025
30c39f4
use cimg instead of circleci
emilykl May 30, 2025
279af99
use python instead of python3
emilykl May 30, 2025
ecb2c0c
Revert "use python instead of python3"
emilykl May 30, 2025
97b5f29
ensurepip
emilykl May 30, 2025
18f0a67
Revert "ensurepip"
emilykl May 30, 2025
3f13771
'python' rather than 'sudo python3'
emilykl May 30, 2025
fae9f08
try python3 without sudo
emilykl May 30, 2025
d0fa346
pip install requests
emilykl May 30, 2025
03a53b6
update kaleido ref
emilykl May 30, 2025
99eb4b5
temporarily blacklist 'gl3d_streamtube_reversed_ranges' baseline
emilykl May 30, 2025
fcafd40
temporarily blacklist 'mathjax' baseline
emilykl May 30, 2025
41172b3
temporarily blacklist 'map_predefined-styles2' baseline
emilykl May 30, 2025
0ec3ba1
remove eps from make_exports
emilykl May 30, 2025
ff45414
temporarily blacklist 'map_predefined-styles1' and 'grid_subplot_type…
emilykl May 30, 2025
340fd9e
temporarily blacklist 'map_fonts-supported-metropolis' baseline
emilykl May 30, 2025
4e518a2
typo
emilykl May 30, 2025
2011839
try with new kaleido with bugfix
emilykl Jun 2, 2025
80fe5cf
update kaleido version
emilykl Jun 2, 2025
5857a70
temporarily blacklist 'map_fonts-supported-open-sans-weight' baseline
emilykl Jun 2, 2025
53e26b9
typo
emilykl Jun 3, 2025
430b195
temporarily blacklist 'map_fonts-supported-metropolis-weight' baseline
emilykl Jun 3, 2025
6bab84d
use single Kaleido instance for making baselines (faster performance)
emilykl Jun 3, 2025
4d4d34f
commit new baselines with significant changes
emilykl Jun 4, 2025
86f5283
update plotly version in env_image.sh
emilykl Jun 4, 2025
9085ed5
Merge branch 'master' into use-new-kaleido-for-image-tests
emilykl Jul 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 35 additions & 5 deletions .circleci/config.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -217,9 +217,15 @@ jobs:
make-baselines-virtual-webgl:
parallelism: 8
docker:
- image: cimg/python:3.12.11
- image: cimg/python:3.12.11-browsers
working_directory: ~/plotly.js
steps:
- run: sudo apt-get update
- browser-tools/install-browser-tools:
install-firefox: false
install-geckodriver: false
install-chrome: true
chrome-version: "132.0.6834.110"
- attach_workspace:
at: ~/
- run: sudo apt-get update
Expand All@@ -236,9 +242,15 @@ jobs:

make-baselines-mathjax3:
docker:
- image: cimg/python:3.12.11
- image: cimg/python:3.12.11-browsers
working_directory: ~/plotly.js
steps:
- run: sudo apt-get update
- browser-tools/install-browser-tools:
install-firefox: false
install-geckodriver: false
install-chrome: true
chrome-version: "132.0.6834.110"
- attach_workspace:
at: ~/
- run: sudo apt-get update
Expand All@@ -256,9 +268,15 @@ jobs:
make-baselines:
parallelism: 12
docker:
- image: cimg/python:3.12.11
- image: cimg/python:3.12.11-browsers
working_directory: ~/plotly.js
steps:
- run: sudo apt-get update
- browser-tools/install-browser-tools:
install-firefox: false
install-geckodriver: false
install-chrome: true
chrome-version: "132.0.6834.110"
- attach_workspace:
at: ~/
- run: sudo apt-get update
Expand All@@ -276,9 +294,15 @@ jobs:
make-baselines-b64:
parallelism: 12
docker:
- image: cimg/python:3.12.11
- image: cimg/python:3.12.11-browsers
working_directory: ~/plotly.js
steps:
- run: sudo apt-get update
- browser-tools/install-browser-tools:
install-firefox: false
install-geckodriver: false
install-chrome: true
chrome-version: "132.0.6834.110"
- attach_workspace:
at: ~/
- run: sudo apt-get update
Expand DownExpand Up@@ -351,9 +375,15 @@ jobs:

make-exports:
docker:
- image: cimg/python:3.12.11
- image: cimg/python:3.12.11-browsers
working_directory: ~/plotly.js
steps:
- run: sudo apt-get update
- browser-tools/install-browser-tools:
install-firefox: false
install-geckodriver: false
install-chrome: true
chrome-version: "132.0.6834.110"
- attach_workspace:
at: ~/
- run: sudo apt-get update
Expand Down
6 changes: 3 additions & 3 deletions .circleci/env_image.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
#!/bin/sh
set -e
python3 --version
# install required fonts
sudo apt-get install fonts-liberation2 fonts-open-sans fonts-noto-cjk fonts-noto-color-emoji

Expand All@@ -15,7 +16,6 @@ sudo apt install fontconfig
sudo fc-cache -f

# install kaleido & plotly
sudo python3 -m pip install kaleido==0.2.1 plotly==6.2.0 --progress-bar off

python -m pip install "plotly[kaleido]==6.2.0" --progress-bar off
# install numpy i.e. to convert arrays to typed arrays
sudo python3 -m pip install numpy==1.24.2
python3 -m pip install numpy==1.24.2
Binary file modifiedtest/image/baselines/font-decorline-scatter.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/funnel_horizontal_group_basic.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/indicator_scatter.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/legend_mathjax_title_and_items.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/mathjax.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/ternary-mathjax-title-place-subtitle.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/text_on_shapes_basic.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/world-cals.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
142 changes: 86 additions & 56 deletions test/image/make_baseline.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
import asyncio
import os
import sys
import json

import plotly.io as pio
import kaleido

from convert_b64 import arraysToB64


args = []
if len(sys.argv) == 2 :
args = sys.argv[1].split()
Expand All@@ -19,7 +24,7 @@
dirIn = os.path.join(root, 'test', 'image', 'mocks')
dirOut = os.path.join(root, 'build', 'test_images')

# N.B. equal is the falg to write to baselines not test_images
# N.B. equal is the flag to write to baselines not test_images

if '=' in args :
args = args[args.index('=') + 1:]
Expand All@@ -31,11 +36,12 @@
print('output to', dirOut)

mathjax_version = 2
mathjax = None
if 'mathjax3' in sys.argv or 'mathjax3=' in sys.argv :
# until https://github.com/plotly/Kaleido/issues/124 is addressed
# we are uanble to use local mathjax v3 installed in node_modules
# for now let's download it from the internet:
pio.kaleido.scope.mathjax = 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-svg.js'
mathjax = 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-svg.js'
mathjax_version = 3
print('Kaleido using MathJax v3')

Expand All@@ -52,8 +58,8 @@

plotlyjs = plotlyjs_with_virtual_webgl

pio.kaleido.scope.plotlyjs = plotlyjs
pio.kaleido.scope.topojson = "file://" + os.path.join(root, 'topojson', 'dist')
pio.defaults.plotlyjs = plotlyjs
pio.defaults.topojson = "file://" + os.path.join(root, 'topojson', 'dist')
pio.templates.default = 'none'

ALL_MOCKS = [os.path.splitext(a)[0] for a in os.listdir(dirIn) if a.endswith('.json')]
Expand All@@ -71,6 +77,11 @@
'map_scattercluster',
'map_fonts-supported-open-sans',
'map_fonts-supported-open-sans-weight',
'map_predefined-styles1', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
'grid_subplot_types', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
'map_fonts-supported-metropolis', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
'map_fonts-supported-metropolis-italic', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
'map_fonts-supported-metropolis-weight', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
]
allNames = [a for a in allNames if a not in blacklist]

Expand All@@ -79,55 +90,74 @@
sys.exit(1)

failed = []
for name in allNames :
outName = name
if mathjax_version == 3 :
outName = 'mathjax3___' + name

print(outName)

created = False

MAX_RETRY = 2 # 1 means retry once
for attempt in range(0, MAX_RETRY + 1) :
with open(os.path.join(dirIn, name + '.json'), 'r') as _in :
fig = json.load(_in)

width = 700
height = 500
if 'layout' in fig :
layout = fig['layout']
if 'autosize' not in layout or layout['autosize'] != True :
if 'width' in layout :
width = layout['width']
if 'height' in layout :
height = layout['height']

if 'b64' in sys.argv or 'b64=' in sys.argv or 'b64-json' in sys.argv :
newFig = dict()
arraysToB64(fig, newFig)
fig = newFig
if 'b64-json' in sys.argv and attempt == 0 : print(json.dumps(fig, indent = 2))

try :
pio.write_image(
fig=fig,
file=os.path.join(dirOut, outName + '.png'),
width=width,
height=height,
validate=False
)
created = True
except Exception as e :
print(e)
if attempt < MAX_RETRY :
print('retry', attempt + 1, '/', MAX_RETRY)
else :
failed.append(outName)

if(created) : break

if len(failed) > 0 :
print('Failed at :')
print(failed)
sys.exit(1)

async def make_baselines_async():

kopts = dict(
plotlyjs=plotlyjs,
)
if mathjax is not None:
kopts['mathjax'] = mathjax

async with kaleido.Kaleido(n=1, **kopts) as k:
for name in allNames:
outName = name
if mathjax_version == 3:
outName = 'mathjax3___' + name

print(outName)

created = False

MAX_RETRY = 2 # 1 means retry once
for attempt in range(0, MAX_RETRY + 1) :
with open(os.path.join(dirIn, name + '.json'), 'r') as _in :
fig = json.load(_in)

width = 700
height = 500
if 'layout' in fig :
layout = fig['layout']
if 'autosize' not in layout or layout['autosize'] != True :
if 'width' in layout :
width = layout['width']
if 'height' in layout :
height = layout['height']

if 'b64' in sys.argv or 'b64=' in sys.argv or 'b64-json' in sys.argv :
newFig = dict()
arraysToB64(fig, newFig)
fig = newFig
if 'b64-json' in sys.argv and attempt == 0 : print(json.dumps(fig, indent = 2))

try:
bytes = await k.calc_fig(
fig,
path=None,
opts=dict(
format="png",
width=width,
height=height,
),
)
filename = os.path.join(dirOut, outName + '.png')
with open(filename, "wb") as f:
f.write(bytes)
created = True
except Exception as e:
print(e)
if attempt < MAX_RETRY :
print('retry', attempt + 1, '/', MAX_RETRY)
else :
failed.append(outName)

if(created): break

if len(failed) > 0 :
print('Failed at :')
print(failed)
sys.exit(1)


if __name__ == "__main__":
asyncio.run(make_baselines_async())
2 changes: 1 addition & 1 deletion test/image/make_exports.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@
'zsmooth_methods',
'fonts',
'worldcup',
'mathjax'
'mathjax',
]

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

Skip to content
Try using Kaleido v1 for image tests#7412

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

emilykl
wants to merge
34
commits into

from

 Closed


Try using Kaleido v1 for image tests
#7412
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


34 commits


Select commit
Hold shift + click to select a range
9a078e3

try using Kaleido v1 for image tests


emilykl Apr 30, 2025
f7f5a03

Update Plotly version


emilykl May 2, 2025
5595393

Merge branch 'master' into use-new-kaleido-for-image-tests


emilykl May 27, 2025
afafaf2

update version


emilykl May 27, 2025
8c84e4b

update to new pio API and use unreleased Plotly and Kaleido


emilykl May 29, 2025
14298d8

typo


emilykl May 29, 2025
09a0f4f

install chrome for make-baselines jobs


emilykl May 29, 2025
94335b8

add apt-get update step


emilykl May 29, 2025
86f0a3e

does it work with '-browsers' images?


emilykl May 29, 2025
30c39f4

use cimg instead of circleci


emilykl May 30, 2025
279af99

use python instead of python3


emilykl May 30, 2025
ecb2c0c

Revert "use python instead of python3"


emilykl May 30, 2025
97b5f29

ensurepip


emilykl May 30, 2025
18f0a67

Revert "ensurepip"


emilykl May 30, 2025
3f13771

'python' rather than 'sudo python3'


emilykl May 30, 2025
fae9f08

try python3 without sudo


emilykl May 30, 2025
d0fa346

pip install requests


emilykl May 30, 2025
03a53b6

update kaleido ref


emilykl May 30, 2025
99eb4b5

temporarily blacklist 'gl3d_streamtube_reversed_ranges' baseline


emilykl May 30, 2025
fcafd40

temporarily blacklist 'mathjax' baseline


emilykl May 30, 2025
41172b3

temporarily blacklist 'map_predefined-styles2' baseline


emilykl May 30, 2025
0ec3ba1

remove eps from make_exports


emilykl May 30, 2025
ff45414

temporarily blacklist 'map_predefined-styles1' and 'grid_subplot_type…


emilykl May 30, 2025
340fd9e

temporarily blacklist 'map_fonts-supported-metropolis' baseline


emilykl May 30, 2025
4e518a2

typo


emilykl May 30, 2025
2011839

try with new kaleido with bugfix


emilykl Jun 2, 2025
80fe5cf

update kaleido version


emilykl Jun 2, 2025
5857a70

temporarily blacklist 'map_fonts-supported-open-sans-weight' baseline


emilykl Jun 2, 2025
53e26b9

typo


emilykl Jun 3, 2025
430b195

temporarily blacklist 'map_fonts-supported-metropolis-weight' baseline


emilykl Jun 3, 2025
6bab84d

use single Kaleido instance for making baselines (faster performance)


emilykl Jun 3, 2025
4d4d34f

commit new baselines with significant changes


emilykl Jun 4, 2025
86f5283

update plotly version in env_image.sh


emilykl Jun 4, 2025
9085ed5

Merge branch 'master' into use-new-kaleido-for-image-tests


emilykl Jul 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


40 changes: 35 additions & 5 deletions
.circleci/config.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,9 +217,15 @@ jobs:
 make-baselines-virtual-webgl:
 parallelism: 8
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand All@@ -236,9 +242,15 @@ jobs:

 make-baselines-mathjax3:
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand All@@ -256,9 +268,15 @@ jobs:
 make-baselines:
 parallelism: 12
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand All@@ -276,9 +294,15 @@ jobs:
 make-baselines-b64:
 parallelism: 12
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand DownExpand Up@@ -351,9 +375,15 @@ jobs:

 make-exports:
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand Down

6 changes: 3 additions & 3 deletions
.circleci/env_image.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
#!/bin/sh
set -e
python3 --version
# install required fonts
sudo apt-get install fonts-liberation2 fonts-open-sans fonts-noto-cjk fonts-noto-color-emoji

Expand All@@ -15,7 +16,6 @@ sudo apt install fontconfig
sudo fc-cache -f

# install kaleido & plotly
sudo python3 -m pip install kaleido==0.2.1 plotly==6.2.0 --progress-bar off

python -m pip install "plotly[kaleido]==6.2.0" --progress-bar off
# install numpy i.e. to convert arrays to typed arrays
sudo python3 -m pip install numpy==1.24.2
python3 -m pip install numpy==1.24.2
Binary file modifiedtest/image/baselines/font-decorline-scatter.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/funnel_horizontal_group_basic.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/indicator_scatter.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/legend_mathjax_title_and_items.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/mathjax.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/ternary-mathjax-title-place-subtitle.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/text_on_shapes_basic.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/world-cals.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

142 changes: 86 additions & 56 deletions
test/image/make_baseline.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
import asyncio
import os
import sys
import json

import plotly.io as pio
import kaleido

from convert_b64 import arraysToB64


args = []
if len(sys.argv) == 2 :
 args = sys.argv[1].split()
Expand All@@ -19,7 +24,7 @@
dirIn = os.path.join(root, 'test', 'image', 'mocks')
dirOut = os.path.join(root, 'build', 'test_images')

# N.B. equal is the falg to write to baselines not test_images
# N.B. equal is the flag to write to baselines not test_images

if '=' in args :
 args = args[args.index('=') + 1:]
Expand All@@ -31,11 +36,12 @@
print('output to', dirOut)

mathjax_version = 2
mathjax = None
if 'mathjax3' in sys.argv or 'mathjax3=' in sys.argv :
 # until https://github.com/plotly/Kaleido/issues/124 is addressed
 # we are uanble to use local mathjax v3 installed in node_modules
 # for now let's download it from the internet:
pio.kaleido.scope.mathjax = 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-svg.js'
 mathjax = 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-svg.js'
 mathjax_version = 3
 print('Kaleido using MathJax v3')

Expand All@@ -52,8 +58,8 @@

 plotlyjs = plotlyjs_with_virtual_webgl

pio.kaleido.scope.plotlyjs = plotlyjs
pio.kaleido.scope.topojson = "file://" + os.path.join(root, 'topojson', 'dist')
pio.defaults.plotlyjs = plotlyjs
pio.defaults.topojson = "file://" + os.path.join(root, 'topojson', 'dist')
pio.templates.default = 'none'

ALL_MOCKS = [os.path.splitext(a)[0] for a in os.listdir(dirIn) if a.endswith('.json')]
Expand All@@ -71,6 +77,11 @@
 'map_scattercluster',
 'map_fonts-supported-open-sans',
 'map_fonts-supported-open-sans-weight',
 'map_predefined-styles1', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'grid_subplot_types', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'map_fonts-supported-metropolis', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'map_fonts-supported-metropolis-italic', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'map_fonts-supported-metropolis-weight', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
]
allNames = [a for a in allNames if a not in blacklist]

Expand All@@ -79,55 +90,74 @@
 sys.exit(1)

failed = []
for name in allNames :
 outName = name
 if mathjax_version == 3 :
 outName = 'mathjax3___' + name

 print(outName)

 created = False

 MAX_RETRY = 2 # 1 means retry once
 for attempt in range(0, MAX_RETRY + 1) :
 with open(os.path.join(dirIn, name + '.json'), 'r') as _in :
 fig = json.load(_in)

 width = 700
 height = 500
 if 'layout' in fig :
 layout = fig['layout']
 if 'autosize' not in layout or layout['autosize'] != True :
 if 'width' in layout :
 width = layout['width']
 if 'height' in layout :
 height = layout['height']

 if 'b64' in sys.argv or 'b64=' in sys.argv or 'b64-json' in sys.argv :
 newFig = dict()
 arraysToB64(fig, newFig)
 fig = newFig
 if 'b64-json' in sys.argv and attempt == 0 : print(json.dumps(fig, indent = 2))

 try :
 pio.write_image(
 fig=fig,
 file=os.path.join(dirOut, outName + '.png'),
 width=width,
 height=height,
 validate=False
 )
 created = True
 except Exception as e :
 print(e)
 if attempt < MAX_RETRY :
 print('retry', attempt + 1, '/', MAX_RETRY)
 else :
 failed.append(outName)

 if(created) : break

if len(failed) > 0 :
 print('Failed at :')
 print(failed)
 sys.exit(1)

async def make_baselines_async():

 kopts = dict(
 plotlyjs=plotlyjs,
 )
 if mathjax is not None:
 kopts['mathjax'] = mathjax

 async with kaleido.Kaleido(n=1, **kopts) as k:
 for name in allNames:
 outName = name
 if mathjax_version == 3:
 outName = 'mathjax3___' + name

 print(outName)

 created = False

 MAX_RETRY = 2 # 1 means retry once
 for attempt in range(0, MAX_RETRY + 1) :
 with open(os.path.join(dirIn, name + '.json'), 'r') as _in :
 fig = json.load(_in)

 width = 700
 height = 500
 if 'layout' in fig :
 layout = fig['layout']
 if 'autosize' not in layout or layout['autosize'] != True :
 if 'width' in layout :
 width = layout['width']
 if 'height' in layout :
 height = layout['height']

 if 'b64' in sys.argv or 'b64=' in sys.argv or 'b64-json' in sys.argv :
 newFig = dict()
 arraysToB64(fig, newFig)
 fig = newFig
 if 'b64-json' in sys.argv and attempt == 0 : print(json.dumps(fig, indent = 2))

 try:
 bytes = await k.calc_fig(
 fig,
 path=None,
 opts=dict(
 format="png",
 width=width,
 height=height,
 ),
 )
 filename = os.path.join(dirOut, outName + '.png')
 with open(filename, "wb") as f:
 f.write(bytes)
 created = True
 except Exception as e:
 print(e)
 if attempt < MAX_RETRY :
 print('retry', attempt + 1, '/', MAX_RETRY)
 else :
 failed.append(outName)

 if(created): break

 if len(failed) > 0 :
 print('Failed at :')
 print(failed)
 sys.exit(1)


if __name__ == "__main__":
 asyncio.run(make_baselines_async())

2 changes: 1 addition & 1 deletion
test/image/make_exports.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@
 'zsmooth_methods',
 'fonts',
 'worldcup',
 'mathjax'
 'mathjax',
]

failed = 0
Expand Down

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

Skip to content
Try using Kaleido v1 for image tests#7412

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

emilykl
wants to merge
34
commits into

from

 Closed


Try using Kaleido v1 for image tests
#7412
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


34 commits


Select commit
Hold shift + click to select a range
9a078e3

try using Kaleido v1 for image tests


emilykl Apr 30, 2025
f7f5a03

Update Plotly version


emilykl May 2, 2025
5595393

Merge branch 'master' into use-new-kaleido-for-image-tests


emilykl May 27, 2025
afafaf2

update version


emilykl May 27, 2025
8c84e4b

update to new pio API and use unreleased Plotly and Kaleido


emilykl May 29, 2025
14298d8

typo


emilykl May 29, 2025
09a0f4f

install chrome for make-baselines jobs


emilykl May 29, 2025
94335b8

add apt-get update step


emilykl May 29, 2025
86f0a3e

does it work with '-browsers' images?


emilykl May 29, 2025
30c39f4

use cimg instead of circleci


emilykl May 30, 2025
279af99

use python instead of python3


emilykl May 30, 2025
ecb2c0c

Revert "use python instead of python3"


emilykl May 30, 2025
97b5f29

ensurepip


emilykl May 30, 2025
18f0a67

Revert "ensurepip"


emilykl May 30, 2025
3f13771

'python' rather than 'sudo python3'


emilykl May 30, 2025
fae9f08

try python3 without sudo


emilykl May 30, 2025
d0fa346

pip install requests


emilykl May 30, 2025
03a53b6

update kaleido ref


emilykl May 30, 2025
99eb4b5

temporarily blacklist 'gl3d_streamtube_reversed_ranges' baseline


emilykl May 30, 2025
fcafd40

temporarily blacklist 'mathjax' baseline


emilykl May 30, 2025
41172b3

temporarily blacklist 'map_predefined-styles2' baseline


emilykl May 30, 2025
0ec3ba1

remove eps from make_exports


emilykl May 30, 2025
ff45414

temporarily blacklist 'map_predefined-styles1' and 'grid_subplot_type…


emilykl May 30, 2025
340fd9e

temporarily blacklist 'map_fonts-supported-metropolis' baseline


emilykl May 30, 2025
4e518a2

typo


emilykl May 30, 2025
2011839

try with new kaleido with bugfix


emilykl Jun 2, 2025
80fe5cf

update kaleido version


emilykl Jun 2, 2025
5857a70

temporarily blacklist 'map_fonts-supported-open-sans-weight' baseline


emilykl Jun 2, 2025
53e26b9

typo


emilykl Jun 3, 2025
430b195

temporarily blacklist 'map_fonts-supported-metropolis-weight' baseline


emilykl Jun 3, 2025
6bab84d

use single Kaleido instance for making baselines (faster performance)


emilykl Jun 3, 2025
4d4d34f

commit new baselines with significant changes


emilykl Jun 4, 2025
86f5283

update plotly version in env_image.sh


emilykl Jun 4, 2025
9085ed5

Merge branch 'master' into use-new-kaleido-for-image-tests


emilykl Jul 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


40 changes: 35 additions & 5 deletions
.circleci/config.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,9 +217,15 @@ jobs:
 make-baselines-virtual-webgl:
 parallelism: 8
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand All@@ -236,9 +242,15 @@ jobs:

 make-baselines-mathjax3:
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand All@@ -256,9 +268,15 @@ jobs:
 make-baselines:
 parallelism: 12
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand All@@ -276,9 +294,15 @@ jobs:
 make-baselines-b64:
 parallelism: 12
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand DownExpand Up@@ -351,9 +375,15 @@ jobs:

 make-exports:
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand Down

6 changes: 3 additions & 3 deletions
.circleci/env_image.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
#!/bin/sh
set -e
python3 --version
# install required fonts
sudo apt-get install fonts-liberation2 fonts-open-sans fonts-noto-cjk fonts-noto-color-emoji

Expand All@@ -15,7 +16,6 @@ sudo apt install fontconfig
sudo fc-cache -f

# install kaleido & plotly
sudo python3 -m pip install kaleido==0.2.1 plotly==6.2.0 --progress-bar off

python -m pip install "plotly[kaleido]==6.2.0" --progress-bar off
# install numpy i.e. to convert arrays to typed arrays
sudo python3 -m pip install numpy==1.24.2
python3 -m pip install numpy==1.24.2
Binary file modifiedtest/image/baselines/font-decorline-scatter.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/funnel_horizontal_group_basic.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/indicator_scatter.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/legend_mathjax_title_and_items.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/mathjax.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/ternary-mathjax-title-place-subtitle.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/text_on_shapes_basic.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/world-cals.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

142 changes: 86 additions & 56 deletions
test/image/make_baseline.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
import asyncio
import os
import sys
import json

import plotly.io as pio
import kaleido

from convert_b64 import arraysToB64


args = []
if len(sys.argv) == 2 :
 args = sys.argv[1].split()
Expand All@@ -19,7 +24,7 @@
dirIn = os.path.join(root, 'test', 'image', 'mocks')
dirOut = os.path.join(root, 'build', 'test_images')

# N.B. equal is the falg to write to baselines not test_images
# N.B. equal is the flag to write to baselines not test_images

if '=' in args :
 args = args[args.index('=') + 1:]
Expand All@@ -31,11 +36,12 @@
print('output to', dirOut)

mathjax_version = 2
mathjax = None
if 'mathjax3' in sys.argv or 'mathjax3=' in sys.argv :
 # until https://github.com/plotly/Kaleido/issues/124 is addressed
 # we are uanble to use local mathjax v3 installed in node_modules
 # for now let's download it from the internet:
pio.kaleido.scope.mathjax = 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-svg.js'
 mathjax = 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-svg.js'
 mathjax_version = 3
 print('Kaleido using MathJax v3')

Expand All@@ -52,8 +58,8 @@

 plotlyjs = plotlyjs_with_virtual_webgl

pio.kaleido.scope.plotlyjs = plotlyjs
pio.kaleido.scope.topojson = "file://" + os.path.join(root, 'topojson', 'dist')
pio.defaults.plotlyjs = plotlyjs
pio.defaults.topojson = "file://" + os.path.join(root, 'topojson', 'dist')
pio.templates.default = 'none'

ALL_MOCKS = [os.path.splitext(a)[0] for a in os.listdir(dirIn) if a.endswith('.json')]
Expand All@@ -71,6 +77,11 @@
 'map_scattercluster',
 'map_fonts-supported-open-sans',
 'map_fonts-supported-open-sans-weight',
 'map_predefined-styles1', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'grid_subplot_types', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'map_fonts-supported-metropolis', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'map_fonts-supported-metropolis-italic', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'map_fonts-supported-metropolis-weight', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
]
allNames = [a for a in allNames if a not in blacklist]

Expand All@@ -79,55 +90,74 @@
 sys.exit(1)

failed = []
for name in allNames :
 outName = name
 if mathjax_version == 3 :
 outName = 'mathjax3___' + name

 print(outName)

 created = False

 MAX_RETRY = 2 # 1 means retry once
 for attempt in range(0, MAX_RETRY + 1) :
 with open(os.path.join(dirIn, name + '.json'), 'r') as _in :
 fig = json.load(_in)

 width = 700
 height = 500
 if 'layout' in fig :
 layout = fig['layout']
 if 'autosize' not in layout or layout['autosize'] != True :
 if 'width' in layout :
 width = layout['width']
 if 'height' in layout :
 height = layout['height']

 if 'b64' in sys.argv or 'b64=' in sys.argv or 'b64-json' in sys.argv :
 newFig = dict()
 arraysToB64(fig, newFig)
 fig = newFig
 if 'b64-json' in sys.argv and attempt == 0 : print(json.dumps(fig, indent = 2))

 try :
 pio.write_image(
 fig=fig,
 file=os.path.join(dirOut, outName + '.png'),
 width=width,
 height=height,
 validate=False
 )
 created = True
 except Exception as e :
 print(e)
 if attempt < MAX_RETRY :
 print('retry', attempt + 1, '/', MAX_RETRY)
 else :
 failed.append(outName)

 if(created) : break

if len(failed) > 0 :
 print('Failed at :')
 print(failed)
 sys.exit(1)

async def make_baselines_async():

 kopts = dict(
 plotlyjs=plotlyjs,
 )
 if mathjax is not None:
 kopts['mathjax'] = mathjax

 async with kaleido.Kaleido(n=1, **kopts) as k:
 for name in allNames:
 outName = name
 if mathjax_version == 3:
 outName = 'mathjax3___' + name

 print(outName)

 created = False

 MAX_RETRY = 2 # 1 means retry once
 for attempt in range(0, MAX_RETRY + 1) :
 with open(os.path.join(dirIn, name + '.json'), 'r') as _in :
 fig = json.load(_in)

 width = 700
 height = 500
 if 'layout' in fig :
 layout = fig['layout']
 if 'autosize' not in layout or layout['autosize'] != True :
 if 'width' in layout :
 width = layout['width']
 if 'height' in layout :
 height = layout['height']

 if 'b64' in sys.argv or 'b64=' in sys.argv or 'b64-json' in sys.argv :
 newFig = dict()
 arraysToB64(fig, newFig)
 fig = newFig
 if 'b64-json' in sys.argv and attempt == 0 : print(json.dumps(fig, indent = 2))

 try:
 bytes = await k.calc_fig(
 fig,
 path=None,
 opts=dict(
 format="png",
 width=width,
 height=height,
 ),
 )
 filename = os.path.join(dirOut, outName + '.png')
 with open(filename, "wb") as f:
 f.write(bytes)
 created = True
 except Exception as e:
 print(e)
 if attempt < MAX_RETRY :
 print('retry', attempt + 1, '/', MAX_RETRY)
 else :
 failed.append(outName)

 if(created): break

 if len(failed) > 0 :
 print('Failed at :')
 print(failed)
 sys.exit(1)


if __name__ == "__main__":
 asyncio.run(make_baselines_async())

2 changes: 1 addition & 1 deletion
test/image/make_exports.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@
 'zsmooth_methods',
 'fonts',
 'worldcup',
 'mathjax'
 'mathjax',
]

failed = 0
Expand Down

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

Skip to content
Try using Kaleido v1 for image tests#7412

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

emilykl
wants to merge
34
commits into

from

 Closed


Try using Kaleido v1 for image tests
#7412
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


34 commits


Select commit
Hold shift + click to select a range
9a078e3

try using Kaleido v1 for image tests


emilykl Apr 30, 2025
f7f5a03

Update Plotly version


emilykl May 2, 2025
5595393

Merge branch 'master' into use-new-kaleido-for-image-tests


emilykl May 27, 2025
afafaf2

update version


emilykl May 27, 2025
8c84e4b

update to new pio API and use unreleased Plotly and Kaleido


emilykl May 29, 2025
14298d8

typo


emilykl May 29, 2025
09a0f4f

install chrome for make-baselines jobs


emilykl May 29, 2025
94335b8

add apt-get update step


emilykl May 29, 2025
86f0a3e

does it work with '-browsers' images?


emilykl May 29, 2025
30c39f4

use cimg instead of circleci


emilykl May 30, 2025
279af99

use python instead of python3


emilykl May 30, 2025
ecb2c0c

Revert "use python instead of python3"


emilykl May 30, 2025
97b5f29

ensurepip


emilykl May 30, 2025
18f0a67

Revert "ensurepip"


emilykl May 30, 2025
3f13771

'python' rather than 'sudo python3'


emilykl May 30, 2025
fae9f08

try python3 without sudo


emilykl May 30, 2025
d0fa346

pip install requests


emilykl May 30, 2025
03a53b6

update kaleido ref


emilykl May 30, 2025
99eb4b5

temporarily blacklist 'gl3d_streamtube_reversed_ranges' baseline


emilykl May 30, 2025
fcafd40

temporarily blacklist 'mathjax' baseline


emilykl May 30, 2025
41172b3

temporarily blacklist 'map_predefined-styles2' baseline


emilykl May 30, 2025
0ec3ba1

remove eps from make_exports


emilykl May 30, 2025
ff45414

temporarily blacklist 'map_predefined-styles1' and 'grid_subplot_type…


emilykl May 30, 2025
340fd9e

temporarily blacklist 'map_fonts-supported-metropolis' baseline


emilykl May 30, 2025
4e518a2

typo


emilykl May 30, 2025
2011839

try with new kaleido with bugfix


emilykl Jun 2, 2025
80fe5cf

update kaleido version


emilykl Jun 2, 2025
5857a70

temporarily blacklist 'map_fonts-supported-open-sans-weight' baseline


emilykl Jun 2, 2025
53e26b9

typo


emilykl Jun 3, 2025
430b195

temporarily blacklist 'map_fonts-supported-metropolis-weight' baseline


emilykl Jun 3, 2025
6bab84d

use single Kaleido instance for making baselines (faster performance)


emilykl Jun 3, 2025
4d4d34f

commit new baselines with significant changes


emilykl Jun 4, 2025
86f5283

update plotly version in env_image.sh


emilykl Jun 4, 2025
9085ed5

Merge branch 'master' into use-new-kaleido-for-image-tests


emilykl Jul 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


40 changes: 35 additions & 5 deletions
.circleci/config.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,9 +217,15 @@ jobs:
 make-baselines-virtual-webgl:
 parallelism: 8
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand All@@ -236,9 +242,15 @@ jobs:

 make-baselines-mathjax3:
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand All@@ -256,9 +268,15 @@ jobs:
 make-baselines:
 parallelism: 12
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand All@@ -276,9 +294,15 @@ jobs:
 make-baselines-b64:
 parallelism: 12
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand DownExpand Up@@ -351,9 +375,15 @@ jobs:

 make-exports:
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand Down

6 changes: 3 additions & 3 deletions
.circleci/env_image.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
#!/bin/sh
set -e
python3 --version
# install required fonts
sudo apt-get install fonts-liberation2 fonts-open-sans fonts-noto-cjk fonts-noto-color-emoji

Expand All@@ -15,7 +16,6 @@ sudo apt install fontconfig
sudo fc-cache -f

# install kaleido & plotly
sudo python3 -m pip install kaleido==0.2.1 plotly==6.2.0 --progress-bar off

python -m pip install "plotly[kaleido]==6.2.0" --progress-bar off
# install numpy i.e. to convert arrays to typed arrays
sudo python3 -m pip install numpy==1.24.2
python3 -m pip install numpy==1.24.2
Binary file modifiedtest/image/baselines/font-decorline-scatter.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/funnel_horizontal_group_basic.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/indicator_scatter.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/legend_mathjax_title_and_items.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/mathjax.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/ternary-mathjax-title-place-subtitle.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/text_on_shapes_basic.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/world-cals.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

142 changes: 86 additions & 56 deletions
test/image/make_baseline.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
import asyncio
import os
import sys
import json

import plotly.io as pio
import kaleido

from convert_b64 import arraysToB64


args = []
if len(sys.argv) == 2 :
 args = sys.argv[1].split()
Expand All@@ -19,7 +24,7 @@
dirIn = os.path.join(root, 'test', 'image', 'mocks')
dirOut = os.path.join(root, 'build', 'test_images')

# N.B. equal is the falg to write to baselines not test_images
# N.B. equal is the flag to write to baselines not test_images

if '=' in args :
 args = args[args.index('=') + 1:]
Expand All@@ -31,11 +36,12 @@
print('output to', dirOut)

mathjax_version = 2
mathjax = None
if 'mathjax3' in sys.argv or 'mathjax3=' in sys.argv :
 # until https://github.com/plotly/Kaleido/issues/124 is addressed
 # we are uanble to use local mathjax v3 installed in node_modules
 # for now let's download it from the internet:
pio.kaleido.scope.mathjax = 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-svg.js'
 mathjax = 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-svg.js'
 mathjax_version = 3
 print('Kaleido using MathJax v3')

Expand All@@ -52,8 +58,8 @@

 plotlyjs = plotlyjs_with_virtual_webgl

pio.kaleido.scope.plotlyjs = plotlyjs
pio.kaleido.scope.topojson = "file://" + os.path.join(root, 'topojson', 'dist')
pio.defaults.plotlyjs = plotlyjs
pio.defaults.topojson = "file://" + os.path.join(root, 'topojson', 'dist')
pio.templates.default = 'none'

ALL_MOCKS = [os.path.splitext(a)[0] for a in os.listdir(dirIn) if a.endswith('.json')]
Expand All@@ -71,6 +77,11 @@
 'map_scattercluster',
 'map_fonts-supported-open-sans',
 'map_fonts-supported-open-sans-weight',
 'map_predefined-styles1', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'grid_subplot_types', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'map_fonts-supported-metropolis', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'map_fonts-supported-metropolis-italic', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'map_fonts-supported-metropolis-weight', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
]
allNames = [a for a in allNames if a not in blacklist]

Expand All@@ -79,55 +90,74 @@
 sys.exit(1)

failed = []
for name in allNames :
 outName = name
 if mathjax_version == 3 :
 outName = 'mathjax3___' + name

 print(outName)

 created = False

 MAX_RETRY = 2 # 1 means retry once
 for attempt in range(0, MAX_RETRY + 1) :
 with open(os.path.join(dirIn, name + '.json'), 'r') as _in :
 fig = json.load(_in)

 width = 700
 height = 500
 if 'layout' in fig :
 layout = fig['layout']
 if 'autosize' not in layout or layout['autosize'] != True :
 if 'width' in layout :
 width = layout['width']
 if 'height' in layout :
 height = layout['height']

 if 'b64' in sys.argv or 'b64=' in sys.argv or 'b64-json' in sys.argv :
 newFig = dict()
 arraysToB64(fig, newFig)
 fig = newFig
 if 'b64-json' in sys.argv and attempt == 0 : print(json.dumps(fig, indent = 2))

 try :
 pio.write_image(
 fig=fig,
 file=os.path.join(dirOut, outName + '.png'),
 width=width,
 height=height,
 validate=False
 )
 created = True
 except Exception as e :
 print(e)
 if attempt < MAX_RETRY :
 print('retry', attempt + 1, '/', MAX_RETRY)
 else :
 failed.append(outName)

 if(created) : break

if len(failed) > 0 :
 print('Failed at :')
 print(failed)
 sys.exit(1)

async def make_baselines_async():

 kopts = dict(
 plotlyjs=plotlyjs,
 )
 if mathjax is not None:
 kopts['mathjax'] = mathjax

 async with kaleido.Kaleido(n=1, **kopts) as k:
 for name in allNames:
 outName = name
 if mathjax_version == 3:
 outName = 'mathjax3___' + name

 print(outName)

 created = False

 MAX_RETRY = 2 # 1 means retry once
 for attempt in range(0, MAX_RETRY + 1) :
 with open(os.path.join(dirIn, name + '.json'), 'r') as _in :
 fig = json.load(_in)

 width = 700
 height = 500
 if 'layout' in fig :
 layout = fig['layout']
 if 'autosize' not in layout or layout['autosize'] != True :
 if 'width' in layout :
 width = layout['width']
 if 'height' in layout :
 height = layout['height']

 if 'b64' in sys.argv or 'b64=' in sys.argv or 'b64-json' in sys.argv :
 newFig = dict()
 arraysToB64(fig, newFig)
 fig = newFig
 if 'b64-json' in sys.argv and attempt == 0 : print(json.dumps(fig, indent = 2))

 try:
 bytes = await k.calc_fig(
 fig,
 path=None,
 opts=dict(
 format="png",
 width=width,
 height=height,
 ),
 )
 filename = os.path.join(dirOut, outName + '.png')
 with open(filename, "wb") as f:
 f.write(bytes)
 created = True
 except Exception as e:
 print(e)
 if attempt < MAX_RETRY :
 print('retry', attempt + 1, '/', MAX_RETRY)
 else :
 failed.append(outName)

 if(created): break

 if len(failed) > 0 :
 print('Failed at :')
 print(failed)
 sys.exit(1)


if __name__ == "__main__":
 asyncio.run(make_baselines_async())

2 changes: 1 addition & 1 deletion
test/image/make_exports.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@
 'zsmooth_methods',
 'fonts',
 'worldcup',
 'mathjax'
 'mathjax',
]

failed = 0
Expand Down

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

Skip to content
Try using Kaleido v1 for image tests#7412

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

emilykl
wants to merge
34
commits into

from

 Closed


Try using Kaleido v1 for image tests
#7412
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


34 commits


Select commit
Hold shift + click to select a range
9a078e3

try using Kaleido v1 for image tests


emilykl Apr 30, 2025
f7f5a03

Update Plotly version


emilykl May 2, 2025
5595393

Merge branch 'master' into use-new-kaleido-for-image-tests


emilykl May 27, 2025
afafaf2

update version


emilykl May 27, 2025
8c84e4b

update to new pio API and use unreleased Plotly and Kaleido


emilykl May 29, 2025
14298d8

typo


emilykl May 29, 2025
09a0f4f

install chrome for make-baselines jobs


emilykl May 29, 2025
94335b8

add apt-get update step


emilykl May 29, 2025
86f0a3e

does it work with '-browsers' images?


emilykl May 29, 2025
30c39f4

use cimg instead of circleci


emilykl May 30, 2025
279af99

use python instead of python3


emilykl May 30, 2025
ecb2c0c

Revert "use python instead of python3"


emilykl May 30, 2025
97b5f29

ensurepip


emilykl May 30, 2025
18f0a67

Revert "ensurepip"


emilykl May 30, 2025
3f13771

'python' rather than 'sudo python3'


emilykl May 30, 2025
fae9f08

try python3 without sudo


emilykl May 30, 2025
d0fa346

pip install requests


emilykl May 30, 2025
03a53b6

update kaleido ref


emilykl May 30, 2025
99eb4b5

temporarily blacklist 'gl3d_streamtube_reversed_ranges' baseline


emilykl May 30, 2025
fcafd40

temporarily blacklist 'mathjax' baseline


emilykl May 30, 2025
41172b3

temporarily blacklist 'map_predefined-styles2' baseline


emilykl May 30, 2025
0ec3ba1

remove eps from make_exports


emilykl May 30, 2025
ff45414

temporarily blacklist 'map_predefined-styles1' and 'grid_subplot_type…


emilykl May 30, 2025
340fd9e

temporarily blacklist 'map_fonts-supported-metropolis' baseline


emilykl May 30, 2025
4e518a2

typo


emilykl May 30, 2025
2011839

try with new kaleido with bugfix


emilykl Jun 2, 2025
80fe5cf

update kaleido version


emilykl Jun 2, 2025
5857a70

temporarily blacklist 'map_fonts-supported-open-sans-weight' baseline


emilykl Jun 2, 2025
53e26b9

typo


emilykl Jun 3, 2025
430b195

temporarily blacklist 'map_fonts-supported-metropolis-weight' baseline


emilykl Jun 3, 2025
6bab84d

use single Kaleido instance for making baselines (faster performance)


emilykl Jun 3, 2025
4d4d34f

commit new baselines with significant changes


emilykl Jun 4, 2025
86f5283

update plotly version in env_image.sh


emilykl Jun 4, 2025
9085ed5

Merge branch 'master' into use-new-kaleido-for-image-tests


emilykl Jul 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


40 changes: 35 additions & 5 deletions
.circleci/config.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,9 +217,15 @@ jobs:
 make-baselines-virtual-webgl:
 parallelism: 8
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand All@@ -236,9 +242,15 @@ jobs:

 make-baselines-mathjax3:
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand All@@ -256,9 +268,15 @@ jobs:
 make-baselines:
 parallelism: 12
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand All@@ -276,9 +294,15 @@ jobs:
 make-baselines-b64:
 parallelism: 12
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand DownExpand Up@@ -351,9 +375,15 @@ jobs:

 make-exports:
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand Down

6 changes: 3 additions & 3 deletions
.circleci/env_image.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
#!/bin/sh
set -e
python3 --version
# install required fonts
sudo apt-get install fonts-liberation2 fonts-open-sans fonts-noto-cjk fonts-noto-color-emoji

Expand All@@ -15,7 +16,6 @@ sudo apt install fontconfig
sudo fc-cache -f

# install kaleido & plotly
sudo python3 -m pip install kaleido==0.2.1 plotly==6.2.0 --progress-bar off

python -m pip install "plotly[kaleido]==6.2.0" --progress-bar off
# install numpy i.e. to convert arrays to typed arrays
sudo python3 -m pip install numpy==1.24.2
python3 -m pip install numpy==1.24.2
Binary file modifiedtest/image/baselines/font-decorline-scatter.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/funnel_horizontal_group_basic.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/indicator_scatter.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/legend_mathjax_title_and_items.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/mathjax.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/ternary-mathjax-title-place-subtitle.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/text_on_shapes_basic.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/world-cals.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

142 changes: 86 additions & 56 deletions
test/image/make_baseline.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
import asyncio
import os
import sys
import json

import plotly.io as pio
import kaleido

from convert_b64 import arraysToB64


args = []
if len(sys.argv) == 2 :
 args = sys.argv[1].split()
Expand All@@ -19,7 +24,7 @@
dirIn = os.path.join(root, 'test', 'image', 'mocks')
dirOut = os.path.join(root, 'build', 'test_images')

# N.B. equal is the falg to write to baselines not test_images
# N.B. equal is the flag to write to baselines not test_images

if '=' in args :
 args = args[args.index('=') + 1:]
Expand All@@ -31,11 +36,12 @@
print('output to', dirOut)

mathjax_version = 2
mathjax = None
if 'mathjax3' in sys.argv or 'mathjax3=' in sys.argv :
 # until https://github.com/plotly/Kaleido/issues/124 is addressed
 # we are uanble to use local mathjax v3 installed in node_modules
 # for now let's download it from the internet:
pio.kaleido.scope.mathjax = 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-svg.js'
 mathjax = 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-svg.js'
 mathjax_version = 3
 print('Kaleido using MathJax v3')

Expand All@@ -52,8 +58,8 @@

 plotlyjs = plotlyjs_with_virtual_webgl

pio.kaleido.scope.plotlyjs = plotlyjs
pio.kaleido.scope.topojson = "file://" + os.path.join(root, 'topojson', 'dist')
pio.defaults.plotlyjs = plotlyjs
pio.defaults.topojson = "file://" + os.path.join(root, 'topojson', 'dist')
pio.templates.default = 'none'

ALL_MOCKS = [os.path.splitext(a)[0] for a in os.listdir(dirIn) if a.endswith('.json')]
Expand All@@ -71,6 +77,11 @@
 'map_scattercluster',
 'map_fonts-supported-open-sans',
 'map_fonts-supported-open-sans-weight',
 'map_predefined-styles1', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'grid_subplot_types', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'map_fonts-supported-metropolis', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'map_fonts-supported-metropolis-italic', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'map_fonts-supported-metropolis-weight', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
]
allNames = [a for a in allNames if a not in blacklist]

Expand All@@ -79,55 +90,74 @@
 sys.exit(1)

failed = []
for name in allNames :
 outName = name
 if mathjax_version == 3 :
 outName = 'mathjax3___' + name

 print(outName)

 created = False

 MAX_RETRY = 2 # 1 means retry once
 for attempt in range(0, MAX_RETRY + 1) :
 with open(os.path.join(dirIn, name + '.json'), 'r') as _in :
 fig = json.load(_in)

 width = 700
 height = 500
 if 'layout' in fig :
 layout = fig['layout']
 if 'autosize' not in layout or layout['autosize'] != True :
 if 'width' in layout :
 width = layout['width']
 if 'height' in layout :
 height = layout['height']

 if 'b64' in sys.argv or 'b64=' in sys.argv or 'b64-json' in sys.argv :
 newFig = dict()
 arraysToB64(fig, newFig)
 fig = newFig
 if 'b64-json' in sys.argv and attempt == 0 : print(json.dumps(fig, indent = 2))

 try :
 pio.write_image(
 fig=fig,
 file=os.path.join(dirOut, outName + '.png'),
 width=width,
 height=height,
 validate=False
 )
 created = True
 except Exception as e :
 print(e)
 if attempt < MAX_RETRY :
 print('retry', attempt + 1, '/', MAX_RETRY)
 else :
 failed.append(outName)

 if(created) : break

if len(failed) > 0 :
 print('Failed at :')
 print(failed)
 sys.exit(1)

async def make_baselines_async():

 kopts = dict(
 plotlyjs=plotlyjs,
 )
 if mathjax is not None:
 kopts['mathjax'] = mathjax

 async with kaleido.Kaleido(n=1, **kopts) as k:
 for name in allNames:
 outName = name
 if mathjax_version == 3:
 outName = 'mathjax3___' + name

 print(outName)

 created = False

 MAX_RETRY = 2 # 1 means retry once
 for attempt in range(0, MAX_RETRY + 1) :
 with open(os.path.join(dirIn, name + '.json'), 'r') as _in :
 fig = json.load(_in)

 width = 700
 height = 500
 if 'layout' in fig :
 layout = fig['layout']
 if 'autosize' not in layout or layout['autosize'] != True :
 if 'width' in layout :
 width = layout['width']
 if 'height' in layout :
 height = layout['height']

 if 'b64' in sys.argv or 'b64=' in sys.argv or 'b64-json' in sys.argv :
 newFig = dict()
 arraysToB64(fig, newFig)
 fig = newFig
 if 'b64-json' in sys.argv and attempt == 0 : print(json.dumps(fig, indent = 2))

 try:
 bytes = await k.calc_fig(
 fig,
 path=None,
 opts=dict(
 format="png",
 width=width,
 height=height,
 ),
 )
 filename = os.path.join(dirOut, outName + '.png')
 with open(filename, "wb") as f:
 f.write(bytes)
 created = True
 except Exception as e:
 print(e)
 if attempt < MAX_RETRY :
 print('retry', attempt + 1, '/', MAX_RETRY)
 else :
 failed.append(outName)

 if(created): break

 if len(failed) > 0 :
 print('Failed at :')
 print(failed)
 sys.exit(1)


if __name__ == "__main__":
 asyncio.run(make_baselines_async())

2 changes: 1 addition & 1 deletion
test/image/make_exports.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@
 'zsmooth_methods',
 'fonts',
 'worldcup',
 'mathjax'
 'mathjax',
]

failed = 0
Expand Down

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

Skip to content
Try using Kaleido v1 for image tests#7412

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

emilykl
wants to merge
34
commits into

from

 Closed


Try using Kaleido v1 for image tests
#7412
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


34 commits


Select commit
Hold shift + click to select a range
9a078e3

try using Kaleido v1 for image tests


emilykl Apr 30, 2025
f7f5a03

Update Plotly version


emilykl May 2, 2025
5595393

Merge branch 'master' into use-new-kaleido-for-image-tests


emilykl May 27, 2025
afafaf2

update version


emilykl May 27, 2025
8c84e4b

update to new pio API and use unreleased Plotly and Kaleido


emilykl May 29, 2025
14298d8

typo


emilykl May 29, 2025
09a0f4f

install chrome for make-baselines jobs


emilykl May 29, 2025
94335b8

add apt-get update step


emilykl May 29, 2025
86f0a3e

does it work with '-browsers' images?


emilykl May 29, 2025
30c39f4

use cimg instead of circleci


emilykl May 30, 2025
279af99

use python instead of python3


emilykl May 30, 2025
ecb2c0c

Revert "use python instead of python3"


emilykl May 30, 2025
97b5f29

ensurepip


emilykl May 30, 2025
18f0a67

Revert "ensurepip"


emilykl May 30, 2025
3f13771

'python' rather than 'sudo python3'


emilykl May 30, 2025
fae9f08

try python3 without sudo


emilykl May 30, 2025
d0fa346

pip install requests


emilykl May 30, 2025
03a53b6

update kaleido ref


emilykl May 30, 2025
99eb4b5

temporarily blacklist 'gl3d_streamtube_reversed_ranges' baseline


emilykl May 30, 2025
fcafd40

temporarily blacklist 'mathjax' baseline


emilykl May 30, 2025
41172b3

temporarily blacklist 'map_predefined-styles2' baseline


emilykl May 30, 2025
0ec3ba1

remove eps from make_exports


emilykl May 30, 2025
ff45414

temporarily blacklist 'map_predefined-styles1' and 'grid_subplot_type…


emilykl May 30, 2025
340fd9e

temporarily blacklist 'map_fonts-supported-metropolis' baseline


emilykl May 30, 2025
4e518a2

typo


emilykl May 30, 2025
2011839

try with new kaleido with bugfix


emilykl Jun 2, 2025
80fe5cf

update kaleido version


emilykl Jun 2, 2025
5857a70

temporarily blacklist 'map_fonts-supported-open-sans-weight' baseline


emilykl Jun 2, 2025
53e26b9

typo


emilykl Jun 3, 2025
430b195

temporarily blacklist 'map_fonts-supported-metropolis-weight' baseline


emilykl Jun 3, 2025
6bab84d

use single Kaleido instance for making baselines (faster performance)


emilykl Jun 3, 2025
4d4d34f

commit new baselines with significant changes


emilykl Jun 4, 2025
86f5283

update plotly version in env_image.sh


emilykl Jun 4, 2025
9085ed5

Merge branch 'master' into use-new-kaleido-for-image-tests


emilykl Jul 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


40 changes: 35 additions & 5 deletions
.circleci/config.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,9 +217,15 @@ jobs:
 make-baselines-virtual-webgl:
 parallelism: 8
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand All@@ -236,9 +242,15 @@ jobs:

 make-baselines-mathjax3:
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand All@@ -256,9 +268,15 @@ jobs:
 make-baselines:
 parallelism: 12
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand All@@ -276,9 +294,15 @@ jobs:
 make-baselines-b64:
 parallelism: 12
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand DownExpand Up@@ -351,9 +375,15 @@ jobs:

 make-exports:
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand Down

6 changes: 3 additions & 3 deletions
.circleci/env_image.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
#!/bin/sh
set -e
python3 --version
# install required fonts
sudo apt-get install fonts-liberation2 fonts-open-sans fonts-noto-cjk fonts-noto-color-emoji

Expand All@@ -15,7 +16,6 @@ sudo apt install fontconfig
sudo fc-cache -f

# install kaleido & plotly
sudo python3 -m pip install kaleido==0.2.1 plotly==6.2.0 --progress-bar off

python -m pip install "plotly[kaleido]==6.2.0" --progress-bar off
# install numpy i.e. to convert arrays to typed arrays
sudo python3 -m pip install numpy==1.24.2
python3 -m pip install numpy==1.24.2
Binary file modifiedtest/image/baselines/font-decorline-scatter.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/funnel_horizontal_group_basic.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/indicator_scatter.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/legend_mathjax_title_and_items.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/mathjax.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/ternary-mathjax-title-place-subtitle.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/text_on_shapes_basic.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/world-cals.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

142 changes: 86 additions & 56 deletions
test/image/make_baseline.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
import asyncio
import os
import sys
import json

import plotly.io as pio
import kaleido

from convert_b64 import arraysToB64


args = []
if len(sys.argv) == 2 :
 args = sys.argv[1].split()
Expand All@@ -19,7 +24,7 @@
dirIn = os.path.join(root, 'test', 'image', 'mocks')
dirOut = os.path.join(root, 'build', 'test_images')

# N.B. equal is the falg to write to baselines not test_images
# N.B. equal is the flag to write to baselines not test_images

if '=' in args :
 args = args[args.index('=') + 1:]
Expand All@@ -31,11 +36,12 @@
print('output to', dirOut)

mathjax_version = 2
mathjax = None
if 'mathjax3' in sys.argv or 'mathjax3=' in sys.argv :
 # until https://github.com/plotly/Kaleido/issues/124 is addressed
 # we are uanble to use local mathjax v3 installed in node_modules
 # for now let's download it from the internet:
pio.kaleido.scope.mathjax = 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-svg.js'
 mathjax = 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-svg.js'
 mathjax_version = 3
 print('Kaleido using MathJax v3')

Expand All@@ -52,8 +58,8 @@

 plotlyjs = plotlyjs_with_virtual_webgl

pio.kaleido.scope.plotlyjs = plotlyjs
pio.kaleido.scope.topojson = "file://" + os.path.join(root, 'topojson', 'dist')
pio.defaults.plotlyjs = plotlyjs
pio.defaults.topojson = "file://" + os.path.join(root, 'topojson', 'dist')
pio.templates.default = 'none'

ALL_MOCKS = [os.path.splitext(a)[0] for a in os.listdir(dirIn) if a.endswith('.json')]
Expand All@@ -71,6 +77,11 @@
 'map_scattercluster',
 'map_fonts-supported-open-sans',
 'map_fonts-supported-open-sans-weight',
 'map_predefined-styles1', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'grid_subplot_types', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'map_fonts-supported-metropolis', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'map_fonts-supported-metropolis-italic', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'map_fonts-supported-metropolis-weight', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
]
allNames = [a for a in allNames if a not in blacklist]

Expand All@@ -79,55 +90,74 @@
 sys.exit(1)

failed = []
for name in allNames :
 outName = name
 if mathjax_version == 3 :
 outName = 'mathjax3___' + name

 print(outName)

 created = False

 MAX_RETRY = 2 # 1 means retry once
 for attempt in range(0, MAX_RETRY + 1) :
 with open(os.path.join(dirIn, name + '.json'), 'r') as _in :
 fig = json.load(_in)

 width = 700
 height = 500
 if 'layout' in fig :
 layout = fig['layout']
 if 'autosize' not in layout or layout['autosize'] != True :
 if 'width' in layout :
 width = layout['width']
 if 'height' in layout :
 height = layout['height']

 if 'b64' in sys.argv or 'b64=' in sys.argv or 'b64-json' in sys.argv :
 newFig = dict()
 arraysToB64(fig, newFig)
 fig = newFig
 if 'b64-json' in sys.argv and attempt == 0 : print(json.dumps(fig, indent = 2))

 try :
 pio.write_image(
 fig=fig,
 file=os.path.join(dirOut, outName + '.png'),
 width=width,
 height=height,
 validate=False
 )
 created = True
 except Exception as e :
 print(e)
 if attempt < MAX_RETRY :
 print('retry', attempt + 1, '/', MAX_RETRY)
 else :
 failed.append(outName)

 if(created) : break

if len(failed) > 0 :
 print('Failed at :')
 print(failed)
 sys.exit(1)

async def make_baselines_async():

 kopts = dict(
 plotlyjs=plotlyjs,
 )
 if mathjax is not None:
 kopts['mathjax'] = mathjax

 async with kaleido.Kaleido(n=1, **kopts) as k:
 for name in allNames:
 outName = name
 if mathjax_version == 3:
 outName = 'mathjax3___' + name

 print(outName)

 created = False

 MAX_RETRY = 2 # 1 means retry once
 for attempt in range(0, MAX_RETRY + 1) :
 with open(os.path.join(dirIn, name + '.json'), 'r') as _in :
 fig = json.load(_in)

 width = 700
 height = 500
 if 'layout' in fig :
 layout = fig['layout']
 if 'autosize' not in layout or layout['autosize'] != True :
 if 'width' in layout :
 width = layout['width']
 if 'height' in layout :
 height = layout['height']

 if 'b64' in sys.argv or 'b64=' in sys.argv or 'b64-json' in sys.argv :
 newFig = dict()
 arraysToB64(fig, newFig)
 fig = newFig
 if 'b64-json' in sys.argv and attempt == 0 : print(json.dumps(fig, indent = 2))

 try:
 bytes = await k.calc_fig(
 fig,
 path=None,
 opts=dict(
 format="png",
 width=width,
 height=height,
 ),
 )
 filename = os.path.join(dirOut, outName + '.png')
 with open(filename, "wb") as f:
 f.write(bytes)
 created = True
 except Exception as e:
 print(e)
 if attempt < MAX_RETRY :
 print('retry', attempt + 1, '/', MAX_RETRY)
 else :
 failed.append(outName)

 if(created): break

 if len(failed) > 0 :
 print('Failed at :')
 print(failed)
 sys.exit(1)


if __name__ == "__main__":
 asyncio.run(make_baselines_async())

2 changes: 1 addition & 1 deletion
test/image/make_exports.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@
 'zsmooth_methods',
 'fonts',
 'worldcup',
 'mathjax'
 'mathjax',
]

failed = 0
Expand Down

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

Skip to content
Try using Kaleido v1 for image tests#7412

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

emilykl
wants to merge
34
commits into

from

 Closed


Try using Kaleido v1 for image tests
#7412
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


34 commits


Select commit
Hold shift + click to select a range
9a078e3

try using Kaleido v1 for image tests


emilykl Apr 30, 2025
f7f5a03

Update Plotly version


emilykl May 2, 2025
5595393

Merge branch 'master' into use-new-kaleido-for-image-tests


emilykl May 27, 2025
afafaf2

update version


emilykl May 27, 2025
8c84e4b

update to new pio API and use unreleased Plotly and Kaleido


emilykl May 29, 2025
14298d8

typo


emilykl May 29, 2025
09a0f4f

install chrome for make-baselines jobs


emilykl May 29, 2025
94335b8

add apt-get update step


emilykl May 29, 2025
86f0a3e

does it work with '-browsers' images?


emilykl May 29, 2025
30c39f4

use cimg instead of circleci


emilykl May 30, 2025
279af99

use python instead of python3


emilykl May 30, 2025
ecb2c0c

Revert "use python instead of python3"


emilykl May 30, 2025
97b5f29

ensurepip


emilykl May 30, 2025
18f0a67

Revert "ensurepip"


emilykl May 30, 2025
3f13771

'python' rather than 'sudo python3'


emilykl May 30, 2025
fae9f08

try python3 without sudo


emilykl May 30, 2025
d0fa346

pip install requests


emilykl May 30, 2025
03a53b6

update kaleido ref


emilykl May 30, 2025
99eb4b5

temporarily blacklist 'gl3d_streamtube_reversed_ranges' baseline


emilykl May 30, 2025
fcafd40

temporarily blacklist 'mathjax' baseline


emilykl May 30, 2025
41172b3

temporarily blacklist 'map_predefined-styles2' baseline


emilykl May 30, 2025
0ec3ba1

remove eps from make_exports


emilykl May 30, 2025
ff45414

temporarily blacklist 'map_predefined-styles1' and 'grid_subplot_type…


emilykl May 30, 2025
340fd9e

temporarily blacklist 'map_fonts-supported-metropolis' baseline


emilykl May 30, 2025
4e518a2

typo


emilykl May 30, 2025
2011839

try with new kaleido with bugfix


emilykl Jun 2, 2025
80fe5cf

update kaleido version


emilykl Jun 2, 2025
5857a70

temporarily blacklist 'map_fonts-supported-open-sans-weight' baseline


emilykl Jun 2, 2025
53e26b9

typo


emilykl Jun 3, 2025
430b195

temporarily blacklist 'map_fonts-supported-metropolis-weight' baseline


emilykl Jun 3, 2025
6bab84d

use single Kaleido instance for making baselines (faster performance)


emilykl Jun 3, 2025
4d4d34f

commit new baselines with significant changes


emilykl Jun 4, 2025
86f5283

update plotly version in env_image.sh


emilykl Jun 4, 2025
9085ed5

Merge branch 'master' into use-new-kaleido-for-image-tests


emilykl Jul 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


40 changes: 35 additions & 5 deletions
.circleci/config.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,9 +217,15 @@ jobs:
 make-baselines-virtual-webgl:
 parallelism: 8
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand All@@ -236,9 +242,15 @@ jobs:

 make-baselines-mathjax3:
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand All@@ -256,9 +268,15 @@ jobs:
 make-baselines:
 parallelism: 12
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand All@@ -276,9 +294,15 @@ jobs:
 make-baselines-b64:
 parallelism: 12
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand DownExpand Up@@ -351,9 +375,15 @@ jobs:

 make-exports:
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand Down

6 changes: 3 additions & 3 deletions
.circleci/env_image.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
#!/bin/sh
set -e
python3 --version
# install required fonts
sudo apt-get install fonts-liberation2 fonts-open-sans fonts-noto-cjk fonts-noto-color-emoji

Expand All@@ -15,7 +16,6 @@ sudo apt install fontconfig
sudo fc-cache -f

# install kaleido & plotly
sudo python3 -m pip install kaleido==0.2.1 plotly==6.2.0 --progress-bar off

python -m pip install "plotly[kaleido]==6.2.0" --progress-bar off
# install numpy i.e. to convert arrays to typed arrays
sudo python3 -m pip install numpy==1.24.2
python3 -m pip install numpy==1.24.2
Binary file modifiedtest/image/baselines/font-decorline-scatter.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/funnel_horizontal_group_basic.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/indicator_scatter.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/legend_mathjax_title_and_items.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/mathjax.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/ternary-mathjax-title-place-subtitle.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/text_on_shapes_basic.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/world-cals.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

142 changes: 86 additions & 56 deletions
test/image/make_baseline.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
import asyncio
import os
import sys
import json

import plotly.io as pio
import kaleido

from convert_b64 import arraysToB64


args = []
if len(sys.argv) == 2 :
 args = sys.argv[1].split()
Expand All@@ -19,7 +24,7 @@
dirIn = os.path.join(root, 'test', 'image', 'mocks')
dirOut = os.path.join(root, 'build', 'test_images')

# N.B. equal is the falg to write to baselines not test_images
# N.B. equal is the flag to write to baselines not test_images

if '=' in args :
 args = args[args.index('=') + 1:]
Expand All@@ -31,11 +36,12 @@
print('output to', dirOut)

mathjax_version = 2
mathjax = None
if 'mathjax3' in sys.argv or 'mathjax3=' in sys.argv :
 # until https://github.com/plotly/Kaleido/issues/124 is addressed
 # we are uanble to use local mathjax v3 installed in node_modules
 # for now let's download it from the internet:
pio.kaleido.scope.mathjax = 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-svg.js'
 mathjax = 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-svg.js'
 mathjax_version = 3
 print('Kaleido using MathJax v3')

Expand All@@ -52,8 +58,8 @@

 plotlyjs = plotlyjs_with_virtual_webgl

pio.kaleido.scope.plotlyjs = plotlyjs
pio.kaleido.scope.topojson = "file://" + os.path.join(root, 'topojson', 'dist')
pio.defaults.plotlyjs = plotlyjs
pio.defaults.topojson = "file://" + os.path.join(root, 'topojson', 'dist')
pio.templates.default = 'none'

ALL_MOCKS = [os.path.splitext(a)[0] for a in os.listdir(dirIn) if a.endswith('.json')]
Expand All@@ -71,6 +77,11 @@
 'map_scattercluster',
 'map_fonts-supported-open-sans',
 'map_fonts-supported-open-sans-weight',
 'map_predefined-styles1', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'grid_subplot_types', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'map_fonts-supported-metropolis', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'map_fonts-supported-metropolis-italic', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'map_fonts-supported-metropolis-weight', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
]
allNames = [a for a in allNames if a not in blacklist]

Expand All@@ -79,55 +90,74 @@
 sys.exit(1)

failed = []
for name in allNames :
 outName = name
 if mathjax_version == 3 :
 outName = 'mathjax3___' + name

 print(outName)

 created = False

 MAX_RETRY = 2 # 1 means retry once
 for attempt in range(0, MAX_RETRY + 1) :
 with open(os.path.join(dirIn, name + '.json'), 'r') as _in :
 fig = json.load(_in)

 width = 700
 height = 500
 if 'layout' in fig :
 layout = fig['layout']
 if 'autosize' not in layout or layout['autosize'] != True :
 if 'width' in layout :
 width = layout['width']
 if 'height' in layout :
 height = layout['height']

 if 'b64' in sys.argv or 'b64=' in sys.argv or 'b64-json' in sys.argv :
 newFig = dict()
 arraysToB64(fig, newFig)
 fig = newFig
 if 'b64-json' in sys.argv and attempt == 0 : print(json.dumps(fig, indent = 2))

 try :
 pio.write_image(
 fig=fig,
 file=os.path.join(dirOut, outName + '.png'),
 width=width,
 height=height,
 validate=False
 )
 created = True
 except Exception as e :
 print(e)
 if attempt < MAX_RETRY :
 print('retry', attempt + 1, '/', MAX_RETRY)
 else :
 failed.append(outName)

 if(created) : break

if len(failed) > 0 :
 print('Failed at :')
 print(failed)
 sys.exit(1)

async def make_baselines_async():

 kopts = dict(
 plotlyjs=plotlyjs,
 )
 if mathjax is not None:
 kopts['mathjax'] = mathjax

 async with kaleido.Kaleido(n=1, **kopts) as k:
 for name in allNames:
 outName = name
 if mathjax_version == 3:
 outName = 'mathjax3___' + name

 print(outName)

 created = False

 MAX_RETRY = 2 # 1 means retry once
 for attempt in range(0, MAX_RETRY + 1) :
 with open(os.path.join(dirIn, name + '.json'), 'r') as _in :
 fig = json.load(_in)

 width = 700
 height = 500
 if 'layout' in fig :
 layout = fig['layout']
 if 'autosize' not in layout or layout['autosize'] != True :
 if 'width' in layout :
 width = layout['width']
 if 'height' in layout :
 height = layout['height']

 if 'b64' in sys.argv or 'b64=' in sys.argv or 'b64-json' in sys.argv :
 newFig = dict()
 arraysToB64(fig, newFig)
 fig = newFig
 if 'b64-json' in sys.argv and attempt == 0 : print(json.dumps(fig, indent = 2))

 try:
 bytes = await k.calc_fig(
 fig,
 path=None,
 opts=dict(
 format="png",
 width=width,
 height=height,
 ),
 )
 filename = os.path.join(dirOut, outName + '.png')
 with open(filename, "wb") as f:
 f.write(bytes)
 created = True
 except Exception as e:
 print(e)
 if attempt < MAX_RETRY :
 print('retry', attempt + 1, '/', MAX_RETRY)
 else :
 failed.append(outName)

 if(created): break

 if len(failed) > 0 :
 print('Failed at :')
 print(failed)
 sys.exit(1)


if __name__ == "__main__":
 asyncio.run(make_baselines_async())

2 changes: 1 addition & 1 deletion
test/image/make_exports.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@
 'zsmooth_methods',
 'fonts',
 'worldcup',
 'mathjax'
 'mathjax',
]

failed = 0
Expand Down

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

Skip to content
Try using Kaleido v1 for image tests#7412

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

emilykl
wants to merge
34
commits into

from

 Closed


Try using Kaleido v1 for image tests
#7412
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


34 commits


Select commit
Hold shift + click to select a range
9a078e3

try using Kaleido v1 for image tests


emilykl Apr 30, 2025
f7f5a03

Update Plotly version


emilykl May 2, 2025
5595393

Merge branch 'master' into use-new-kaleido-for-image-tests


emilykl May 27, 2025
afafaf2

update version


emilykl May 27, 2025
8c84e4b

update to new pio API and use unreleased Plotly and Kaleido


emilykl May 29, 2025
14298d8

typo


emilykl May 29, 2025
09a0f4f

install chrome for make-baselines jobs


emilykl May 29, 2025
94335b8

add apt-get update step


emilykl May 29, 2025
86f0a3e

does it work with '-browsers' images?


emilykl May 29, 2025
30c39f4

use cimg instead of circleci


emilykl May 30, 2025
279af99

use python instead of python3


emilykl May 30, 2025
ecb2c0c

Revert "use python instead of python3"


emilykl May 30, 2025
97b5f29

ensurepip


emilykl May 30, 2025
18f0a67

Revert "ensurepip"


emilykl May 30, 2025
3f13771

'python' rather than 'sudo python3'


emilykl May 30, 2025
fae9f08

try python3 without sudo


emilykl May 30, 2025
d0fa346

pip install requests


emilykl May 30, 2025
03a53b6

update kaleido ref


emilykl May 30, 2025
99eb4b5

temporarily blacklist 'gl3d_streamtube_reversed_ranges' baseline


emilykl May 30, 2025
fcafd40

temporarily blacklist 'mathjax' baseline


emilykl May 30, 2025
41172b3

temporarily blacklist 'map_predefined-styles2' baseline


emilykl May 30, 2025
0ec3ba1

remove eps from make_exports


emilykl May 30, 2025
ff45414

temporarily blacklist 'map_predefined-styles1' and 'grid_subplot_type…


emilykl May 30, 2025
340fd9e

temporarily blacklist 'map_fonts-supported-metropolis' baseline


emilykl May 30, 2025
4e518a2

typo


emilykl May 30, 2025
2011839

try with new kaleido with bugfix


emilykl Jun 2, 2025
80fe5cf

update kaleido version


emilykl Jun 2, 2025
5857a70

temporarily blacklist 'map_fonts-supported-open-sans-weight' baseline


emilykl Jun 2, 2025
53e26b9

typo


emilykl Jun 3, 2025
430b195

temporarily blacklist 'map_fonts-supported-metropolis-weight' baseline


emilykl Jun 3, 2025
6bab84d

use single Kaleido instance for making baselines (faster performance)


emilykl Jun 3, 2025
4d4d34f

commit new baselines with significant changes


emilykl Jun 4, 2025
86f5283

update plotly version in env_image.sh


emilykl Jun 4, 2025
9085ed5

Merge branch 'master' into use-new-kaleido-for-image-tests


emilykl Jul 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


40 changes: 35 additions & 5 deletions
.circleci/config.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,9 +217,15 @@ jobs:
 make-baselines-virtual-webgl:
 parallelism: 8
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand All@@ -236,9 +242,15 @@ jobs:

 make-baselines-mathjax3:
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand All@@ -256,9 +268,15 @@ jobs:
 make-baselines:
 parallelism: 12
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand All@@ -276,9 +294,15 @@ jobs:
 make-baselines-b64:
 parallelism: 12
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand DownExpand Up@@ -351,9 +375,15 @@ jobs:

 make-exports:
 docker:
 - image: cimg/python:3.12.11
 - image: cimg/python:3.12.11-browsers
 working_directory: ~/plotly.js
 steps:
 - run: sudo apt-get update
 - browser-tools/install-browser-tools:
 install-firefox: false
 install-geckodriver: false
 install-chrome: true
 chrome-version: "132.0.6834.110"
 - attach_workspace:
 at: ~/
 - run: sudo apt-get update
Expand Down

6 changes: 3 additions & 3 deletions
.circleci/env_image.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
#!/bin/sh
set -e
python3 --version
# install required fonts
sudo apt-get install fonts-liberation2 fonts-open-sans fonts-noto-cjk fonts-noto-color-emoji

Expand All@@ -15,7 +16,6 @@ sudo apt install fontconfig
sudo fc-cache -f

# install kaleido & plotly
sudo python3 -m pip install kaleido==0.2.1 plotly==6.2.0 --progress-bar off

python -m pip install "plotly[kaleido]==6.2.0" --progress-bar off
# install numpy i.e. to convert arrays to typed arrays
sudo python3 -m pip install numpy==1.24.2
python3 -m pip install numpy==1.24.2
Binary file modifiedtest/image/baselines/font-decorline-scatter.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/funnel_horizontal_group_basic.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/indicator_scatter.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/legend_mathjax_title_and_items.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/mathjax.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/ternary-mathjax-title-place-subtitle.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/text_on_shapes_basic.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedtest/image/baselines/world-cals.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

142 changes: 86 additions & 56 deletions
test/image/make_baseline.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
import asyncio
import os
import sys
import json

import plotly.io as pio
import kaleido

from convert_b64 import arraysToB64


args = []
if len(sys.argv) == 2 :
 args = sys.argv[1].split()
Expand All@@ -19,7 +24,7 @@
dirIn = os.path.join(root, 'test', 'image', 'mocks')
dirOut = os.path.join(root, 'build', 'test_images')

# N.B. equal is the falg to write to baselines not test_images
# N.B. equal is the flag to write to baselines not test_images

if '=' in args :
 args = args[args.index('=') + 1:]
Expand All@@ -31,11 +36,12 @@
print('output to', dirOut)

mathjax_version = 2
mathjax = None
if 'mathjax3' in sys.argv or 'mathjax3=' in sys.argv :
 # until https://github.com/plotly/Kaleido/issues/124 is addressed
 # we are uanble to use local mathjax v3 installed in node_modules
 # for now let's download it from the internet:
pio.kaleido.scope.mathjax = 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-svg.js'
 mathjax = 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-svg.js'
 mathjax_version = 3
 print('Kaleido using MathJax v3')

Expand All@@ -52,8 +58,8 @@

 plotlyjs = plotlyjs_with_virtual_webgl

pio.kaleido.scope.plotlyjs = plotlyjs
pio.kaleido.scope.topojson = "file://" + os.path.join(root, 'topojson', 'dist')
pio.defaults.plotlyjs = plotlyjs
pio.defaults.topojson = "file://" + os.path.join(root, 'topojson', 'dist')
pio.templates.default = 'none'

ALL_MOCKS = [os.path.splitext(a)[0] for a in os.listdir(dirIn) if a.endswith('.json')]
Expand All@@ -71,6 +77,11 @@
 'map_scattercluster',
 'map_fonts-supported-open-sans',
 'map_fonts-supported-open-sans-weight',
 'map_predefined-styles1', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'grid_subplot_types', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'map_fonts-supported-metropolis', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'map_fonts-supported-metropolis-italic', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
 'map_fonts-supported-metropolis-weight', # Temporarily blacklist: fails with Kaleido v1.0.0rc14
]
allNames = [a for a in allNames if a not in blacklist]

Expand All@@ -79,55 +90,74 @@
 sys.exit(1)

failed = []
for name in allNames :
 outName = name
 if mathjax_version == 3 :
 outName = 'mathjax3___' + name

 print(outName)

 created = False

 MAX_RETRY = 2 # 1 means retry once
 for attempt in range(0, MAX_RETRY + 1) :
 with open(os.path.join(dirIn, name + '.json'), 'r') as _in :
 fig = json.load(_in)

 width = 700
 height = 500
 if 'layout' in fig :
 layout = fig['layout']
 if 'autosize' not in layout or layout['autosize'] != True :
 if 'width' in layout :
 width = layout['width']
 if 'height' in layout :
 height = layout['height']

 if 'b64' in sys.argv or 'b64=' in sys.argv or 'b64-json' in sys.argv :
 newFig = dict()
 arraysToB64(fig, newFig)
 fig = newFig
 if 'b64-json' in sys.argv and attempt == 0 : print(json.dumps(fig, indent = 2))

 try :
 pio.write_image(
 fig=fig,
 file=os.path.join(dirOut, outName + '.png'),
 width=width,
 height=height,
 validate=False
 )
 created = True
 except Exception as e :
 print(e)
 if attempt < MAX_RETRY :
 print('retry', attempt + 1, '/', MAX_RETRY)
 else :
 failed.append(outName)

 if(created) : break

if len(failed) > 0 :
 print('Failed at :')
 print(failed)
 sys.exit(1)

async def make_baselines_async():

 kopts = dict(
 plotlyjs=plotlyjs,
 )
 if mathjax is not None:
 kopts['mathjax'] = mathjax

 async with kaleido.Kaleido(n=1, **kopts) as k:
 for name in allNames:
 outName = name
 if mathjax_version == 3:
 outName = 'mathjax3___' + name

 print(outName)

 created = False

 MAX_RETRY = 2 # 1 means retry once
 for attempt in range(0, MAX_RETRY + 1) :
 with open(os.path.join(dirIn, name + '.json'), 'r') as _in :
 fig = json.load(_in)

 width = 700
 height = 500
 if 'layout' in fig :
 layout = fig['layout']
 if 'autosize' not in layout or layout['autosize'] != True :
 if 'width' in layout :
 width = layout['width']
 if 'height' in layout :
 height = layout['height']

 if 'b64' in sys.argv or 'b64=' in sys.argv or 'b64-json' in sys.argv :
 newFig = dict()
 arraysToB64(fig, newFig)
 fig = newFig
 if 'b64-json' in sys.argv and attempt == 0 : print(json.dumps(fig, indent = 2))

 try:
 bytes = await k.calc_fig(
 fig,
 path=None,
 opts=dict(
 format="png",
 width=width,
 height=height,
 ),
 )
 filename = os.path.join(dirOut, outName + '.png')
 with open(filename, "wb") as f:
 f.write(bytes)
 created = True
 except Exception as e:
 print(e)
 if attempt < MAX_RETRY :
 print('retry', attempt + 1, '/', MAX_RETRY)
 else :
 failed.append(outName)

 if(created): break

 if len(failed) > 0 :
 print('Failed at :')
 print(failed)
 sys.exit(1)


if __name__ == "__main__":
 asyncio.run(make_baselines_async())

2 changes: 1 addition & 1 deletion
test/image/make_exports.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@
 'zsmooth_methods',
 'fonts',
 'worldcup',
 'mathjax'
 'mathjax',
]

failed = 0
Expand Down