ENH: Validate kwargs in Axis.set_ticks()

j1642 · j1642 · commit 86c94c1ec412 · 2022-11-04T18:48:20.000-04:00
diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -2029,6 +2029,19 @@ def set_ticks(self, ticks, labels=None, *, minor=False, **kwargs):
         other limits, you should set the limits explicitly after setting the
         ticks.
         """
+        if labels is None and kwargs:
+            raise Exception('labels keyword argument cannot be None when '
+                            'kwargs are passed')
+        text_properties = []
+        for attribute in dir(mtext.Text()):
+            if attribute.startswith('set_'):
+                if attribute not in ('set_name', 'set_fontname'):
+                    text_properties.append(attribute[4:])
+        for kw in kwargs:
+            if kw not in text_properties:
+                raise Exception(f"kwarg '{kw}' not a property of "
+                                "matplotlib.text.Text")
+
         result = self._set_tick_locations(ticks, minor=minor)
         if labels is not None:
             self.set_ticklabels(labels, minor=minor, **kwargs)
diff --git a/lib/matplotlib/tests/test_axes.py b/lib/matplotlib/tests/test_axes.py
@@ -5732,6 +5732,83 @@ def test_set_get_ticklabels():
     ax[1].set_yticklabels(ax[0].get_yticklabels())
 
 
+def test_set_ticks_kwarg_validation():
+    """
+    Only matplotlib.text.Text properties are valid kwargs in axis.set_ticks.
+    """
+    fig, ax = plt.subplots()
+    ticks = [1, 2, 3]
+    ax.set_xticks(ticks, labels=['1', '2', '3'],
+                        agg_filter=0,
+                        alpha=0.5,
+                        animated=False,
+                        backgroundcolor='blue',
+                        bbox=None,
+                        clip_box=None,
+                        clip_on=None,
+                        clip_path=None,
+                        c='blue',
+                        color='blue',
+                        figure=fig,
+                        fontfamily='serif',
+                        family='serif',
+                        fontproperties=None,
+                        font=None,
+                        font_properties=None,
+                        fontsize='small',
+                        size='small',
+                        fontstretch=100,
+                        stretch='condensed',
+                        fontstyle='normal',
+                        style='normal',
+                        fontvariant='normal',
+                        variant='normal',
+                        fontweight='500',
+                        weight='medium',
+                        gid=None,
+                        horizontalalignment='center',
+                        ha='center',
+                        in_layout=True,
+                        label='label',
+                        linespacing=1.0,
+                        math_fontfamily='cm',
+                        mouseover=False,
+                        multialignment='center',
+                        ma='center',
+                        parse_math=False,
+                        path_effects=None,
+                        picker=None,
+                        position=(1.0, 1.0),
+                        rasterized=True,
+                        rotation=0.0,
+                        rotation_mode=None,
+                        sketch_params=(1.0, 1.0, 1.0),
+                        snap=None,
+                        text='text',
+                        transform=None,
+                        transform_rotates_text=False,
+                        url='',
+                        usetex=False,
+                        verticalalignment='center',
+                        va='center',
+                        visible=True,
+                        wrap=True,
+                        x=1.0,
+                        y=1.0,
+                        zorder=1.0)
+
+
+def test_set_ticks_kwargs_raise_error_without_labels():
+    """
+    When labels=None and any kwarg is passed, axis.set_ticks raises an
+    Exception.
+    """
+    fig, ax = plt.subplots()
+    ticks = [1, 2, 3]
+    with pytest.raises(Exception):
+        ax.set_ticks(ticks, alpha=0.5)
+
+
 @check_figures_equal(extensions=["png"])
 def test_set_ticks_with_labels(fig_test, fig_ref):
     """
