Merge pull request matplotlib#30275 from ZPyrolink/fix/connect_literal

Create events type and update plt.connect and mpl_connect

Author: QuLogic

lib/matplotlib/backend_bases.pyi

@@ -21,7 +21,18 @@ from matplotlib.transforms import Bbox, BboxBase, Transform, TransformedPath
 from collections.abc import Callable, Iterable, Sequence
 from typing import Any, IO, Literal, NamedTuple, TypeVar, overload
 from numpy.typing import ArrayLike
-from .typing import ColorType, LineStyleType, CapStyleType, JoinStyleType
+from .typing import (
+    CapStyleType,
+    CloseEventType,
+    ColorType,
+    DrawEventType,
+    JoinStyleType,
+    KeyEventType,
+    LineStyleType,
+    MouseEventType,
+    PickEventType,
+    ResizeEventType,
+)
 
 def register_backend(
     format: str, backend: str | type[FigureCanvasBase], description: str | None = ...
@@ -354,37 +365,28 @@ class FigureCanvasBase:
     @overload
     def mpl_connect(
         self,
-        s: Literal[
-            "button_press_event",
-            "motion_notify_event",
-            "scroll_event",
-            "figure_enter_event",
-            "figure_leave_event",
-            "axes_enter_event",
-            "axes_leave_event",
-            "button_release_event",
-        ],
+        s: MouseEventType,
         func: Callable[[MouseEvent], Any],
     ) -> int: ...
 
     @overload
     def mpl_connect(
         self,
-        s: Literal["key_press_event", "key_release_event"],
+        s: KeyEventType,
         func: Callable[[KeyEvent], Any],
     ) -> int: ...
 
     @overload
-    def mpl_connect(self, s: Literal["pick_event"], func: Callable[[PickEvent], Any]) -> int: ...
+    def mpl_connect(self, s: PickEventType, func: Callable[[PickEvent], Any]) -> int: ...
 
     @overload
-    def mpl_connect(self, s: Literal["resize_event"], func: Callable[[ResizeEvent], Any]) -> int: ...
+    def mpl_connect(self, s: ResizeEventType, func: Callable[[ResizeEvent], Any]) -> int: ...
 
     @overload
-    def mpl_connect(self, s: Literal["close_event"], func: Callable[[CloseEvent], Any]) -> int: ...
+    def mpl_connect(self, s: CloseEventType, func: Callable[[CloseEvent], Any]) -> int: ...
 
     @overload
-    def mpl_connect(self, s: str, func: Callable[[Event], Any]) -> int: ...
+    def mpl_connect(self, s: DrawEventType, func: Callable[[DrawEvent], Any]) -> int: ...
     def mpl_disconnect(self, cid: int) -> None: ...
     def new_timer(
         self,

lib/matplotlib/pyplot.py

@@ -100,7 +100,14 @@
     import matplotlib.backend_bases
     from matplotlib.axis import Tick
     from matplotlib.axes._base import _AxesBase
-    from matplotlib.backend_bases import Event
+    from matplotlib.backend_bases import (
+        CloseEvent,
+        DrawEvent,
+        KeyEvent,
+        MouseEvent,
+        PickEvent,
+        ResizeEvent,
+    )
     from matplotlib.cm import ScalarMappable
     from matplotlib.contour import ContourSet, QuadContourSet
     from matplotlib.collections import (
@@ -126,11 +133,17 @@
     from matplotlib.quiver import Barbs, Quiver, QuiverKey
     from matplotlib.scale import ScaleBase
     from matplotlib.typing import (
+        CloseEventType,
         ColorType,
         CoordsType,
+        DrawEventType,
         HashableList,
+        KeyEventType,
         LineStyleType,
         MarkerType,
+        MouseEventType,
+        PickEventType,
+        ResizeEventType,
     )
     from matplotlib.widgets import SubplotTool
 
@@ -1175,8 +1188,32 @@ def get_current_fig_manager() -> FigureManagerBase | None:
     return gcf().canvas.manager
 
 
+@overload
+def connect(s: MouseEventType, func: Callable[[MouseEvent], Any]) -> int: ...
+
+
+@overload
+def connect(s: KeyEventType, func: Callable[[KeyEvent], Any]) -> int: ...
+
+
+@overload
+def connect(s: PickEventType, func: Callable[[PickEvent], Any]) -> int: ...
+
+
+@overload
+def connect(s: ResizeEventType, func: Callable[[ResizeEvent], Any]) -> int: ...
+
+
+@overload
+def connect(s: CloseEventType, func: Callable[[CloseEvent], Any]) -> int: ...
+
+
+@overload
+def connect(s: DrawEventType, func: Callable[[DrawEvent], Any]) -> int: ...
+
+
 @_copy_docstring_and_deprecators(FigureCanvasBase.mpl_connect)
-def connect(s: str, func: Callable[[Event], Any]) -> int:
+def connect(s, func) -> int:
     return gcf().canvas.mpl_connect(s, func)
 
 

lib/matplotlib/typing.py

@@ -107,3 +107,33 @@
 _HT = TypeVar("_HT", bound=Hashable)
 HashableList: TypeAlias = list[_HT | "HashableList[_HT]"]
 """A nested list of Hashable values."""
+
+MouseEventType: TypeAlias = Literal[
+    "button_press_event",
+    "button_release_event",
+    "motion_notify_event",
+    "scroll_event",
+    "figure_enter_event",
+    "figure_leave_event",
+    "axes_enter_event",
+    "axes_leave_event",
+]
+
+KeyEventType: TypeAlias = Literal[
+    "key_press_event",
+    "key_release_event"
+]
+
+DrawEventType: TypeAlias = Literal["draw_event"]
+PickEventType: TypeAlias = Literal["pick_event"]
+ResizeEventType: TypeAlias = Literal["resize_event"]
+CloseEventType: TypeAlias = Literal["close_event"]
+
+EventType: TypeAlias = Literal[
+    MouseEventType,
+    KeyEventType,
+    DrawEventType,
+    PickEventType,
+    ResizeEventType,
+    CloseEventType,
+]