MNT: Update internal usages of privatized Formatter attributes in ticker.py

buddy0452004 · buddy0452004 · commit 511109217b1f · 2026-04-10T17:19:44.000+05:30
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -34,7 +34,7 @@ jobs:
           persist-credentials: false
 
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@38697555549f1db7851b81482ff19f1fa5c4fedc  # v4.34.1
+        uses: github/codeql-action/init@c10b8064de6f491fea524254123dbe5e09572f13  # v4.35.1
         with:
           languages: ${{ matrix.language }}
 
@@ -45,4 +45,4 @@ jobs:
           pip install --user -v .
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@38697555549f1db7851b81482ff19f1fa5c4fedc  # v4.34.1
+        uses: github/codeql-action/analyze@c10b8064de6f491fea524254123dbe5e09572f13  # v4.35.1
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -395,7 +395,7 @@ jobs:
           fi
       - name: Upload code coverage
         if: ${{ !cancelled() && github.event_name != 'schedule' }}
-        uses: codecov/codecov-action@1af58845a975a7985b0beb0cbe6fbbb71a41dbad  # v5.5.3
+        uses: codecov/codecov-action@57e3a136b779b570ffcdbf80b3bdc90e7fab3de2  # v6.0.0
         with:
           name: "${{ matrix.python-version }} ${{ matrix.os }} ${{ matrix.name-suffix }}"
           token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/doc/api/next_api_changes/deprecations/31416-TH.rst b/doc/api/next_api_changes/deprecations/31416-TH.rst
diff --git a/doc/api/ticker_api.rst b/doc/api/ticker_api.rst
@@ -5,6 +5,7 @@
 .. automodule:: matplotlib.ticker
    :members:
    :undoc-members:
+   :special-members: __call__
    :show-inheritance:
 
 
diff --git a/doc/release/next_whats_new/partial_figsize_none.rst b/doc/release/next_whats_new/partial_figsize_none.rst
@@ -0,0 +1,12 @@
+Partial ``figsize`` specification at figure creation
+----------------------------------------------------
+
+Figure creation now accepts a single ``None`` in ``figsize``.
+Passing ``(None, h)`` uses the default width from :rc:`figure.figsize`, and
+passing ``(w, None)`` uses the default height.
+Passing ``(None, None)`` is invalid and raises a `ValueError`.
+
+For example::
+
+    import matplotlib.pyplot as plt
+    fig = plt.figure(figsize=(None, 4))
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -255,10 +255,12 @@ def remove(self):
             # clear stale callback
             self.stale_callback = None
             _ax_flag = False
-            if hasattr(self, 'axes') and self.axes:
+            ax = getattr(self, 'axes', None)
+            mouseover_set = getattr(ax, '_mouseover_set', None)
+            if mouseover_set is not None:
                 # remove from the mouse hit list
-                self.axes._mouseover_set.discard(self)
-                self.axes.stale = True
+                mouseover_set.discard(self)
+                ax.stale = True
                 self.axes = None  # decouple the artist from the Axes
                 _ax_flag = True
 
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -556,8 +556,8 @@ def secondary_xaxis(self, location, functions=None, *, transform=None, **kwargs)
         """
         Add a second x-axis to this `~.axes.Axes`.
 
-        For example if we want to have a second scale for the data plotted on
-        the xaxis.
+        This axis is typically used to display a second x-scale for the data
+        plotted on the Axes.
 
         %(_secax_docstring)s
 
@@ -610,8 +610,8 @@ def secondary_yaxis(self, location, functions=None, *, transform=None, **kwargs)
         """
         Add a second y-axis to this `~.axes.Axes`.
 
-        For example if we want to have a second scale for the data plotted on
-        the yaxis.
+        This axis is typically used to display a second y-scale for the data
+        plotted on the Axes.
 
         %(_secax_docstring)s
 
diff --git a/lib/matplotlib/axes/_secondary_axes.py b/lib/matplotlib/axes/_secondary_axes.py
@@ -329,6 +329,11 @@ def set_color(self, color):
 Returns
 -------
 ax : axes._secondary_axes.SecondaryAxis
+    The returned Axes is overlaid on top of the original Axes and all
+    components except for the complementary axis are hidden. You may modify
+    the complementary axis, e.g. by setting ticks or an axis label. However,
+    it is not designed to hold data, so that you should not call any
+    plotting methods on it.
 
 Other Parameters
 ----------------
diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -1271,7 +1271,15 @@ def legend_elements(self, prop="colors", num="auto",
               "alpha": self.get_alpha(),
               **kwargs}
 
-        for val, lab in zip(values, label_values):
+        # Pre-format all labels
+        # TODO: check whether we can switch to
+        #       formatted_labels = fmt.format_ticks(label_values)
+        #       There are subtle differences for some formatters as that passes the
+        #       indices to __call__ as well.
+        fmt.set_locs(label_values)
+        formatted_labels = [fmt(lab) for lab in label_values]
+
+        for val, formatted in zip(values, formatted_labels):
             if prop == "colors":
                 color = self.cmap(self.norm(val))
             elif prop == "sizes":
@@ -1281,10 +1289,7 @@ def legend_elements(self, prop="colors", num="auto",
             h = mlines.Line2D([0], [0], ls="", color=color, ms=size,
                               marker=self.get_paths()[0], **kw)
             handles.append(h)
-            if hasattr(fmt, "set_locs"):
-                fmt.set_locs(label_values)
-            l = fmt(lab)
-            labels.append(l)
+            labels.append(formatted)
 
         return handles, labels
 
diff --git a/lib/matplotlib/contour.py b/lib/matplotlib/contour.py
@@ -143,6 +143,11 @@ def clabel(self, levels=None, *,
         -------
         labels
             A list of `.Text` instances for the labels.
+
+            Note: The returned Text instances should not be individually
+            removed or have their geometry modified, e.g. by changing text or font size.
+            If you need such a modification, remove the entire
+            `.ContourSet` and recreate it.
         """
 
         if self.filled:
@@ -515,7 +520,14 @@ def labels(self, inline, inline_spacing):
     def remove(self):
         super().remove()
         for text in self.labelTexts:
-            text.remove()
+            try:
+                text.remove()
+            except ValueError:
+                _api.warn_external(
+                    "Some labels were manually removed before the ContourSet. "
+                    "To remove labels cleanly, remove the entire ContourSet "
+                    "and recreate it.")
+        self.labelTexts.clear()
 
 
 def _find_closest_point_on_path(xys, p):
diff --git a/lib/matplotlib/dates.py b/lib/matplotlib/dates.py
@@ -665,10 +665,6 @@ class ConciseDateFormatter(ticker.Formatter):
 
     """
 
-    offset_string = _api.deprecate_privatize_attribute(
-        "3.11", alternative="get_offset()"
-    )
-
     def __init__(self, locator, tz=None, formats=None, offset_formats=None,
                  zero_formats=None, show_offset=True, *, usetex=None):
         """
@@ -723,7 +719,7 @@ def __init__(self, locator, tz=None, formats=None, offset_formats=None,
                                    '%Y-%b-%d',
                                    '%Y-%b-%d',
                                    '%Y-%b-%d %H:%M']
-        self._offset_string = ''
+        self.offset_string = ''
         self.show_offset = show_offset
         self._usetex = mpl._val_or_rc(usetex, 'text.usetex')
 
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -2492,6 +2492,9 @@ def __init__(self,
             - a tuple ``(width, height)``, which is interpreted in inches, i.e. as
               ``(width, height, "in")``.
 
+            One of *width* or *height* may be ``None``; the respective value is
+            taken from :rc:`figure.figsize`.
+
         dpi : float, default: :rc:`figure.dpi`
             Dots per inch.
 
@@ -3155,6 +3158,10 @@ def set_size_inches(self, w, h=None, forward=True):
         """
         if h is None:  # Got called with a single pair as argument.
             w, h = w
+        if w is None or h is None:
+            raise ValueError(
+                "Figure.set_size_inches does not accept None; provide both "
+                "width and height explicitly")
         size = np.array([w, h])
         if not np.isfinite(size).all() or (size < 0).any():
             raise ValueError(f'figure size must be positive finite not {size}')
@@ -3763,25 +3770,40 @@ def _parse_figsize(figsize, dpi):
     """
     num_parts = len(figsize)
     if num_parts == 2:
-        return figsize
+        x, y = figsize
     elif num_parts == 3:
         x, y, unit = figsize
         if unit == 'in':
             pass
         elif unit == 'cm':
-            x /= 2.54
-            y /= 2.54
+            if x is not None:
+                x /= 2.54
+            if y is not None:
+                y /= 2.54
         elif unit == 'px':
-            x /= dpi
-            y /= dpi
+            if x is not None:
+                x /= dpi
+            if y is not None:
+                y /= dpi
         else:
             raise ValueError(
                 f"Invalid unit {unit!r} in 'figsize'; "
                 "supported units are 'in', 'cm', 'px'"
             )
-        return x, y
     else:
         raise ValueError(
             "Invalid figsize format, expected (x, y) or (x, y, unit) but got "
             f"{figsize!r}"
         )
+
+    if x is None and y is None:
+        raise ValueError(
+            "figsize=(None, None) is invalid; at least one of width or "
+            "height must be provided")
+
+    default_width, default_height = mpl.rcParams["figure.figsize"]
+    if x is None:
+        x = default_width
+    if y is None:
+        y = default_height
+    return x, y
diff --git a/lib/matplotlib/legend.py b/lib/matplotlib/legend.py
@@ -98,9 +98,11 @@ def _update_bbox_to_anchor(self, loc_in_canvas):
 _legend_kw_doc_base = """
 bbox_to_anchor : `.BboxBase`, 2-tuple, or 4-tuple of floats
     Box that is used to position the legend in conjunction with *loc*.
+    This is an advanced option for free placement of the legend. For
+    most use cases, *loc* alone is sufficient.
+
     Defaults to ``axes.bbox`` (if called as a method to `.Axes.legend`) or
-    ``figure.bbox`` (if ``figure.legend``).  This argument allows arbitrary
-    placement of the legend.
+    ``figure.bbox`` (if ``figure.legend``).
 
     Bbox coordinates are interpreted in the coordinate system given by
     *bbox_transform*, with the default transform
@@ -119,6 +121,9 @@ def _update_bbox_to_anchor(self, loc_in_canvas):
 
         loc='upper right', bbox_to_anchor=(0.5, 0.5)
 
+    For more details on legend positioning, see the
+    :ref:`legend_guide`.
+
 ncols : int, default: 1
     The number of columns that the legend has.
 
@@ -265,15 +270,19 @@ def _update_bbox_to_anchor(self, loc_in_canvas):
 loc : str or pair of floats, default: {default}
     The location of the legend.
 
-    The strings ``'upper left'``, ``'upper right'``, ``'lower left'``,
-    ``'lower right'`` place the legend at the corresponding corner of the
-    {parent}.
+    The string locations place the legend at the corresponding position
+    within the bounding box, which by default is the full {parent} area.
+    The bounding box can be changed via *bbox_to_anchor*.
 
-    The strings ``'upper center'``, ``'lower center'``, ``'center left'``,
-    ``'center right'`` place the legend at the center of the corresponding edge
-    of the {parent}.
+    The positions are visualized below::
 
-    The string ``'center'`` places the legend at the center of the {parent}.
+        +--------------+--------------+---------------+
+        | 'upper left' |'upper center'| 'upper right' |
+        +--------------+--------------+---------------+
+        |'center left' |   'center'   |'center right' |
+        +--------------+--------------+---------------+
+        | 'lower left' |'lower center'| 'lower right' |
+        +--------------+--------------+---------------+
 {best}
     The location can also be a 2-tuple giving the coordinates of the lower-left
     corner of the legend in {parent} coordinates (in which case *bbox_to_anchor*
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -947,6 +947,9 @@ def figure(
           "px".
         - a tuple ``(x, y)``, which is interpreted as ``(x, y, "inch")``.
 
+        One of *width* or *height* may be ``None``; the respective value is taken
+        from :rc:`figure.figsize`.
+
     dpi : float, default: :rc:`figure.dpi`
         The resolution of the figure in dots-per-inch.
 
diff --git a/lib/matplotlib/testing/jpl_units/UnitDblFormatter.py b/lib/matplotlib/testing/jpl_units/UnitDblFormatter.py
@@ -14,7 +14,7 @@ class UnitDblFormatter(ticker.ScalarFormatter):
 
     def __call__(self, x, pos=None):
         # docstring inherited
-        if len(self._locs) == 0:
+        if len(self.locs) == 0:
             return ''
         else:
             return f'{x:.12}'
diff --git a/lib/matplotlib/tests/test_contour.py b/lib/matplotlib/tests/test_contour.py
@@ -804,6 +804,15 @@ def test_contour_remove():
     assert ax.get_children() == orig_children
 
 
+def test_contour_remove_with_labels():
+    ax = plt.figure().add_subplot()
+    cs = ax.contour(np.arange(16).reshape((4, 4)))
+    labels = cs.clabel()
+    labels[0].remove()
+    with pytest.warns(UserWarning, match="Some labels were manually removed"):
+        cs.remove()
+
+
 def test_contour_no_args():
     fig, ax = plt.subplots()
     data = [[0, 1], [1, 0]]
diff --git a/lib/matplotlib/tests/test_figure.py b/lib/matplotlib/tests/test_figure.py
@@ -1576,6 +1576,7 @@ def test_subfigures_wspace_hspace():
 def test_subfigure_remove():
     fig = plt.figure()
     sfs = fig.subfigures(2, 2)
+    sfs[1, 1].subplots()
     sfs[1, 1].remove()
     assert len(fig.subfigs) == 3
 
@@ -1882,6 +1883,24 @@ def test_figsize(figsize, figsize_inches):
     assert tuple(fig.get_size_inches()) == figsize_inches
 
 
+def test_figsize_partial_none():
+    default_w, default_h = mpl.rcParams["figure.figsize"]
+
+    fig = plt.figure(figsize=(None, 4))
+    w, h = fig.get_size_inches()
+    assert (w, h) == (default_w, 4)
+
+    fig = plt.figure(figsize=(6, None))
+    w, h = fig.get_size_inches()
+    assert (w, h) == (6, default_h)
+
+
+def test_figsize_both_none():
+    with pytest.raises(ValueError,
+                       match=r"figsize=\(None, None\) is invalid"):
+        plt.figure(figsize=(None, None))
+
+
 def test_figsize_invalid_unit():
     with pytest.raises(ValueError, match="Invalid unit 'um'"):
         plt.figure(figsize=(6, 4, "um"))
diff --git a/lib/matplotlib/tests/test_ticker.py b/lib/matplotlib/tests/test_ticker.py
@@ -920,7 +920,7 @@ def test_scilimits(self, sci_type, scilimits, lim, orderOfMag, fewticks):
             ax.yaxis.set_major_locator(mticker.MaxNLocator(4))
 
         tmp_form.set_locs(ax.yaxis.get_majorticklocs())
-        assert orderOfMag == tmp_form._orderOfMagnitude
+        assert orderOfMag == tmp_form.orderOfMagnitude
 
     @pytest.mark.parametrize('value, expected', format_data)
     def test_format_data(self, value, expected):
diff --git a/lib/matplotlib/tests/test_widgets.py b/lib/matplotlib/tests/test_widgets.py
@@ -1817,3 +1817,19 @@ def test_parent_axes_removal():
     evt = DrawEvent('draw_event', fig.canvas, renderer)
     radio._clear(evt)
     checks._clear(evt)
+
+
+def test_cursor_overlapping_axes_blitting_warning():
+    """Test that a warning is raised and useblit is disabled for overlapping axes."""
+    fig = plt.figure()
+    ax1 = fig.add_axes([0.1, 0.1, 0.8, 0.8])
+    ax2 = fig.add_axes([0.2, 0.2, 0.6, 0.6])  # Explicitly overlaps ax1
+
+    match_text = (
+        "Cursor blitting is currently not supported on "
+        "overlapping axes"
+    )
+    with pytest.warns(UserWarning, match=match_text):
+        cursor = widgets.Cursor(ax1, useblit=True)
+
+    assert cursor.useblit is False
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
diff --git a/lib/matplotlib/ticker.pyi b/lib/matplotlib/ticker.pyi
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
diff --git a/subprojects/freetype-2.6.1.wrap b/subprojects/freetype-2.6.1.wrap
