Declare all property aliases together.

anntzer · anntzer · commit ef7a035878ac · 2018-02-02T08:57:56.000-08:00
diff --git a/lib/matplotlib/cbook/__init__.py b/lib/matplotlib/cbook/__init__.py
@@ -2803,3 +2803,37 @@ def _str_lower_equal(obj, s):
     cannot be used in a boolean context.
     """
     return isinstance(obj, six.string_types) and obj.lower() == s
+
+
+def _define_aliases(local_d, alias_d):
+    """Define property aliases.
+
+    Use in a class definition as ::
+
+        cbook._define_aliases(locals(), {
+            "property": ["alias", ...], ...
+        })
+
+    For each property, if the corresponding ``get_property`` is defined in the
+    class so far, an alias named ``get_alias`` will be defined; the same will
+    be done for setters.  If neither the getter nor the setter exists, an
+    exception will be raised.
+    """
+
+    def make_alias(name):  # Enfore a closure over *name*.
+        def method(self, *args, **kwargs):
+            return getattr(self, name)(*args, **kwargs)
+        method.__doc__ = "alias for {}".format(name)
+        return method
+
+    for prop, aliases in alias_d.items():
+        exists = False
+        for prefix in ["get_", "set_"]:
+            if prefix + prop in local_d:
+                exists = True
+                for alias in aliases:
+                    method = make_alias(prefix + prop)
+                    method.__name__ = str(prefix + alias)  # Py2 compat.
+                    local_d[prefix + alias] = method
+        if not exists:
+            raise ValueError("property {} does not exist".format(prop))
diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -505,14 +505,6 @@ def set_linewidth(self, lw):
             self._us_lw, self._us_linestyles)
         self.stale = True
 
-    def set_linewidths(self, lw):
-        """alias for set_linewidth"""
-        return self.set_linewidth(lw)
-
-    def set_lw(self, lw):
-        """alias for set_linewidth"""
-        return self.set_linewidth(lw)
-
     def set_linestyle(self, ls):
         """
         Set the linestyle(s) for the collection.
@@ -640,14 +632,6 @@ def _bcast_lwls(linewidths, dashes):
 
         return linewidths, dashes
 
-    def set_linestyles(self, ls):
-        """alias for set_linestyle"""
-        return self.set_linestyle(ls)
-
-    def set_dashes(self, ls):
-        """alias for set_linestyle"""
-        return self.set_linestyle(ls)
-
     def set_antialiased(self, aa):
         """
         Set the antialiasing state for rendering.
@@ -659,10 +643,6 @@ def set_antialiased(self, aa):
         self._antialiaseds = np.atleast_1d(np.asarray(aa, bool))
         self.stale = True
 
-    def set_antialiaseds(self, aa):
-        """alias for set_antialiased"""
-        return self.set_antialiased(aa)
-
     def set_color(self, c):
         """
         Set both the edgecolor and the facecolor.
@@ -704,21 +684,15 @@ def set_facecolor(self, c):
         self._original_facecolor = c
         self._set_facecolor(c)
 
-    def set_facecolors(self, c):
-        """alias for set_facecolor"""
-        return self.set_facecolor(c)
-
     def get_facecolor(self):
         return self._facecolors
-    get_facecolors = get_facecolor
 
     def get_edgecolor(self):
         if (isinstance(self._edgecolors, six.string_types)
                    and self._edgecolors == str('face')):
             return self.get_facecolors()
         else:
             return self._edgecolors
-    get_edgecolors = get_edgecolor
 
     def _set_edgecolor(self, c):
         set_hatch_color = True
@@ -764,10 +738,6 @@ def set_edgecolor(self, c):
         self._original_edgecolor = c
         self._set_edgecolor(c)
 
-    def set_edgecolors(self, c):
-        """alias for set_edgecolor"""
-        return self.set_edgecolor(c)
-
     def set_alpha(self, alpha):
         """
         Set the alpha tranparencies of the collection.  *alpha* must be
@@ -785,13 +755,11 @@ def set_alpha(self, alpha):
         self._set_facecolor(self._original_facecolor)
         self._set_edgecolor(self._original_edgecolor)
 
-    def get_linewidths(self):
+    def get_linewidth(self):
         return self._linewidths
-    get_linewidth = get_linewidths
 
-    def get_linestyles(self):
+    def get_linestyle(self):
         return self._linestyles
-    get_dashes = get_linestyle = get_linestyles
 
     def update_scalarmappable(self):
         """
@@ -836,6 +804,14 @@ def update_from(self, other):
         # self.update_dict = other.update_dict # do we need to copy this? -JJL
         self.stale = True
 
+    cbook._define_aliases(locals(), {
+        "antialiased": ["antialiaseds"],
+        "edgecolor": ["edgecolors"],
+        "facecolor": ["facecolors"],
+        "linestyle": ["linestyles", "dashes"],
+        "linewidth": ["linewidths", "lw"],
+    })
+
 # these are not available for the object inspector until after the
 # class is built so we define an initial set here for the init
 # function and they will be overridden after object defn
diff --git a/lib/matplotlib/lines.py b/lib/matplotlib/lines.py
@@ -1265,79 +1265,6 @@ def _get_rgba_face(self, alt=False):
     def _get_rgba_ln_color(self, alt=False):
         return mcolors.to_rgba(self._color, self._alpha)
 
-    # some aliases....
-    def set_aa(self, val):
-        'alias for set_antialiased'
-        self.set_antialiased(val)
-
-    def set_c(self, val):
-        'alias for set_color'
-        self.set_color(val)
-
-    def set_ls(self, val):
-        """alias for set_linestyle"""
-        self.set_linestyle(val)
-
-    def set_lw(self, val):
-        """alias for set_linewidth"""
-        self.set_linewidth(val)
-
-    def set_mec(self, val):
-        """alias for set_markeredgecolor"""
-        self.set_markeredgecolor(val)
-
-    def set_mew(self, val):
-        """alias for set_markeredgewidth"""
-        self.set_markeredgewidth(val)
-
-    def set_mfc(self, val):
-        """alias for set_markerfacecolor"""
-        self.set_markerfacecolor(val)
-
-    def set_mfcalt(self, val):
-        """alias for set_markerfacecoloralt"""
-        self.set_markerfacecoloralt(val)
-
-    def set_ms(self, val):
-        """alias for set_markersize"""
-        self.set_markersize(val)
-
-    def get_aa(self):
-        """alias for get_antialiased"""
-        return self.get_antialiased()
-
-    def get_c(self):
-        """alias for get_color"""
-        return self.get_color()
-
-    def get_ls(self):
-        """alias for get_linestyle"""
-        return self.get_linestyle()
-
-    def get_lw(self):
-        """alias for get_linewidth"""
-        return self.get_linewidth()
-
-    def get_mec(self):
-        """alias for get_markeredgecolor"""
-        return self.get_markeredgecolor()
-
-    def get_mew(self):
-        """alias for get_markeredgewidth"""
-        return self.get_markeredgewidth()
-
-    def get_mfc(self):
-        """alias for get_markerfacecolor"""
-        return self.get_markerfacecolor()
-
-    def get_mfcalt(self, alt=False):
-        """alias for get_markerfacecoloralt"""
-        return self.get_markerfacecoloralt()
-
-    def get_ms(self):
-        """alias for get_markersize"""
-        return self.get_markersize()
-
     def set_dash_joinstyle(self, s):
         """
         Set the join style for dashed linestyles
@@ -1421,6 +1348,18 @@ def is_dashed(self):
         'return True if line is dashstyle'
         return self._linestyle in ('--', '-.', ':')
 
+    cbook._define_aliases(locals(), {
+        "antialiased": ["aa"],
+        "color": ["c"],
+        "linestyle": ["ls"],
+        "linewidth": ["lw"],
+        "markeredgecolor": ["mec"],
+        "markeredgewidth": ["mew"],
+        "markerfacecolor": ["mfc"],
+        "markerfacecoloralt": ["mfcalt"],
+        "markersize": ["ms"],
+    })
+
 
 class VertexSelector(object):
     """
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -266,10 +266,6 @@ def set_antialiased(self, aa):
         self._antialiased = aa
         self.stale = True
 
-    def set_aa(self, aa):
-        """alias for set_antialiased"""
-        return self.set_antialiased(aa)
-
     def _set_edgecolor(self, color):
         set_hatch_color = True
         if color is None:
@@ -294,10 +290,6 @@ def set_edgecolor(self, color):
         self._original_edgecolor = color
         self._set_edgecolor(color)
 
-    def set_ec(self, color):
-        """alias for set_edgecolor"""
-        return self.set_edgecolor(color)
-
     def _set_facecolor(self, color):
         if color is None:
             color = mpl.rcParams['patch.facecolor']
@@ -314,10 +306,6 @@ def set_facecolor(self, color):
         self._original_facecolor = color
         self._set_facecolor(color)
 
-    def set_fc(self, color):
-        """alias for set_facecolor"""
-        return self.set_facecolor(color)
-
     def set_color(self, c):
         """
         Set both the edgecolor and the facecolor.
@@ -366,10 +354,6 @@ def set_linewidth(self, w):
             offset, ls, self._linewidth)
         self.stale = True
 
-    def set_lw(self, lw):
-        """alias for set_linewidth"""
-        return self.set_linewidth(lw)
-
     def set_linestyle(self, ls):
         """
         Set the patch linestyle
@@ -410,10 +394,6 @@ def set_linestyle(self, ls):
             offset, ls, self._linewidth)
         self.stale = True
 
-    def set_ls(self, ls):
-        """alias for set_linestyle"""
-        return self.set_linestyle(ls)
-
     def set_fill(self, b):
         """
         Set whether to fill the patch.
@@ -570,6 +550,14 @@ def get_path(self):
     def get_window_extent(self, renderer=None):
         return self.get_path().get_extents(self.get_transform())
 
+    cbook._define_aliases(locals(), {
+        "antialiased": ["aa"],
+        "edgecolor": ["ec"],
+        "facecolor": ["fc"],
+        "linewidth": ["lw"],
+        "linestyle": ["ls"],
+    })
+
 
 patchdoc = artist.kwdoc(Patch)
 for k in ('Rectangle', 'Circle', 'RegularPolygon', 'Polygon', 'Wedge', 'Arrow',
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
