animation.py: Stop event sources instead of nulling them on animation stop by DavidVadnais · Pull Request #32296 · matplotlib/matplotlib

DavidVadnais · 2026-09-04T19:53:04Z

PR summary

Closes: #30622
Followed issue link to #30590. Then followed suggestions made there.

code to exercise this change

import matplotlib
matplotlib.use('agg')
import matplotlib.pyplot as plt
from matplotlib.animation import FuncAnimation

fig, ax = plt.subplots()
anim = FuncAnimation(fig, lambda f: [], frames=3, repeat=False)
anim._start()
while anim._step():
    pass
anim.event_source

Output before change

None

Output after change

print(anim.event_source)
<matplotlib.backend_bases.TimerBase at 0x...>

AI Disclosure

Used ai to help me find an easy issue to try and dip my toe in the water. Then had it write the exercising code.

PR quality check

Use an expressive title, e.g. "Fix title font property precedence"
New and changed code is tested
Plotting related features are demonstrated in an example
New features and API changes have release notes
Documentation complies with general and docstring guidelines

github-actions · 2026-09-04T19:53:17Z

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks. We also ask that you please finish addressing any review comments on this PR and wait for it to be merged (or closed) before opening a new one, as it can be a valuable learning experience to go through the review process.

You can also join us on discourse chat for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide.
Please let us know if (and how) you use AI, it will help us give you better feedback on your PR.

We strive to be a welcoming and open project. Please follow our Code of Conduct.

DavidVadnais · 2026-09-04T20:33:32Z

New features and API changes have release notes

I think i need to add a file to doc/api/next_api_changes/behavior/ named something like animation_stop_event_stop_not_null.rst explaining this change.

DavidVadnais · 2026-09-05T00:16:58Z

To my understanding, if all the actions pass this PR is ready for review. Please let me know if I’ve missed any pre-review steps

DavidVadnais · 2026-09-12T17:46:39Z

Aloha,

I am following up after a week as instructed by the github bot. Let me know what I am missing.

DavidVadnais · 2026-09-24T01:07:11Z

rebasing since this getting out of sync

git fetch origin
git rebase origin/main
git push --force-with-lease

melissawm · 2026-09-24T20:05:02Z

Hi @DavidVadnais - I am flagging this for review, but our maintainers are currently pretty busy so apologies if it's taking longer than expected. Thanks for the patience!

DavidVadnais · 2026-09-24T20:13:05Z

Sounds good. Thank you for all the work you all do.

QuLogic · 2026-09-25T05:54:00Z

+``TimedAnimation``/``Animation`` now perform .stop() on mpl_disconnect
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Previously these classes set ``self.event_source = None`` when
+``self._fig.canvas.mpl_disconnect`` was called. Now they run
+``self.event_source.stop()``.


This is a very internal description of what changed. Users aren't calling mpl_disconnect on a private _fig attribute.

I did my best here but let me know if you want further changes.

QuLogic · 2026-09-25T06:44:56Z

+    Tests that animations now stop the event source instead
+    of destroying it on animation completion.


Don't really need to mention what happened before.

Removed reference to previous behavior.

QuLogic · 2026-09-25T06:46:10Z

+    fig, ax = plt.subplots()
+    anim = FuncAnimation(fig, lambda f: [], frames=3)
+    anim._start()
+    plt.close(fig)


This isn't necessary for testing in general, so you should add a comment that it's intentionally there.

added comment.

…ion stop

github-actions Bot added the topic: animation label Sep 4, 2026

github-actions Bot added the first-contribution label Sep 4, 2026

DavidVadnais force-pushed the fix-issue-#30622 branch from f4457a1 to 0d2a337 Compare September 4, 2026 23:43

DavidVadnais force-pushed the fix-issue-#30622 branch 2 times, most recently from a4793c2 to 30da2c4 Compare September 6, 2026 21:43

DavidVadnais force-pushed the fix-issue-#30622 branch from 30da2c4 to 25d78ac Compare September 24, 2026 01:05

QuLogic reviewed Sep 25, 2026

View reviewed changes

DavidVadnais force-pushed the fix-issue-#30622 branch from 25d78ac to 56456bf Compare September 26, 2026 21:57

animation.py: Stop event sources instead of nullifying them on animat…

56456bf

…ion stop

		Tests that animations now stop the event source instead
		of destroying it on animation completion.

Uh oh!

Conversation

DavidVadnais commented Sep 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR summary

AI Disclosure

PR quality check

Uh oh!

github-actions Bot commented Sep 4, 2026

Uh oh!

DavidVadnais commented Sep 4, 2026

Uh oh!

DavidVadnais commented Sep 5, 2026

Uh oh!

DavidVadnais commented Sep 12, 2026

Uh oh!

DavidVadnais commented Sep 24, 2026

Uh oh!

melissawm commented Sep 24, 2026

Uh oh!

DavidVadnais commented Sep 24, 2026

Uh oh!

QuLogic Sep 25, 2026

Choose a reason for hiding this comment

Uh oh!

DavidVadnais Sep 26, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

QuLogic Sep 25, 2026

Choose a reason for hiding this comment

Uh oh!

DavidVadnais Sep 26, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

QuLogic Sep 25, 2026

Choose a reason for hiding this comment

Uh oh!

DavidVadnais Sep 26, 2026

Choose a reason for hiding this comment

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

DavidVadnais commented Sep 4, 2026 •

edited

Loading