Refactor Annotation properties.

anntzer · anntzer · commit f81b06830af7 · 2020-02-16T11:10:01.000+01:00
- Make xycoords a property to validate inputs at set-time, rather than
  at draw time.
- First define get_anncoords and set_anncoords, and then the anncoords
  property from them (the dance is just so that anncoords and
  get_anncoords get different docstrings...) as that order avoids having
  to fiddle with fget and fset.
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -1460,19 +1460,10 @@ def _get_xy_transform(self, renderer, s):
 
     def _get_ref_xy(self, renderer):
         """
-        Return x, y (in display coordinate) that is to be used for a reference
+        Return x, y (in display coordinates) that is to be used for a reference
         of any offset coordinate.
         """
-        def is_offset(s):
-            return isinstance(s, str) and s.split()[0] == "offset"
-
-        if isinstance(self.xycoords, tuple):
-            if any(map(is_offset, self.xycoords)):
-                raise ValueError("xycoords should not be an offset coordinate")
-        elif is_offset(self.xycoords):
-            raise ValueError("xycoords should not be an offset coordinate")
-        x, y = self.xy
-        return self._get_xy(renderer, x, y, self.xycoords)
+        return self._get_xy(renderer, *self.xy, self.xycoords)
 
     # def _get_bbox(self, renderer):
     #     if hasattr(bbox, "bounds"):
@@ -1795,10 +1786,24 @@ def contains(self, event):
             contains = contains or in_patch
         return contains, tinfo
 
+    @property
+    def xycoords(self):
+        return self._xycoords
+
+    @xycoords.setter
+    def xycoords(self, xycoords):
+        def is_offset(s):
+            return isinstance(s, str) and s.startswith("offset")
+
+        if (isinstance(xycoords, tuple) and any(map(is_offset, xycoords))
+                or is_offset(xycoords)):
+            raise ValueError("xycoords cannot be an offset coordinate")
+        self._xycoords = xycoords
+
     @property
     def xyann(self):
         """
-        The the text position.
+        The text position.
 
         See also *xytext* in `.Annotation`.
         """
@@ -1808,28 +1813,24 @@ def xyann(self):
     def xyann(self, xytext):
         self.set_position(xytext)
 
-    @property
-    def anncoords(self):
-        """The coordinate system to use for `.Annotation.xyann`."""
-        return self._textcoords
-
-    @anncoords.setter
-    def anncoords(self, coords):
-        self._textcoords = coords
+    def get_anncoords(self):
+        """
+        Return the coordinate system to use for `.Annotation.xyann`.
 
-    get_anncoords = anncoords.fget
-    get_anncoords.__doc__ = """
-    Return the coordinate system to use for `.Annotation.xyann`.
+        See also *xycoords* in `.Annotation`.
+        """
+        return self._textcoords
 
-    See also *xycoords* in `.Annotation`.
-    """
+    def set_anncoords(self, coords):
+        """
+        Set the coordinate system to use for `.Annotation.xyann`.
 
-    set_anncoords = anncoords.fset
-    set_anncoords.__doc__ = """
-    Set the coordinate system to use for `.Annotation.xyann`.
+        See also *xycoords* in `.Annotation`.
+        """
+        self._textcoords = coords
 
-    See also *xycoords* in `.Annotation`.
-    """
+    anncoords = property(get_anncoords, set_anncoords, doc="""
+        The coordinate system to use for `.Annotation.xyann`.""")
 
     def set_figure(self, fig):
         # docstring inherited
