Deprecate tostring_rgb.

anntzer · anntzer · commit 9c79686a3081 · 2023-03-17T12:02:56.000+01:00
As noted previously, silently dropping alpha can be confusing.  Also,
directly accessing the buffer array is more efficient (it does not
involve copying to a string buffer) and should cover most use cases.
diff --git a/doc/api/next_api_changes/deprecations/XXXXX-AL.rst b/doc/api/next_api_changes/deprecations/XXXXX-AL.rst
@@ -0,0 +1,3 @@
+``RendererAgg.tostring_rgb`` and ``FigureCanvasAgg.tostring_rgb``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+... are deprecated with no replacement.
diff --git a/lib/matplotlib/backends/backend_agg.py b/lib/matplotlib/backends/backend_agg.py
@@ -280,6 +280,7 @@ def buffer_rgba(self):
     def tostring_argb(self):
         return np.asarray(self._renderer).take([3, 0, 1, 2], axis=2).tobytes()
 
+    @_api.deprecated("3.8")
     def tostring_rgb(self):
         return np.asarray(self._renderer).take([0, 1, 2], axis=2).tobytes()
 
@@ -414,6 +415,7 @@ def get_renderer(self, cleared=False):
             self.renderer.clear()
         return self.renderer
 
+    @_api.deprecated("3.8")
     def tostring_rgb(self):
         """
         Get the image as RGB `bytes`.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+``RendererAgg.tostring_rgb`` and ``FigureCanvasAgg.tostring_rgb``
	`2`	`+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
	`3`	`+... are deprecated with no replacement.`