Deprecate renderer parameter in do_3d_projection.

QuLogic · QuLogic · commit ed2b16ab9099 · 2020-10-22T18:40:09.000-04:00
diff --git a/doc/api/next_api_changes/deprecations/18302-ES.rst b/doc/api/next_api_changes/deprecations/18302-ES.rst
@@ -11,3 +11,10 @@ now deprecated:
 
 These attributes are all available via `.Axes3D`, which can be accessed via
 ``self.axes`` on all `.Artist`\s.
+
+``renderer`` argument of ``do_3d_projection`` method for ``Collection3D``/``Patch3D``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The ``renderer`` argument for the ``do_3d_projection`` method on
+``Collection3D`` and ``Patch3D`` is no longer necessary, and passing it during
+draw is deprecated.
diff --git a/lib/mpl_toolkits/mplot3d/art3d.py b/lib/mpl_toolkits/mplot3d/art3d.py
@@ -296,7 +296,8 @@ def set_segments(self, segments):
         self._segments3d = segments
         super().set_segments([])
 
-    def do_3d_projection(self, renderer):
+    @cbook._delete_parameter('3.4', 'renderer')
+    def do_3d_projection(self, renderer=None):
         """
         Project the points according to renderer matrix.
         """
@@ -314,7 +315,7 @@ def do_3d_projection(self, renderer):
     @artist.allow_rasterization
     def draw(self, renderer, project=False):
         if project:
-            self.do_3d_projection(renderer)
+            self.do_3d_projection()
         super().draw(renderer)
 
 
@@ -346,7 +347,8 @@ def get_path(self):
     def get_facecolor(self):
         return self._facecolor2d
 
-    def do_3d_projection(self, renderer):
+    @cbook._delete_parameter('3.4', 'renderer')
+    def do_3d_projection(self, renderer=None):
         s = self._segment3d
         xs, ys, zs = zip(*s)
         vxs, vys, vzs, vis = proj3d.proj_transform_clip(xs, ys, zs,
@@ -371,7 +373,8 @@ def set_3d_properties(self, path, zs=0, zdir='z'):
         Patch3D.set_3d_properties(self, path.vertices, zs=zs, zdir=zdir)
         self._code3d = path.codes
 
-    def do_3d_projection(self, renderer):
+    @cbook._delete_parameter('3.4', 'renderer')
+    def do_3d_projection(self, renderer=None):
         s = self._segment3d
         xs, ys, zs = zip(*s)
         vxs, vys, vzs, vis = proj3d.proj_transform_clip(xs, ys, zs,
@@ -481,7 +484,8 @@ def set_3d_properties(self, zs, zdir):
         self._edgecolor3d = self.get_edgecolor()
         self.stale = True
 
-    def do_3d_projection(self, renderer):
+    @cbook._delete_parameter('3.4', 'renderer')
+    def do_3d_projection(self, renderer=None):
         xs, ys, zs = self._offsets3d
         vxs, vys, vzs, vis = proj3d.proj_transform_clip(xs, ys, zs,
                                                         self.axes.M)
@@ -586,7 +590,8 @@ def set_linewidth(self, lw):
         super().set_linewidth(lw)
         self._linewidth3d = self.get_linewidth()
 
-    def do_3d_projection(self, renderer):
+    @cbook._delete_parameter('3.4', 'renderer')
+    def do_3d_projection(self, renderer=None):
         xs, ys, zs = self._offsets3d
         vxs, vys, vzs, vis = proj3d.proj_transform_clip(xs, ys, zs,
                                                         self.axes.M)
@@ -762,7 +767,8 @@ def set_sort_zpos(self, val):
         self._sort_zpos = val
         self.stale = True
 
-    def do_3d_projection(self, renderer):
+    @cbook._delete_parameter('3.4', 'renderer')
+    def do_3d_projection(self, renderer=None):
         """
         Perform the 3D projection for this object.
         """
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -407,18 +407,30 @@ def draw(self, renderer):
         }
 
         with cbook._setattr_cm(type(renderer), **props3d):
+            def do_3d_projection(artist):
+                if artist.__module__ == 'mpl_toolkits.mplot3d.art3d':
+                    # Our 3D Artists have deprecated the renderer parameter.
+                    return artist.do_3d_projection()
+
+                cbook.warn_deprecated(
+                    "3.4",
+                    message="The 'renderer' parameter of "
+                    "do_3d_projection() was deprecated in Matplotlib "
+                    "%(since)s and will be removed %(removal)s.")
+                return artist.do_3d_projection(renderer)
+
             # Calculate projection of collections and patches and zorder them.
             # Make sure they are drawn above the grids.
             zorder_offset = max(axis.get_zorder()
                                 for axis in self._get_axis_list()) + 1
             for i, col in enumerate(
                     sorted(self.collections,
-                           key=lambda col: col.do_3d_projection(renderer),
+                           key=do_3d_projection,
                            reverse=True)):
                 col.zorder = zorder_offset + i
             for i, patch in enumerate(
                     sorted(self.patches,
-                           key=lambda patch: patch.do_3d_projection(renderer),
+                           key=do_3d_projection,
                            reverse=True)):
                 patch.zorder = zorder_offset + i
 
