Skip to content

Copy width/height calculating logic from kaleido #5325

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
emilykl merged 10 commits into from
Aug 19, 2025
Merged

Copy width/height calculating logic from kaleido #5325

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
df823b4
Copy width/height calculating logic from kaleido
ayjayt Aug 13, 2025
e8049a2
Add proper defaults to dict .get()
ayjayt Aug 14, 2025
8036084
Add proper defaults to dict .get() x2
ayjayt Aug 14, 2025
bcdccf4
Format with ruff.
ayjayt Aug 14, 2025
f1e7607
Add some width/height testing.
ayjayt Aug 14, 2025
1b962ec
Fix test formatting.
ayjayt Aug 14, 2025
20035c6
Fix variable access.
ayjayt Aug 14, 2025
c589d1c
Move test_kaleido helper fns to top of file
ayjayt Aug 18, 2025
e17895e
Use pio defaults to check test defaults
ayjayt Aug 18, 2025
c249e95
Pull off ruff format.
ayjayt Aug 18, 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
Prev Previous commit
Next Next commit
Fix test formatting.
  • Loading branch information
@ayjayt
ayjayt committed Aug 14, 2025
commit 1b962ecaf602a42c922673ccc1e0781386a9bc1d
39 changes: 22 additions & 17 deletions tests/test_optional/test_kaleido/test_kaleido.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,22 +321,19 @@ def create_figure(width=None, height=None):
"""Create a simple figure with optional layout dimensions."""
layout = {}
if width:
layout['width'] = width
layout["width"] = width
if height:
layout['height'] = height
layout["height"] = height

return go.Figure(
data=[go.Scatter(x=[1, 2, 3], y=[1, 2, 3])],
layout=layout
)
return go.Figure(data=[go.Scatter(x=[1, 2, 3], y=[1, 2, 3])], layout=layout)


def parse_svg_dimensions(svg_bytes):
"""Parse width and height from SVG bytes."""
svg_str = svg_bytes.decode('utf-8')
svg_str = svg_bytes.decode("utf-8")
root = ET.fromstring(svg_str)
width = root.get('width')
height = root.get('height')
width = root.get("width")
height = root.get("height")
return int(width) if width else None, int(height) if height else None


Expand All @@ -345,24 +342,32 @@ def test_width_height_priority():

# Test case 1: Arguments override layout
fig = create_figure(layout_width=800, layout_height=600)
svg_bytes = pio.to_image(fig, format='svg', width=1000, height=900)
svg_bytes = pio.to_image(fig, format="svg", width=1000, height=900)
width, height = parse_svg_dimensions(svg_bytes)
assert width == 1000 and height == 900, "Arguments should override layout dimensions"
assert width == 1000 and height == 900, (
"Arguments should override layout dimensions"
)

# Test case 2: Layout dimensions used when no arguments
fig = create_figure(layout_width=800, layout_height=600)
svg_bytes = pio.to_image(fig, format='svg')
svg_bytes = pio.to_image(fig, format="svg")
width, height = parse_svg_dimensions(svg_bytes)
assert width == 800 and height == 600, "Layout dimensions should be used when no arguments provided"
assert width == 800 and height == 600, (
"Layout dimensions should be used when no arguments provided"
)

# Test case 3: Partial override (only width argument)
fig = create_figure(layout_width=800, layout_height=600)
svg_bytes = pio.to_image(fig, format='svg', width=1200)
svg_bytes = pio.to_image(fig, format="svg", width=1200)
width, height = parse_svg_dimensions(svg_bytes)
assert width == 1200 and height == 600, "Width argument should override layout, height should use layout"
assert width == 1200 and height == 600, (
"Width argument should override layout, height should use layout"
)

# Test case 4: Defaults used when no layout or arguments
fig = create_figure()
svg_bytes = pio.to_image(fig, format='svg')
svg_bytes = pio.to_image(fig, format="svg")
width, height = parse_svg_dimensions(svg_bytes)
assert width is not None and height is not None, "Default dimensions should be used when no layout or arguments"
assert width is not None and height is not None, (
Copy link
Contributor

@emilykl emilykl Aug 15, 2025

Choose a reason for hiding this comment

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

You should be able to import pio.defaults here and check that the dimensions equal the defaults

"Default dimensions should be used when no layout or arguments"
)