Replace text._wrap_text by _cm_set().

anntzer · anntzer · commit d32d3f8443a3 · 2021-05-24T13:05:34.000+02:00
This makes it clearer that `textobj` is actually the same object as
`self`.
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -2,7 +2,6 @@
 Classes for including text in a figure.
 """
 
-import contextlib
 import logging
 import math
 import weakref
@@ -22,20 +21,6 @@
 _log = logging.getLogger(__name__)
 
 
-@contextlib.contextmanager
-def _wrap_text(textobj):
-    """Temporarily inserts newlines if the wrap option is enabled."""
-    if textobj.get_wrap():
-        old_text = textobj.get_text()
-        try:
-            textobj.set_text(textobj._get_wrapped_text())
-            yield textobj
-        finally:
-            textobj.set_text(old_text)
-    else:
-        yield textobj
-
-
 # Extracted from Text's method to serve as a function
 def get_rotation(rotation):
     """
@@ -631,9 +616,12 @@ def _get_rendered_text_width(self, text):
 
     def _get_wrapped_text(self):
         """
-        Return a copy of the text with new lines added, so that
-        the text is wrapped relative to the parent figure.
+        Return a copy of the text string with new lines added so that the text
+        is wrapped relative to the parent figure (if `get_wrap` is True).
         """
+        if not self.get_wrap():
+            return self.get_text()
+
         # Not fit to handle breaking up latex syntax correctly, so
         # ignore latex for now.
         if self.get_usetex():
@@ -690,14 +678,14 @@ def draw(self, renderer):
 
         renderer.open_group('text', self.get_gid())
 
-        with _wrap_text(self) as textobj:
-            bbox, info, descent = textobj._get_layout(renderer)
-            trans = textobj.get_transform()
+        with self._cm_set(text=self._get_wrapped_text()):
+            bbox, info, descent = self._get_layout(renderer)
+            trans = self.get_transform()
 
-            # don't use textobj.get_position here, which refers to text
+            # don't use self.get_position here, which refers to text
             # position in Text:
-            posx = float(textobj.convert_xunits(textobj._x))
-            posy = float(textobj.convert_yunits(textobj._y))
+            posx = float(self.convert_xunits(self._x))
+            posy = float(self.convert_yunits(self._y))
             posx, posy = trans.transform((posx, posy))
             if not np.isfinite(posx) or not np.isfinite(posy):
                 _log.warning("posx and posy should be finite values")
@@ -706,41 +694,41 @@ def draw(self, renderer):
 
             # Update the location and size of the bbox
             # (`.patches.FancyBboxPatch`), and draw it.
-            if textobj._bbox_patch:
+            if self._bbox_patch:
                 self.update_bbox_position_size(renderer)
                 self._bbox_patch.draw(renderer)
 
             gc = renderer.new_gc()
-            gc.set_foreground(textobj.get_color())
-            gc.set_alpha(textobj.get_alpha())
-            gc.set_url(textobj._url)
-            textobj._set_gc_clip(gc)
+            gc.set_foreground(self.get_color())
+            gc.set_alpha(self.get_alpha())
+            gc.set_url(self._url)
+            self._set_gc_clip(gc)
 
-            angle = textobj.get_rotation()
+            angle = self.get_rotation()
 
             for line, wh, x, y in info:
 
-                mtext = textobj if len(info) == 1 else None
+                mtext = self if len(info) == 1 else None
                 x = x + posx
                 y = y + posy
                 if renderer.flipy():
                     y = canvash - y
-                clean_line, ismath = textobj._preprocess_math(line)
+                clean_line, ismath = self._preprocess_math(line)
 
-                if textobj.get_path_effects():
+                if self.get_path_effects():
                     from matplotlib.patheffects import PathEffectRenderer
                     textrenderer = PathEffectRenderer(
-                        textobj.get_path_effects(), renderer)
+                        self.get_path_effects(), renderer)
                 else:
                     textrenderer = renderer
 
-                if textobj.get_usetex():
+                if self.get_usetex():
                     textrenderer.draw_tex(gc, x, y, clean_line,
-                                          textobj._fontproperties, angle,
+                                          self._fontproperties, angle,
                                           mtext=mtext)
                 else:
                     textrenderer.draw_text(gc, x, y, clean_line,
-                                           textobj._fontproperties, angle,
+                                           self._fontproperties, angle,
                                            ismath=ismath, mtext=mtext)
 
         gc.restore()
