Thanks to visit codestin.com
Credit goes to github.com

Skip to content

MNT: Define Protocol for Animation.event_source #30590

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
QuLogic merged 1 commit into from
Oct 2, 2025
Merged

MNT: Define Protocol for Animation.event_source #30590

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions ci/mypy-stubtest-allowlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,6 @@ matplotlib\.figure\.FigureBase\.get_figure

# getitem method only exists for 3.10 deprecation backcompatability
matplotlib\.inset\.InsetIndicator\.__getitem__

# only defined in stubs; not present at runtime
matplotlib\.animation\.EventSourceProtocol
4 changes: 2 additions & 2 deletions lib/matplotlib/animation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -861,7 +861,7 @@ class Animation:
fig : `~matplotlib.figure.Figure`
The figure object used to get needed events, such as draw or resize.

event_source : object, optional
event_source : object
A class that can run a callback when desired events
are generated, as well as be stopped and started.

Expand All @@ -877,7 +877,7 @@ class Animation:
FuncAnimation, ArtistAnimation
"""

def __init__(self, fig, event_source=None, blit=False):
def __init__(self, fig, event_source, blit=False):
self._draw_was_started = False

self._fig = fig
Expand Down
12 changes: 9 additions & 3 deletions lib/matplotlib/animation.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ from matplotlib.artist import Artist
from matplotlib.backend_bases import TimerBase
from matplotlib.figure import Figure

from typing import Any
from typing import Any, Protocol

subprocess_creation_flags: int

Expand Down Expand Up @@ -152,11 +152,17 @@ class HTMLWriter(FileMovieWriter):
def grab_frame(self, **savefig_kwargs): ...
def finish(self) -> None: ...

class EventSourceProtocol(Protocol):
def add_callback(self, func: Callable): ...
def remove_callback(self, func: Callable): ...
def start(self): ...
def stop(self): ...

class Animation:
frame_seq: Iterable[Artist]
event_source: Any
event_source: EventSourceProtocol | None # TODO: We should remove None
def __init__(
self, fig: Figure, event_source: Any | None = ..., blit: bool = ...
self, fig: Figure, event_source: EventSourceProtocol, blit: bool = ...
) -> None: ...
def __del__(self) -> None: ...
def save(
Expand Down
Loading