Improve argument checking

Author: oscargus

lib/mpl_toolkits/axes_grid1/axes_divider.py

@@ -39,7 +39,8 @@ def __init__(self, fig, pos, horizontal, vertical,
         aspect : bool
             Whether overall rectangular area is reduced so that the relative
             part of the horizontal and vertical scales have the same scale.
-        anchor : {'C', 'SW', 'S', 'SE', 'E', 'NE', 'N', 'NW', 'W'}
+        anchor : (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', 'N', \
+'NW', 'W'}
             Placement of the reduced rectangle, when *aspect* is True.
         """
 
@@ -48,6 +49,7 @@ def __init__(self, fig, pos, horizontal, vertical,
         self._horizontal = horizontal
         self._vertical = vertical
         self._anchor = anchor
+        self.set_anchor(anchor)
         self._aspect = aspect
         self._xrefindex = 0
         self._yrefindex = 0
@@ -106,7 +108,8 @@ def set_anchor(self, anchor):
         """
         Parameters
         ----------
-        anchor : (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
+        anchor : (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', 'N', \
+'NW', 'W'}
             Either an (*x*, *y*) pair of relative coordinates (0 is left or
             bottom, 1 is right or top), 'C' (center), or a cardinal direction
             ('SW', southwest, is bottom left, etc.).
@@ -115,8 +118,10 @@ def set_anchor(self, anchor):
         --------
         .Axes.set_anchor
         """
-        if len(anchor) != 2:
+        if isinstance(anchor, str):
             _api.check_in_list(mtransforms.Bbox.coefs, anchor=anchor)
+        elif not isinstance(anchor, (tuple, list)) or len(anchor) != 2:
+            raise TypeError("anchor must be str or 2-tuple")
         self._anchor = anchor
 
     def get_anchor(self):
@@ -511,20 +516,14 @@ def append_axes(self, position, size, pad=None, add_to_figure=True, *,
         **kwargs
             All extra keywords arguments are passed to the created axes.
         """
-        _api.check_in_list(["left", "right", "bottom", "top"],
-                           position=position)
-        if position == "left":
-            ax = self.new_horizontal(
-                size, pad, pack_start=True, axes_class=axes_class, **kwargs)
-        elif position == "right":
-            ax = self.new_horizontal(
-                size, pad, pack_start=False, axes_class=axes_class, **kwargs)
-        elif position == "bottom":
-            ax = self.new_vertical(
-                size, pad, pack_start=True, axes_class=axes_class, **kwargs)
-        else:  # "top"
-            ax = self.new_vertical(
-                size, pad, pack_start=False, axes_class=axes_class, **kwargs)
+        create_axes, pack_start = _api.check_getitem({
+            "left": (self.new_horizontal, True),
+            "right": (self.new_horizontal, False),
+            "bottom": (self.new_vertical, True),
+            "top": (self.new_vertical, False),
+        }, position=position)
+        ax = create_axes(
+            size, pad, pack_start=pack_start, axes_class=axes_class, **kwargs)
         if add_to_figure:
             self._fig.add_axes(ax)
         return ax

lib/mpl_toolkits/axes_grid1/axes_grid.py

@@ -271,6 +271,7 @@ def set_label_mode(self, mode):
             - "1": Only the bottom left axes is labelled.
             - "all": all axes are labelled.
         """
+        _api.check_in_list(["all", "L", "1"], mode=mode)
         if mode == "all":
             for ax in self.axes_all:
                 _tick_only(ax, False, False)
@@ -291,7 +292,7 @@ def set_label_mode(self, mode):
                 ax = col[-1]
                 _tick_only(ax, bottom_on=False, left_on=True)
 
-        elif mode == "1":
+        else:  # "1"
             for ax in self.axes_all:
                 _tick_only(ax, bottom_on=True, left_on=True)
 
@@ -379,6 +380,10 @@ def __init__(self, fig,
             to associated *cbar_axes*.
         axes_class : subclass of `matplotlib.axes.Axes`, default: None
         """
+        _api.check_in_list(["each", "single", "edge", None],
+                           cbar_mode=cbar_mode)
+        _api.check_in_list(["left", "right", "bottom", "top"],
+                           cbar_location=cbar_location)
         self._colorbar_mode = cbar_mode
         self._colorbar_location = cbar_location
         self._colorbar_pad = cbar_pad

lib/mpl_toolkits/tests/test_axes_grid1.py

@@ -17,7 +17,7 @@
 from mpl_toolkits.axes_grid1.anchored_artists import (
     AnchoredSizeBar, AnchoredDirectionArrows)
 from mpl_toolkits.axes_grid1.axes_divider import (
-    HBoxDivider, make_axes_area_auto_adjustable)
+    Divider, HBoxDivider, make_axes_area_auto_adjustable)
 from mpl_toolkits.axes_grid1.axes_rgb import RGBAxes
 from mpl_toolkits.axes_grid1.inset_locator import (
     zoomed_inset_axes, mark_inset, inset_axes, BboxConnectorPatch)
@@ -518,6 +518,18 @@ def test_grid_errors(rect, ngrids, error, message):
         Grid(fig, rect, (2, 3), ngrids=ngrids)
 
 
+@pytest.mark.parametrize('anchor, error, message', (
+    (None, TypeError, "anchor must be str"),
+    ("CC", ValueError, "'CC' is not a valid value for anchor"),
+    ((1, 1, 1), TypeError, "anchor must be str"),
+))
+def test_divider_errors(anchor, error, message):
+    fig = plt.figure()
+    with pytest.raises(error, match=message):
+        Divider(fig, [0, 0, 1, 1], [Size.Fixed(1)], [Size.Fixed(1)],
+                anchor=anchor)
+
+
 @check_figures_equal(extensions=["png"])
 def test_mark_inset_unstales_viewlim(fig_test, fig_ref):
     inset, full = fig_test.subplots(1, 2)