X Tutup
Skip to content

Fix SVG rendering error in def update_background#30490

Merged
tacaswell merged 4 commits intomatplotlib:mainfrom
AasmaGupta:fix-svg-error
Sep 2, 2025
Merged

Fix SVG rendering error in def update_background#30490
tacaswell merged 4 commits intomatplotlib:mainfrom
AasmaGupta:fix-svg-error

Conversation

@AasmaGupta
Copy link
Copy Markdown
Contributor

@AasmaGupta AasmaGupta commented Aug 29, 2025 •
edited
Loading

Reference issue (if any)

Example: AttributeError: 'FigureCanvasSVG' object has no attribute 'copy_from_bbox'

Fixes #30485

  • Why is this change necessary?
    Saving figures as SVG could crash due to the way def update_background handled blitting in the lib/matplotlib/widgets.py file. This change prevents that crash.

  • What problem does it solve?
    fixes the crash that occurred specifically when exporting plots to SVG format

  • What is the reasoning for this implementation?
    Blitting is meant for interactive updates and isn’t needed when saving static outputs. Skipping it during SVG export prevents the crash while keeping normal interactive behavior intact.

PR checklist

@AasmaGupta
Copy link
Copy Markdown
Contributor Author

AasmaGupta commented Aug 29, 2025

i tested the fix using the code below which reproduces the issue and confirms that SVG export no longer crashes:

import numpy as np
import matplotlib

matplotlib.use("Agg")  
import matplotlib.pyplot as plt
from matplotlib.widgets import SpanSelector

fig, ax = plt.subplots()
ax.plot(np.random.randn(100, 3))
ax._span = SpanSelector(ax, lambda xmin, xmax: None, "horizontal", useblit=True)

fig.savefig("test.svg")

print("Saved successfully without crash!")

@AasmaGupta AasmaGupta force-pushed the fix-svg-error branch 4 times, most recently from fd2cfb4 to 3d6e31c Compare August 29, 2025 23:44
@AasmaGupta AasmaGupta closed this Aug 29, 2025
@AasmaGupta AasmaGupta reopened this Aug 30, 2025
@QuLogic
Copy link
Copy Markdown
Member

QuLogic commented Aug 30, 2025

There is no such thing as _setup_plot_projector in Matplotlib; what is this actually about?

@AasmaGupta AasmaGupta changed the title Fix SVG rendering error in _setup_plot_projector Fix SVG rendering error in def update_backgroud Aug 30, 2025
@AasmaGupta AasmaGupta changed the title Fix SVG rendering error in def update_backgroud Fix SVG rendering error in def update_background Aug 30, 2025
@AasmaGupta
Copy link
Copy Markdown
Contributor Author

AasmaGupta commented Aug 30, 2025

I have updated the PR with the issue number and more accurate files and functions to navigate the issue as well as the fix. Hope this makes it easier to navigate and review!

timhoffm
timhoffm reviewed Aug 31, 2025
View reviewed changes
@AasmaGupta @timhoffm
Update lib/matplotlib/widgets.py
48d9793 
Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
timhoffm
timhoffm reviewed Aug 31, 2025
View reviewed changes
@AasmaGupta @timhoffm
Removed redundant check(self.useblit already checks)
98ca7bb 
Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
timhoffm
timhoffm reviewed Sep 1, 2025
View reviewed changes
@AasmaGupta @timhoffm
Update lib/matplotlib/widgets.py
913e528 
Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
@tacaswell tacaswell added this to the v3.10.7 milestone Sep 2, 2025
tacaswell
tacaswell approved these changes Sep 2, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@tacaswell tacaswell left a comment

Choose a reason for hiding this comment

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

@AasmaGupta Do you feel comfortable squashing this to one commit? IF not we can squash-merge.

Otherwise 👍

@AasmaGupta
Copy link
Copy Markdown
Contributor Author

AasmaGupta commented Sep 2, 2025

@tacaswell I'm fine with you squash merging it from your end. Thanks!

@anntzer anntzer mentioned this pull request Sep 2, 2025
Open
13 tasks
@tacaswell tacaswell merged commit 0056a47 into matplotlib:main Sep 2, 2025
39 of 40 checks passed
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Sep 2, 2025
@AasmaGupta @meeseeksmachine
Backport PR matplotlib#30490: Fix SVG rendering error in def update_b…
e8eac49 
…ackground
@meeseeksmachine meeseeksmachine mentioned this pull request Sep 2, 2025
Merged
timhoffm added a commit that referenced this pull request Sep 2, 2025
@timhoffm
Merge pull request #30506 from meeseeksmachine/auto-backport-of-pr-30…
851d6a0 
…490-on-v3.10.x

Backport PR #30490 on branch v3.10.x (Fix SVG rendering error in def update_background)
@ksunden ksunden mentioned this pull request Oct 9, 2025
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tacaswell tacaswell tacaswell approved these changes

@timhoffm timhoffm timhoffm approved these changes

Assignees

No one assigned

Labels

topic: widgets/UI

Projects

None yet

Milestone

v3.10.7

Development

Successfully merging this pull request may close these issues.

[Bug]: figures with SpanSelector(..., useblit=True) can't be saved to SVG or PDF

4 participants

@AasmaGupta @QuLogic @tacaswell @timhoffm
X Tutup