TYP: Mark more items as optional

QuLogic · QuLogic · commit 85885a4de817 · 2023-08-02T15:51:56.000-04:00
These can be set to `None` in their `__init__` or the property setter.
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -757,8 +757,7 @@ def set_clip_box(self, clipbox):
 
         Parameters
         ----------
-        clipbox : `.Bbox`
-
+        clipbox : `.Bbox` or None
             Typically would be created from a `.TransformedBbox`. For
             instance ``TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes)``
             is the default clipping for an artist added to an Axes.
diff --git a/lib/matplotlib/artist.pyi b/lib/matplotlib/artist.pyi
@@ -51,7 +51,7 @@ class Artist:
     def remove_callback(self, oid: int) -> None: ...
     def pchanged(self) -> None: ...
     def is_transform_set(self) -> bool: ...
-    def set_transform(self, t: Transform) -> None: ...
+    def set_transform(self, t: Transform | None) -> None: ...
     def get_transform(self) -> Transform: ...
     def get_children(self) -> list[Artist]: ...
     # TODO can these dicts be type narrowed? e.g. str keys
@@ -87,7 +87,7 @@ class Artist:
     def get_path_effects(self) -> list[AbstractPathEffect]: ...
     def get_figure(self) -> Figure | None: ...
     def set_figure(self, fig: Figure) -> None: ...
-    def set_clip_box(self, clipbox: Bbox) -> None: ...
+    def set_clip_box(self, clipbox: Bbox | None) -> None: ...
     def set_clip_path(
         self,
         path: Patch | Path | TransformedPath | TransformedPatchPath | None,
diff --git a/lib/matplotlib/axes/_axes.pyi b/lib/matplotlib/axes/_axes.pyi
@@ -52,7 +52,7 @@ class Axes(_AxesBase):
     def get_legend_handles_labels(
         self, legend_handler_map: dict[type, HandlerBase] | None = ...
     ) -> tuple[list[Artist], list[Any]]: ...
-    legend_: Legend
+    legend_: Legend | None
 
     @overload
     def legend(self) -> Legend: ...
diff --git a/lib/matplotlib/backend_bases.pyi b/lib/matplotlib/backend_bases.pyi
@@ -168,7 +168,7 @@ class GraphicsContextBase:
     def set_url(self, url: str | None) -> None: ...
     def set_gid(self, id: int | None) -> None: ...
     def set_snap(self, snap: bool | None) -> None: ...
-    def set_hatch(self, hatch: str) -> None: ...
+    def set_hatch(self, hatch: str | None) -> None: ...
     def get_hatch(self) -> str | None: ...
     def get_hatch_path(self, density: float = ...) -> Path: ...
     def get_hatch_color(self) -> ColorType: ...
@@ -386,8 +386,8 @@ class FigureManagerBase:
     num: int | str
     key_press_handler_id: int | None
     button_press_handler_id: int | None
-    toolmanager: ToolManager
-    toolbar: NavigationToolbar2
+    toolmanager: ToolManager | None
+    toolbar: NavigationToolbar2 | ToolContainerBase | None
     def __init__(self, canvas: FigureCanvasBase, num: int | str) -> None: ...
     @classmethod
     def create_with_canvas(
diff --git a/lib/matplotlib/colorbar.pyi b/lib/matplotlib/colorbar.pyi
@@ -23,7 +23,7 @@ class Colorbar:
     n_rasterize: int
     mappable: cm.ScalarMappable
     ax: Axes
-    alpha: float
+    alpha: float | None
     cmap: colors.Colormap
     norm: colors.Normalize
     values: Sequence[float] | None
diff --git a/lib/matplotlib/image.pyi b/lib/matplotlib/image.pyi
@@ -74,7 +74,7 @@ class _ImageBase(martist.Artist, cm.ScalarMappable):
     def set_array(self, A: ArrayLike | None) -> None: ...
     def get_shape(self) -> tuple[int, int, int]: ...
     def get_interpolation(self) -> str: ...
-    def set_interpolation(self, s: str) -> None: ...
+    def set_interpolation(self, s: str | None) -> None: ...
     def set_interpolation_stage(self, s: Literal["data", "rgba"]) -> None: ...
     def can_composite(self) -> bool: ...
     def set_resample(self, v: bool | None) -> None: ...
diff --git a/lib/matplotlib/legend.pyi b/lib/matplotlib/legend.pyi
@@ -128,7 +128,7 @@ class Legend(Artist):
     draw_frame = set_frame_on
     def get_bbox_to_anchor(self) -> BboxBase: ...
     def set_bbox_to_anchor(
-        self, bbox: BboxBase, transform: Transform | None = ...
+        self, bbox: BboxBase | None, transform: Transform | None = ...
     ) -> None: ...
     @overload
     def set_draggable(
diff --git a/lib/matplotlib/lines.pyi b/lib/matplotlib/lines.pyi
@@ -76,7 +76,6 @@ class Line2D(Artist):
     def set_data(self, x: ArrayLike, y: ArrayLike) -> None: ...
     def recache_always(self) -> None: ...
     def recache(self, always: bool = ...) -> None: ...
-    def set_transform(self, t: Transform) -> None: ...
     def get_antialiased(self) -> bool: ...
     def get_color(self) -> ColorType: ...
     def get_drawstyle(self) -> DrawStyleType: ...
diff --git a/lib/matplotlib/offsetbox.py b/lib/matplotlib/offsetbox.py
@@ -107,7 +107,7 @@ def _get_packed_offsets(widths, total, sep, mode="fixed"):
         Widths of boxes to be packed.
     total : float or None
         Intended total length. *None* if not used.
-    sep : float
+    sep : float or None
         Spacing between boxes.
     mode : {'fixed', 'expand', 'equal'}
         The packing mode.
diff --git a/lib/matplotlib/offsetbox.pyi b/lib/matplotlib/offsetbox.pyi
@@ -19,7 +19,7 @@ def bbox_artist(*args, **kwargs) -> None: ...
 def _get_packed_offsets(
     widths: Sequence[float],
     total: float | None,
-    sep: float,
+    sep: float | None,
     mode: Literal["fixed", "expand", "equal"] = ...,
 ) -> tuple[float, np.ndarray]: ...
 
@@ -114,7 +114,6 @@ class DrawingArea(OffsetBox):
     @clip_children.setter
     def clip_children(self, val: bool) -> None: ...
     def get_transform(self) -> Transform: ...
-    def set_transform(self, t: Transform) -> None: ...
 
     # does not accept all options of superclass
     def set_offset(self, xy: tuple[float, float]) -> None: ...  # type: ignore[override]
@@ -134,7 +133,6 @@ class TextArea(OffsetBox):
     def get_text(self) -> str: ...
     def set_multilinebaseline(self, t: bool) -> None: ...
     def get_multilinebaseline(self) -> bool: ...
-    def set_transform(self, t: Transform) -> None: ...
 
     # does not accept all options of superclass
     def set_offset(self, xy: tuple[float, float]) -> None: ...  # type: ignore[override]
@@ -147,7 +145,6 @@ class AuxTransformBox(OffsetBox):
     def __init__(self, aux_transform: Transform) -> None: ...
     def add_artist(self, a: martist.Artist) -> None: ...
     def get_transform(self) -> Transform: ...
-    def set_transform(self, t: Transform) -> None: ...
 
     # does not accept all options of superclass
     def set_offset(self, xy: tuple[float, float]) -> None: ...  # type: ignore[override]
diff --git a/lib/matplotlib/projections/polar.pyi b/lib/matplotlib/projections/polar.pyi
@@ -158,7 +158,7 @@ class PolarAxes(Axes):
     def get_rmax(self) -> float: ...
     def set_rmin(self, rmin: float) -> None: ...
     def get_rmin(self) -> float: ...
-    def set_rorigin(self, rorigin: float) -> None: ...
+    def set_rorigin(self, rorigin: float | None) -> None: ...
     def get_rorigin(self) -> float: ...
     def get_rsign(self) -> float: ...
     def set_rlim(
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -78,7 +78,7 @@
 
 import numpy as np
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, cast
 
 if TYPE_CHECKING:
     from collections.abc import Callable, Hashable, Iterable, Sequence
@@ -1803,7 +1803,7 @@ def twiny(ax: matplotlib.axes.Axes | None = None) -> _AxesBase:
     return ax1
 
 
-def subplot_tool(targetfig: Figure | None = None) -> SubplotTool:
+def subplot_tool(targetfig: Figure | None = None) -> SubplotTool | None:
     """
     Launch a subplot tool window for a figure.
 
@@ -1815,9 +1815,12 @@ def subplot_tool(targetfig: Figure | None = None) -> SubplotTool:
         targetfig = gcf()
     tb = targetfig.canvas.manager.toolbar  # type: ignore[union-attr]
     if hasattr(tb, "configure_subplots"):  # toolbar2
-        return tb.configure_subplots()
+        from matplotlib.backend_bases import NavigationToolbar2
+        return cast(NavigationToolbar2, tb).configure_subplots()
     elif hasattr(tb, "trigger_tool"):  # toolmanager
-        return tb.trigger_tool("subplots")
+        from matplotlib.backend_bases import ToolContainerBase
+        cast(ToolContainerBase, tb).trigger_tool("subplots")
+        return None
     else:
         raise ValueError("subplot_tool can only be launched for figures with "
                          "an associated toolbar")
diff --git a/lib/matplotlib/scale.pyi b/lib/matplotlib/scale.pyi
@@ -6,7 +6,7 @@ from typing import Literal
 from numpy.typing import ArrayLike
 
 class ScaleBase:
-    def __init__(self, axis: Axis) -> None: ...
+    def __init__(self, axis: Axis | None) -> None: ...
     def get_transform(self) -> Transform: ...
     def set_default_locators_and_formatters(self, axis: Axis) -> None: ...
     def limit_range_for_scale(
@@ -30,7 +30,7 @@ class FuncScale(ScaleBase):
     name: str
     def __init__(
         self,
-        axis: Axis,
+        axis: Axis | None,
         functions: tuple[
             Callable[[ArrayLike], ArrayLike], Callable[[ArrayLike], ArrayLike]
         ],
@@ -57,7 +57,7 @@ class LogScale(ScaleBase):
     subs: Iterable[int] | None
     def __init__(
         self,
-        axis: Axis,
+        axis: Axis | None,
         *,
         base: float = ...,
         subs: Iterable[int] | None = ...,
@@ -70,7 +70,7 @@ class LogScale(ScaleBase):
 class FuncScaleLog(LogScale):
     def __init__(
         self,
-        axis: Axis,
+        axis: Axis | None,
         functions: tuple[
             Callable[[ArrayLike], ArrayLike], Callable[[ArrayLike], ArrayLike]
         ],
@@ -104,7 +104,7 @@ class SymmetricalLogScale(ScaleBase):
     subs: Iterable[int] | None
     def __init__(
         self,
-        axis: Axis,
+        axis: Axis | None,
         *,
         base: float = ...,
         linthresh: float = ...,
@@ -138,7 +138,7 @@ class AsinhScale(ScaleBase):
     auto_tick_multipliers: dict[int, tuple[int, ...]]
     def __init__(
         self,
-        axis: Axis,
+        axis: Axis | None,
         *,
         linear_width: float = ...,
         base: float = ...,
@@ -165,7 +165,7 @@ class LogitScale(ScaleBase):
     name: str
     def __init__(
         self,
-        axis: Axis,
+        axis: Axis | None,
         nonpositive: Literal["mask", "clip"] = ...,
         *,
         one_half: str = ...,
diff --git a/lib/matplotlib/spines.pyi b/lib/matplotlib/spines.pyi
@@ -11,7 +11,7 @@ from typing import Literal, TypeVar, overload
 class Spine(mpatches.Patch):
     axes: Axes
     spine_type: str
-    axis: Path
+    axis: Axis | None
     def __init__(self, axes: Axes, spine_type: str, path: Path, **kwargs) -> None: ...
     def set_patch_arc(
         self, center: tuple[float, float], radius: float, theta1: float, theta2: float
diff --git a/lib/matplotlib/table.pyi b/lib/matplotlib/table.pyi
@@ -24,7 +24,7 @@ class Cell(Rectangle):
         text: str = ...,
         loc: Literal["left", "center", "right"] | None = ...,
         fontproperties: dict[str, Any] | None = ...,
-        visible_edges: str = ...
+        visible_edges: str | None = ...
     ) -> None: ...
     def get_text(self) -> Text: ...
     def set_fontsize(self, size: float) -> None: ...
@@ -38,7 +38,7 @@ class Cell(Rectangle):
     @property
     def visible_edges(self) -> str: ...
     @visible_edges.setter
-    def visible_edges(self, value: str) -> None: ...
+    def visible_edges(self, value: str | None) -> None: ...
     def get_path(self) -> Path: ...
 
 CustomCell = Cell
diff --git a/lib/matplotlib/tri/_triangulation.py b/lib/matplotlib/tri/_triangulation.py
@@ -28,7 +28,7 @@ class Triangulation:
         For each triangle, the indices of the three points that make
         up the triangle, ordered in an anticlockwise manner. If you want to
         take the *mask* into account, use `get_masked_triangles` instead.
-    mask : (ntri, 3) array of bool
+    mask : (ntri, 3) array of bool or None
         Masked out triangles.
     is_delaunay : bool
         Whether the Triangulation is a calculated Delaunay
diff --git a/lib/matplotlib/tri/_triangulation.pyi b/lib/matplotlib/tri/_triangulation.pyi
@@ -8,7 +8,7 @@ from typing import Any
 class Triangulation:
     x: np.ndarray
     y: np.ndarray
-    mask: np.ndarray
+    mask: np.ndarray | None
     is_delaunay: bool
     triangles: np.ndarray
     def __init__(
