add @retrieve decorator

matplotlib · rmorshea · Aug 6, 2015 · Jul 20, 2015 · Jul 21, 2015 · Jul 23, 2015
commit bb02b3847ae58ef6f287ac797e3cd02ac44e738e
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -15,9 +15,10 @@
                          TransformedPatchPath, TransformedPath, Transform)
 from .path import Path
 
-from .traitlets import (Instance, Configurable, gTransformInstance, Bool, Undefined, Union,
+from .traitlets import (Instance, Configurable, TransformInstance, Bool, Undefined, Union,
                         BaseDescriptor, getargspec, PrivateMethodMixin, Float, TraitError,
-                        Unicode, Stringlike, Callable, Tuple, List, observe, validate, default)
+                        Unicode, Stringlike, Callable, Tuple, List, observe, validate, default,
+                        retrieve)
 
 from urlparse import urlparse
 
@@ -88,7 +89,7 @@ class Artist(PrivateMethodMixin, Configurable):
     aname = 'Artist'
     zorder = 0
 
-    transform = gTransformInstance(IdentityTransform())
+    transform = TransformInstance(None)
 
     @observe('transform')
     def _transform_changed(self, change):
@@ -100,6 +101,7 @@ def _transform_validate(self, commit):
         self.transform_set = True
         return commit['value']
 
+    @retrieve('transform')
     def _transform_getter(self, pull):
         if pull['trait']._conversion_method:
             return pull['value'](self.axes)
@@ -192,6 +194,7 @@ def _pickabe_validate(self, commit):
         repl = (commit['trait'].name, self.__class__.__name__)
         raise TraitError(msg % repl)
 
+    @retrieve('pickable')
     def _pickable_getter(self, pull):
         return (self.figure is not None and
                 self.figure.canvas is not None and
@@ -265,6 +268,7 @@ def _agg_filter_changed(self, change):
 
     snap = Bool(None, allow_none=True)
 
+    @retrieve('snap')
     def _snap_getter(self, pull):
         if rcParams['path.snap']:
             return pull['value']

diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -42,8 +42,6 @@
 is_sequence_of_strings = cbook.is_sequence_of_strings
 
 
-
-
 def _process_plot_format(fmt):
     """
     Process a MATLAB style color/line style format string.  Return a

diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -21,7 +21,7 @@
 import numpy as np
 import warnings
 
-from .traitlets import gTransformInstance, Instance
+from .traitlets import Instance, retrieve
 
 GRIDLINE_INTERPOLATION_STEPS = 180
 
@@ -619,8 +619,6 @@ class Axis(artist.Artist):
     """
     OFFSETTEXTPAD = 3
 
-    transform = gTransformInstance(None)
-
     label = Instance(mtext.Text, allow_none=True)
 
     def __str__(self):
@@ -688,6 +686,7 @@ def set_label_coords(self, x, y, transform=None):
         self.label.set_position((x, y))
         self.stale = True
 
+    @retrieve('transform')
     def _transform_getter(self, pull):
         return self._scale.get_transform()
 

diff --git a/lib/matplotlib/offsetbox.py b/lib/matplotlib/offsetbox.py
@@ -40,7 +40,7 @@
 from matplotlib.patches import bbox_artist as mbbox_artist
 from matplotlib.text import _AnnotationBase
 
-from .traitlets import gTransformInstance, observe
+from .traitlets import observe, retrieve
 
 DEBUG = False
 
@@ -595,8 +595,6 @@ class DrawingArea(OffsetBox):
     boundaries of the parent.
     """
 
-    transform = gTransformInstance(None, allow_none=True)
-
     def __init__(self, width, height, xdescent=0.,
                  ydescent=0., clip=False):
         """
@@ -632,6 +630,7 @@ def clip_children(self, val):
         self._clip_children = bool(val)
         self.stale = True
 
+    @retrieve('transform')
     def _transform_getter(self, pull):
         """
          Return the :class:`~matplotlib.transforms.Transform` applied
@@ -915,8 +914,6 @@ class AuxTransformBox(OffsetBox):
     calculated in the transformed coordinate.
     """
 
-    transform = gTransformInstance(None, allow_none=True)
-
     def __init__(self, aux_transform):
         self.aux_transform = aux_transform
         OffsetBox.__init__(self)
@@ -937,6 +934,7 @@ def add_artist(self, a):
         a.transform = self.transform
         self.stale = True
 
+    @retrieve('transform')
     def _transform_getter(self, pull):
         return self.aux_transform + \
                self.ref_offset_transform + \

diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -24,8 +24,7 @@
 from matplotlib.bezier import split_path_inout, get_cos_sin
 from matplotlib.bezier import make_path_regular, concatenate_paths
 
-from .transforms import IdentityTransform
-from .traitlets import gTransformInstance, validate
+from .traitlets import validate, retrieve
 
 
 # these are not available for the object inspector until after the
@@ -70,8 +69,6 @@ class Patch(artist.Artist):
     validCap = ('butt', 'round', 'projecting')
     validJoin = ('miter', 'round', 'bevel')
 
-    transform = gTransformInstance(IdentityTransform())
-
     def __str__(self):
         return str(self.__class__).split('.')[-1]
 
@@ -196,6 +193,7 @@ def get_extents(self):
         """
         return self.get_path().get_extents(self.transform)
 
+    @retrieve('transform')
     def _transform_getter(self, pull):
         return self.get_patch_transform() + pull['value']
 

diff --git a/lib/matplotlib/tests/test_collections.py b/lib/matplotlib/tests/test_collections.py
@@ -17,6 +17,7 @@
 import matplotlib.transforms as mtransforms
 from matplotlib.collections import EventCollection
 from matplotlib.testing.decorators import cleanup, image_comparison
+from matplotlib.traitlets import retrieve
 
 
 def generate_EventCollection_plot():
@@ -552,6 +553,7 @@ def __init__(self, **kwargs):
             super(SquareCollection, self).__init__(
                 4, rotation=np.pi/4., **kwargs)
 
+        @retrieve('transform')
         def _transform_getter(self, pull):
             """Return transform scaling circle areas to data space."""
             ax = self.axes

diff --git a/lib/matplotlib/tests/test_traitlets.py b/lib/matplotlib/tests/test_traitlets.py
@@ -8,7 +8,7 @@
     from IPython.utils.traitlets import TraitError, HasTraits
 
 from matplotlib.traitlets import (Color, exdict, OnGetMixin, PrivateMethodMixin,
-                                  Int, Configurable, observe, validate)
+                                  Int, Configurable, observe, validate, retrieve)
 
 def test_exdict():
     e = exdict()
@@ -25,6 +25,7 @@ class gInt(OnGetMixin, Int): pass
     class A(PrivateMethodMixin, Configurable):
 
         attr = gInt(0)
+        @retrieve('attr')
         def _attr_getter(self, value, trait):
             return value + 1
 
@@ -59,6 +60,7 @@ class gInt(OnGetMixin, Int): pass
         class A(PrivateMethodMixin, Configurable):
 
             attr = gInt(0)
+            @retrieve('attr')
             def _attr_getter(self, value, trait):
                 return value + 1
 

diff --git a/lib/matplotlib/traitlets.py b/lib/matplotlib/traitlets.py
@@ -8,14 +8,16 @@
                            Dict, List, Instance, Union,
                            Unicode, Tuple, TraitError,
                            Undefined, BaseDescriptor,
-                           getargspec, observe, default, validate)
+                           getargspec, observe, default,
+                           validate, EventHandler)
 except ImportError:
     # IPython3 imports
     from IPython.utils.traitlets.config import Configurable, Config
     from IPython.utils.traitlets import (TraitType, Int, Float, Bool,
                             Dict, List, Instance, Union, Unicode,
                             Tuple, TraitError, Undefined, BaseDescriptor,
-                            getargspec, observe, default, validate)
+                            getargspec, observe, default, validate,
+                            EventHandler)
 
 import re
 import types
@@ -81,24 +83,40 @@ def _retrieve_trait(self, name):
             raise TraitError(msg % (name, self.__class__.__name__))
         return trait
 
-class OnGetMixin(object):
+def retrieve(name):
+    return RetrieveHandler(name)
 
-    def __init__(self, *args, **kwargs):
-        super_obj = super(OnGetMixin,self)
-        self.__base_get__ = super_obj.__get__
-        self.__base_set__ = super_obj.__set__
-        super_obj.__init__(*args, **kwargs)
+class RetrieveHandler(EventHandler):
+
+    def __init__(self, name):
+        self._name = name
+
+    def instance_init(self, inst):
+        if not hasattr(inst, '_retrieve_handlers'):
+            inst._retrieve_handlers = {}
+        if self._name in inst._retrieve_handlers:
+            raise TraitError("A retriever for the trait '%s' has "
+                             "already been registered" % self._name)
+        method = types.MethodType(self.func, inst)
+        inst._retrieve_handlers[self._name] = method
+
+class OnGetMixin(object):
 
     def __get__(self, obj, cls=None):
-        value = super(OnGetMixin,self).__get__(obj,cls)
-        method = getattr(obj, '_'+self.name+'_getter', None)
-        if value is not self and method is not None:
-            method = getattr(obj, '_'+self.name+'_getter')
+        if obj is None:
+            return self
+        value = super(OnGetMixin,self).get(obj, cls)
+        if self.name in obj._retrieve_handlers:
+            method = obj._retrieve_handlers[self.name]
             value = method({'value': value, 'owner':obj, 'trait':self})
         return value
 
+    def instance_init(self, inst):
+        if not hasattr(inst, '_retrieve_handlers'):
+            inst._retrieve_handlers = {}
+        super(OnGetMixin, self).instance_init(inst)
 
-class TransformInstance(TraitType):
+class TransformInstance(OnGetMixin, TraitType):
 
     info_text = ('a Transform instance or have an'
                  ' `_as_mpl_transform` method')
@@ -125,8 +143,6 @@ def validate(self, obj, value):
             return value._as_mpl_transform
         trait.error(obj, value)
 
-class gTransformInstance(OnGetMixin,TransformInstance): pass
-
 #!Note : this is what the transform instance would
 # look like if getters were to be avoided entirely.
 # `_name_validate` would handle "on set" events
-Original file line number
+Diff line change
@@ Expand Up / @@ -42,8 +42,6 @@ @@
     is_sequence_of_strings = cbook.is_sequence_of_strings
     def _process_plot_format(fmt):
         """
         Process a MATLAB style color/line style format string.  Return a
@@ Expand Down @@