Tests, fix, and whats new from code review

scottshambaugh · scottshambaugh · commit 724e80cf7ad6 · 2023-07-31T11:40:52.000-06:00
Code review commits

Test image for axis positions
diff --git a/doc/users/next_whats_new/3d_axis_positions.rst b/doc/users/next_whats_new/3d_axis_positions.rst
@@ -8,10 +8,13 @@ You can now specify the positions of ticks and axis labels for 3D plots.
 
    import matplotlib.pyplot as plt
 
-   positions = ['default', 'upper', 'lower', 'both', 'none']
-   fig, axs = plt.subplots(1, 5, subplot_kw={'projection': '3d'})
-   for ax, pos in zip(axs, positions):
+   positions = ['lower', 'upper', 'default', 'both', 'none']
+   fig, axs = plt.subplots(2, 3, figsize=(12, 8),
+                           subplot_kw={'projection': '3d'})
+   for ax, pos in zip(axs.flatten(), positions):
        for axis in ax.xaxis, ax.yaxis, ax.zaxis:
-           axis._label_position = pos
-           axis._tick_position = pos
-       ax.set(xlabel='x', ylabel='y', zlabel='z', title=pos)
+           axis.set_label_position(pos)
+           axis.set_ticks_position(pos)
+       title = f'position="{pos}"'
+       ax.set(xlabel='x', ylabel='y', zlabel='z', title=title)
+   axs[1, 2].axis('off')
diff --git a/lib/mpl_toolkits/mplot3d/axis3d.py b/lib/mpl_toolkits/mplot3d/axis3d.py
@@ -195,6 +195,11 @@ def set_ticks_position(self, position):
         str : {'lower', 'upper', 'both', 'default', 'none'}
             The position of the bolded axis lines, ticks, and tick labels.
         """
+        if position in ['top', 'bottom']:
+            _api.warn_deprecated('3.8', name=f'{position=}',
+                                 obj_type='argument value',
+                                 alternative="'upper' or 'lower'")
+            return
         _api.check_in_list(['lower', 'upper', 'both', 'default', 'none'],
                            position=position)
         self._tick_position = position
@@ -219,6 +224,11 @@ def set_label_position(self, position):
         str : {'lower', 'upper', 'both', 'default', 'none'}
             The position of the axis label.
         """
+        if position in ['top', 'bottom']:
+            _api.warn_deprecated('3.8', name=f'{position=}',
+                                 obj_type='argument value',
+                                 alternative="'upper' or 'lower'")
+            return
         _api.check_in_list(['lower', 'upper', 'both', 'default', 'none'],
                            position=position)
         self._label_position = position
@@ -345,7 +355,7 @@ def _get_all_axis_line_edge_points(self, minmax, maxmin, axis_position=None):
                                                                  position='lower')
             edgep1_u, edgep2_u = self._get_axis_line_edge_points(minmax, maxmin,
                                                                  position='upper')
-            if position in ('lower', 'both'):
+            if axis_position in ('lower', 'both'):
                 edgep1s.append(edgep1_l)
                 edgep2s.append(edgep2_l)
                 position.append('lower')
@@ -381,14 +391,14 @@ def _get_tickdir(self, position):
                 tickdirs_base = [2, 2, 0]
             else:
                 tickdirs_base = [1, 0, 0]
-            if (0 <= azim_mod < 180):
+            if 0 <= azim_mod < 180:
                 tickdirs_base[2] = 1
         elif position == 'lower':
             if elev_mod >= 0:
                 tickdirs_base = [1, 0, 1]
             else:
                 tickdirs_base = [2, 2, 1]
-            if (0 <= azim_mod < 180):
+            if 0 <= azim_mod < 180:
                 tickdirs_base[2] = 0
         info_i = [v["i"] for v in self._AXINFO.values()]
 
diff --git a/lib/mpl_toolkits/mplot3d/tests/baseline_images/test_axes3d/axis_positions.png b/lib/mpl_toolkits/mplot3d/tests/baseline_images/test_axes3d/axis_positions.png
diff --git a/lib/mpl_toolkits/mplot3d/tests/test_axes3d.py b/lib/mpl_toolkits/mplot3d/tests/test_axes3d.py
@@ -57,6 +57,18 @@ def test_invisible_ticks_axis():
         axis.line.set_visible(False)
 
 
+@mpl3d_image_comparison(['axis_positions.png'], remove_text=False, style='mpl20')
+def test_axis_positions():
+    positions = ['upper', 'lower', 'both', 'none']
+    fig, axs = plt.subplots(2, 2, subplot_kw={'projection': '3d'})
+    for ax, pos in zip(axs.flatten(), positions):
+        for axis in ax.xaxis, ax.yaxis, ax.zaxis:
+            axis.set_label_position(pos)
+            axis.set_ticks_position(pos)
+        title = f'{pos}'
+        ax.set(xlabel='x', ylabel='y', zlabel='z', title=title)
+
+
 @mpl3d_image_comparison(['aspects.png'], remove_text=False, style='mpl20')
 def test_aspects():
     aspects = ('auto', 'equal', 'equalxy', 'equalyz', 'equalxz', 'equal')
