Merge pull request matplotlib#26451 from QuLogic/type-return

TYP: Add several missing return type annotations

Author: tacaswell

lib/matplotlib/__init__.pyi

@@ -72,7 +72,7 @@ class RcParams(dict[str, Any]):
     def __getitem__(self, key: str) -> Any: ...
     def __iter__(self) -> Generator[str, None, None]: ...
     def __len__(self) -> int: ...
-    def find_all(self, pattern: str): ...
+    def find_all(self, pattern: str) -> RcParams: ...
     def copy(self) -> RcParams: ...
 
 def rc_params(fail_on_error: bool = ...) -> RcParams: ...
@@ -96,7 +96,7 @@ def rc_file(
 @contextlib.contextmanager
 def rc_context(
     rc: dict[str, Any] | None = ..., fname: str | Path | os.PathLike | None = ...
-): ...
+) -> Generator[None, None, None]: ...
 def use(backend: str, *, force: bool = ...) -> None: ...
 def get_backend() -> str: ...
 def interactive(b: bool) -> None: ...

lib/matplotlib/_api/__init__.pyi

@@ -25,6 +25,7 @@ class classproperty(Any):
         fdel: None = ...,
         doc: str | None = None,
     ): ...
+    # Replace return with Self when py3.9 is dropped
     @overload
     def __get__(self, instance: None, owner: None) -> classproperty: ...
     @overload

lib/matplotlib/_enums.pyi

@@ -1,7 +1,7 @@
 from enum import Enum
 
 class _AutoStringNameEnum(Enum):
-    def __hash__(self): ...
+    def __hash__(self) -> int: ...
 
 class JoinStyle(str, _AutoStringNameEnum):
     miter: str

lib/matplotlib/animation.pyi

@@ -41,7 +41,7 @@ class AbstractMovieWriter(abc.ABC, metaclass=abc.ABCMeta):
     dpi: float
 
     @abc.abstractmethod
-    def setup(self, fig: Figure, outfile: str | Path, dpi: float | None = ...): ...
+    def setup(self, fig: Figure, outfile: str | Path, dpi: float | None = ...) -> None: ...
     @property
     def frame_size(self) -> tuple[int, int]: ...
     @abc.abstractmethod
@@ -65,7 +65,7 @@ class MovieWriter(AbstractMovieWriter):
         extra_args: list[str] | None = ...,
         metadata: dict[str, str] | None = ...,
     ) -> None: ...
-    def setup(self, fig: Figure, outfile: str | Path, dpi: float | None = ...): ...
+    def setup(self, fig: Figure, outfile: str | Path, dpi: float | None = ...) -> None: ...
     def grab_frame(self, **savefig_kwargs) -> None: ...
     def finish(self) -> None: ...
     @classmethod

lib/matplotlib/artist.pyi

@@ -108,9 +108,9 @@ class Artist:
     def set_clip_on(self, b: bool) -> None: ...
     def get_rasterized(self) -> bool: ...
     def set_rasterized(self, rasterized: bool) -> None: ...
-    def get_agg_filter(self): ...
+    def get_agg_filter(self) -> Callable[[ArrayLike, float], tuple[np.ndarray, float, float]] | None: ...
     def set_agg_filter(
-        self, filter_func: Callable[[ArrayLike, float], tuple[np.ndarray, float, float]]
+        self, filter_func: Callable[[ArrayLike, float], tuple[np.ndarray, float, float]] | None
     ) -> None: ...
     def draw(self, renderer: RendererBase) -> None: ...
     def set_alpha(self, alpha: float | None) -> None: ...
@@ -125,9 +125,9 @@ class Artist:
     def sticky_edges(self) -> _XYPair: ...
     def update_from(self, other: Artist) -> None: ...
     def properties(self) -> dict[str, Any]: ...
-    def update(self, props: dict[str, Any]) -> Any: ...
-    def _internal_update(self, kwargs): ...
-    def set(self, **kwargs: Any): ...
+    def update(self, props: dict[str, Any]) -> list[Any]: ...
+    def _internal_update(self, kwargs: Any) -> list[Any]: ...
+    def set(self, **kwargs: Any) -> list[Any]: ...
     def findobj(
         self,
         match: None | Callable[[Artist], bool] | type[Artist] = ...,
@@ -177,5 +177,5 @@ def getp(obj: Artist, property: str | None = ...) -> Any: ...
 
 get = getp
 
-def setp(obj: Artist, *args, file: TextIO | None = ..., **kwargs): ...
+def setp(obj: Artist, *args, file: TextIO | None = ..., **kwargs) -> list[Any] | None: ...
 def kwdoc(artist: Artist | type[Artist] | Iterable[Artist | type[Artist]]) -> str: ...

lib/matplotlib/axes/__init__.pyi

@@ -1,10 +1,13 @@
-from ._axes import *
+from typing import TypeVar
 
+from ._axes import *
 from ._axes import Axes as Subplot
 
+_T = TypeVar("_T")
+
 class _SubplotBaseMeta(type):
     def __instancecheck__(self, obj) -> bool: ...
 
 class SubplotBase(metaclass=_SubplotBaseMeta): ...
 
-def subplot_class_factory(cls): ...
+def subplot_class_factory(cls: type[_T]) -> type[_T]: ...

lib/matplotlib/axes/_axes.py

@@ -2745,8 +2745,8 @@ def bar_label(self, container, labels=None, *, fmt="%g", label_type="edge",
 
         Returns
         -------
-        list of `.Text`
-            A list of `.Text` instances for the labels.
+        list of `.Annotation`
+            A list of `.Annotation` instances for the labels.
         """
         for key in ['horizontalalignment', 'ha', 'verticalalignment', 'va']:
             if key in kwargs:

lib/matplotlib/axes/_axes.pyi

@@ -274,7 +274,7 @@ class Axes(_AxesBase):
         label_type: Literal["center", "edge"] = ...,
         padding: float = ...,
         **kwargs
-    ) -> list[Text]: ...
+    ) -> list[Annotation]: ...
     def broken_barh(
         self,
         xranges: Sequence[tuple[float, float]],

lib/matplotlib/axes/_secondary_axes.pyi

@@ -36,10 +36,7 @@ class SecondaryAxis(_AxesBase):
     ) -> list[Tick]: ...
     def set_functions(
         self,
-        functions: tuple[
-            Callable[[ArrayLike], ArrayLike], Callable[[ArrayLike], ArrayLike]
-        ]
-        | Transform,
-    ): ...
+        functions: tuple[Callable[[ArrayLike], ArrayLike], Callable[[ArrayLike], ArrayLike]] | Transform,
+    ) -> None: ...
     def set_aspect(self, *args, **kwargs) -> None: ...
     def set_color(self, color: ColorType) -> None: ...

lib/matplotlib/axis.py

@@ -572,7 +572,7 @@ class _LazyTickList:
     def __init__(self, major):
         self._major = major
 
-    def __get__(self, instance, cls):
+    def __get__(self, instance, owner):
         if instance is None:
             return self
         else: