improve arg name, docstring, add test

immaxchen · immaxchen · commit 3dd913eff732 · 2019-11-12T01:08:45.000+08:00
diff --git a/lib/matplotlib/tests/test_text.py b/lib/matplotlib/tests/test_text.py
@@ -2,16 +2,16 @@
 import warnings
 
 import numpy as np
-from numpy.testing import assert_almost_equal
 import pytest
+from numpy.testing import assert_almost_equal
 
 import matplotlib
-from matplotlib.backend_bases import MouseEvent
 import matplotlib.patches as mpatches
 import matplotlib.pyplot as plt
+import matplotlib.transforms as mtransforms
+from matplotlib.backend_bases import MouseEvent
 from matplotlib.testing.decorators import check_figures_equal, image_comparison
 
-
 needs_usetex = pytest.mark.skipif(
     not matplotlib.checkdep_usetex(True),
     reason="This test needs a TeX installation")
@@ -635,3 +635,12 @@ def test_buffer_size(fig_test, fig_ref):
     ax = fig_ref.add_subplot()
     ax.set_yticks([0, 1])
     ax.set_yticklabels(["€", ""])
+
+
+def test_transform_rotates_text():
+    ax = plt.gca()
+    transform = mtransforms.Affine2D().rotate_deg(30)
+    text = ax.text(0, 0, 'test', transform=transform,
+                   transform_rotates_text=True)
+    result = text.get_rotation()[0]
+    assert_almost_equal(result, 30)
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -130,7 +130,7 @@ def __init__(self,
                  rotation_mode=None,
                  usetex=None,          # defaults to rcParams['text.usetex']
                  wrap=False,
-                 rotation_transformed=False,
+                 transform_rotates_text=False,
                  **kwargs
                  ):
         """
@@ -159,7 +159,7 @@ def __init__(self,
         self.set_horizontalalignment(horizontalalignment)
         self._multialignment = multialignment
         self._rotation = rotation
-        self._rotation_transformed = rotation_transformed
+        self._transform_rotates_text = transform_rotates_text
         self._fontproperties = fontproperties
         self._bbox_patch = None  # a FancyBboxPatch instance
         self._renderer = None
@@ -237,16 +237,18 @@ def _get_multialignment(self):
 
     def get_rotation(self):
         """Return the text angle as float in degrees."""
-        if self.get_rotation_transformed():
+        if self.get_transform_rotates_text():
             angle = get_rotation(self._rotation)
             x, y = self.get_unitless_position()
             return self.get_transform().transform_angles([angle, ], [[x, y]])
         else:
             return get_rotation(self._rotation)  # string_or_number -> number
 
-    def get_rotation_transformed(self):
-        """Return if the text rotation get transformed or not."""
-        return self._rotation_transformed
+    def get_transform_rotates_text(self):
+        """
+        Return whether rotations of the transform affect the text direction.
+        """
+        return self._transform_rotates_text
 
     def set_rotation_mode(self, m):
         """
@@ -276,7 +278,7 @@ def update_from(self, other):
         self._horizontalalignment = other._horizontalalignment
         self._fontproperties = other._fontproperties.copy()
         self._rotation = other._rotation
-        self._rotation_transformed = other._rotation_transformed
+        self._transform_rotates_text = other._transform_rotates_text
         self._picker = other._picker
         self._linespacing = other._linespacing
         self.stale = True
@@ -861,7 +863,7 @@ def get_prop_tup(self, renderer=None):
                 self._verticalalignment, self._horizontalalignment,
                 hash(self._fontproperties),
                 self._rotation, self._rotation_mode,
-                self._rotation_transformed,
+                self._transform_rotates_text,
                 self.figure.dpi, weakref.ref(renderer),
                 self._linespacing
                 )
@@ -1147,15 +1149,15 @@ def set_rotation(self, s):
         self._rotation = s
         self.stale = True
 
-    def set_rotation_transformed(self, t):
+    def set_transform_rotates_text(self, t):
         """
-        Set if the text rotation get transformed or not.
+        Whether rotations of the transform affect the text direction.
 
         Parameters
         ----------
         t : bool
         """
-        self._rotation_transformed = t
+        self._transform_rotates_text = t
         self.stale = True
 
     def set_verticalalignment(self, align):
