Merge pull request #22485 from timhoffm/Axes-str

dstansby · web-flow · commit 2e3e27b4a045 · 2022-02-18T15:19:03.000Z
Change string representation of AxesImage
diff --git a/doc/api/next_api_changes/behavior/22485-TH.rst b/doc/api/next_api_changes/behavior/22485-TH.rst
@@ -0,0 +1,5 @@
+``AxesImage`` string representation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The string representation of `.AxesImage` changes from
+stating the position in the figure ``"AxesImage(80,52.8;496x369.6)"`` to
+giving the number of pixels ``"AxesImage(size=(300, 200))"``.
diff --git a/lib/matplotlib/image.py b/lib/matplotlib/image.py
@@ -275,6 +275,13 @@ def __init__(self, ax,
 
         self._internal_update(kwargs)
 
+    def __str__(self):
+        try:
+            size = self.get_size()
+            return f"{type(self).__name__}(size={size!r})"
+        except RuntimeError:
+            return type(self).__name__
+
     def __getstate__(self):
         # Save some space on the pickle by not saving the cache.
         return {**super().__getstate__(), "_imcache": None}
@@ -896,8 +903,6 @@ class AxesImage(_ImageBase):
         the output image is larger than the input image.
     **kwargs : `.Artist` properties
     """
-    def __str__(self):
-        return "AxesImage(%g,%g;%gx%g)" % tuple(self.axes.bbox.bounds)
 
     def __init__(self, ax,
                  cmap=None,
