Make _define_aliases a class decorator.

anntzer · anntzer · commit 2c83bdbe6aa1 · 2018-02-02T10:52:04.000-08:00
diff --git a/lib/matplotlib/cbook/__init__.py b/lib/matplotlib/cbook/__init__.py
@@ -2805,14 +2805,13 @@ def _str_lower_equal(obj, s):
     return isinstance(obj, six.string_types) and obj.lower() == s
 
 
-def _define_aliases(local_d, alias_d):
-    """Define property aliases.
+def _define_aliases(alias_d, cls=None):
+    """Class decorator for defining property aliases.
 
-    Use in a class definition as ::
+    Use as ::
 
-        cbook._define_aliases(locals(), {
-            "property": ["alias", ...], ...
-        })
+        @cbook._define_aliases({"property": ["alias", ...], ...})
+        class C: ...
 
     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
@@ -2822,6 +2821,8 @@ class so far, an alias named ``get_alias`` will be defined; the same will
     The alias map is stored as the ``_alias_map`` attribute on the class and
     can be used by `~.normalize_kwargs`.
     """
+    if cls is None:
+        return functools.partial(_define_aliases, alias_d)
 
     def make_alias(name):  # Enfore a closure over *name*.
         def method(self, *args, **kwargs):
@@ -2831,14 +2832,15 @@ def method(self, *args, **kwargs):
     for prop, aliases in alias_d.items():
         exists = False
         for prefix in ["get_", "set_"]:
-            if prefix + prop in local_d:
+            if prefix + prop in vars(cls):
                 exists = True
                 for alias in aliases:
                     method = make_alias(prefix + prop)
                     method.__name__ = prefix + alias
                     method.__doc__ = "alias for `{}`".format(prefix + prop)
-                    local_d[prefix + alias] = method
+                    setattr(cls, prefix + alias, method)
         if not exists:
             raise ValueError("property {} does not exist".format(prop))
 
-    local_d["_alias_map"] = alias_d
+    cls._alias_map = alias_d
+    return cls
diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -28,6 +28,13 @@
 CIRCLE_AREA_FACTOR = 1.0 / np.sqrt(np.pi)
 
 
+@cbook._define_aliases({
+    "antialiased": ["antialiaseds"],
+    "edgecolor": ["edgecolors"],
+    "facecolor": ["facecolors"],
+    "linestyle": ["linestyles", "dashes"],
+    "linewidth": ["linewidths", "lw"],
+})
 class Collection(artist.Artist, cm.ScalarMappable):
     """
     Base class for Collections.  Must be subclassed to be usable.
@@ -799,13 +806,6 @@ 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
diff --git a/lib/matplotlib/lines.py b/lib/matplotlib/lines.py
@@ -229,15 +229,25 @@ def _slice_or_none(in_v, slc):
             'markevery=%s' % (markevery,))
 
 
+@cbook._define_aliases({
+    "antialiased": ["aa"],
+    "color": ["c"],
+    "linestyle": ["ls"],
+    "linewidth": ["lw"],
+    "markeredgecolor": ["mec"],
+    "markeredgewidth": ["mew"],
+    "markerfacecolor": ["mfc"],
+    "markerfacecoloralt": ["mfcalt"],
+    "markersize": ["ms"],
+})
 class Line2D(Artist):
     """
     A line - the line can have both a solid linestyle connecting all
     the vertices, and a marker at each vertex.  Additionally, the
     drawing of the solid line is influenced by the drawstyle, e.g., one
     can create "stepped" lines in various styles.
-
-
     """
+
     lineStyles = _lineStyles = {  # hidden names deprecated
         '-':    '_draw_solid',
         '--':   '_draw_dashed',
@@ -1347,18 +1357,6 @@ 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
@@ -16,6 +16,14 @@
     split_bezier_intersecting_with_closedpath, split_path_inout)
 from .path import Path
 
+
+@cbook._define_aliases({
+    "antialiased": ["aa"],
+    "edgecolor": ["ec"],
+    "facecolor": ["fc"],
+    "linewidth": ["lw"],
+    "linestyle": ["ls"],
+})
 class Patch(artist.Artist):
     """
     A patch is a 2D artist with a face color and an edge color.
@@ -538,14 +546,6 @@ 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
@@ -116,6 +116,19 @@ def _get_textbox(text, renderer):
     return x_box, y_box, w_box, h_box
 
 
+@cbook._define_aliases({
+    "family": ["fontfamily"],
+    "fontproperties": ["font_properties"],
+    "horizontalalignment": ["ha"],
+    "multialignment": ["ma"],
+    "name": ["fontname"],
+    "size": ["fontsize"],
+    "stretch": ["fontstretch"],
+    "style": ["fontstyle"],
+    "variant": ["fontvariant"],
+    "verticalalignment": ["va"],
+    "weight": ["fontweight"],
+})
 class Text(Artist):
     """
     Handle storing and drawing of text in window or data coordinates.
@@ -1154,19 +1167,6 @@ def set_name(self, fontname):  # One-way alias only: the getter differs.
         """alias for set_family"""
         return self.set_family(fontname)
 
-    cbook._define_aliases(locals(), {
-        "family": ["fontfamily"],
-        "fontproperties": ["font_properties"],
-        "horizontalalignment": ["ha"],
-        "multialignment": ["ma"],
-        "name": ["fontname"],
-        "size": ["fontsize"],
-        "stretch": ["fontstretch"],
-        "style": ["fontstyle"],
-        "variant": ["fontvariant"],
-        "verticalalignment": ["va"],
-        "weight": ["fontweight"],
-    })
 
 docstring.interpd.update(Text=artist.kwdoc(Text))
 docstring.dedent_interpd(Text.__init__)
