transform refactoring : see TODO

matplotlib · rmorshea · Aug 6, 2015 · Jul 20, 2015 · Jul 21, 2015 · Jul 23, 2015
commit f73f7b60ed3bb7c62565d25235c2f7278032612c
diff --git a/TODO.txt b/TODO.txt
@@ -23,22 +23,21 @@
 1.2) write relevant imports
 1.3) make the method changes
 
-
-# in TextMate
+# using custom script
 2.0) locate method references
 2.1) changed the method references
 
 3.0) locate underscored attr references
 3.1) change the underscored attrs
 
-4.0) if property find normal references
-4.1) change the underscored attrs
+4.0) run test suite
+4.1) rework for passing
 
-5.0) complete
+5.0) compelete
 
 -- STATUS --
 
-1.3 : transform
+2.1 : transform
 0.2 : transform_set
 0.2 : stale
 0.0 : visible

diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -15,6 +15,8 @@
                          TransformedPatchPath, TransformedPath, Transform)
 from .path import Path
 
+from .traitlets import Configurable, TransformInstance, Bool
+
 # Note, matplotlib artists use the doc strings for set and get
 # methods to enable the introspection methods of setp and getp.  Every
 # set_* method should have a docstring containing the line
@@ -31,6 +33,8 @@
 # as far as I can see - see
 # http://groups.google.com/groups?hl=en&lr=&threadm=mailman.5090.1098044946.5135.python-list%40python.org&rnum=1&prev=/groups%3Fq%3D__doc__%2Bauthor%253Ajdhunter%2540ace.bsd.uchicago.edu%26hl%3Den%26btnG%3DGoogle%2BSearch
 
+class Undefined(object): pass
+Undefined = Undefined()
 
 def allow_rasterization(draw):
     """
@@ -77,7 +81,7 @@ def _stale_axes_callback(self):
     self.axes.stale = True
 
 
-class Artist(object):
+class Artist(Configurable):
     """
     Abstract base class for someone who renders into a
     :class:`FigureCanvas`.
@@ -88,7 +92,7 @@ class Artist(object):
 
     transform = TransformInstance(IdentityTransform())
 
-    def _tranform_changed(self):
+    def _transform_changed(self):
         self.transform_set = True
         self.pchanged()
         self.stale = True
@@ -260,25 +264,27 @@ def axes(self, new_axes):
 
         return new_axes
 
-    @property
-    def stale(self):
-        """
-        If the artist is 'stale' and needs to be re-drawn for the output to
-        match the internal state of the artist.
-        """
-        return self._stale
+    #!DEPRECATED
+    # @property
+    # def stale(self):
+    #     """
+    #     If the artist is 'stale' and needs to be re-drawn for the output to
+    #     match the internal state of the artist.
+    #     """
+    #     return self._stale
 
-    @stale.setter
-    def stale(self, val):
-        # only trigger call-back stack on being marked as 'stale'
-        # when not already stale
-        # the draw process will take care of propagating the cleaning
-        # process
-        if not (self._stale == val):
-            self._stale = val
-            # only trigger propagation if marking as stale
-            if self._stale:
-                self.pchanged()
+    #!DEPRECATED
+    # @stale.setter
+    # def stale(self, val):
+    #     # only trigger call-back stack on being marked as 'stale'
+    #     # when not already stale
+    #     # the draw process will take care of propagating the cleaning
+    #     # process
+    #     if not (self._stale == val):
+    #         self._stale = val
+    #         # only trigger propagation if marking as stale
+    #         if self._stale:
+    #             self.pchanged()
 
     def get_window_extent(self, renderer):
         """
@@ -680,7 +686,7 @@ def set_clip_path(self, path, transform=None):
         if transform is None:
             if isinstance(path, Rectangle):
                 self.clipbox = TransformedBbox(Bbox.unit(),
-                                               path.get_transform())
+                                               path.transform)
                 self._clippath = None
                 success = True
             elif isinstance(path, Patch):
@@ -852,9 +858,12 @@ def update(self, props):
                 setattr(self, k, v)
             else:
                 func = getattr(self, 'set_' + k, None)
-                if func is None or not six.callable(func):
+                if func is not None and six.callable(func):
+                    func(v)
+                elif getattr(self, k, Undefined) is not Undefined:
+                    setattr(self, k, v)
+                else:
                     raise AttributeError('Unknown property %s' % k)
-                func(v)
             changed = True
         self.eventson = store
         if changed:
@@ -899,7 +908,7 @@ def set_zorder(self, level):
 
     def update_from(self, other):
         'Copy properties from *other* to *self*.'
-        self._transform = other._transform
+        self.transform = other.transform
         self._transformSet = other._transformSet
         self._visible = other._visible
         self._alpha = other._alpha

diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -789,9 +789,8 @@ def get_yaxis_text2_transform(self, pad_points):
                 "center", "left")
 
     def _update_transScale(self):
-        self.transScale.set(
-            mtransforms.blended_transform_factory(
-                self.xaxis.get_transform(), self.yaxis.get_transform()))
+        self.transScale.set(mtransforms.blended_transform_factory(
+            self.xaxis.transform, self.yaxis.transform))
         if hasattr(self, "lines"):
             for line in self.lines:
                 try:
@@ -864,7 +863,7 @@ def get_axes_locator(self):
     def _set_artist_props(self, a):
         """set the boilerplate props for artists added to axes"""
         a.set_figure(self.figure)
-        if not a.transform_set):
+        if not a.transform_set:
             a.transform = self.transData
 
         a.axes = self
@@ -1724,7 +1723,7 @@ def _update_line_limits(self, line):
         if path.vertices.size == 0:
             return
 
-        line_trans = line.get_transform()
+        line_trans = line.transform
 
         if line_trans == self.transData:
             data_path = path
@@ -1799,7 +1798,7 @@ def _update_patch_limits(self, patch):
                                  self.transData)
                 xys = patch_to_data.transform(xys)
 
-            updatex, updatey = patch.get_transform().\
+            updatex, updatey = patch.transform.\
                 contains_branch_seperately(self.transData)
             self.update_datalim(xys, updatex=updatex,
                                 updatey=updatey)
@@ -2303,7 +2302,7 @@ def draw(self, renderer=None, inframe=False):
             gc.set_clip_rectangle(self.bbox)
             gc.set_clip_path(mtransforms.TransformedPath(
                 self.patch.get_path(),
-                self.patch.get_transform()))
+                self.patch.transform))
 
             renderer.draw_image(gc, round(l), round(b), im)
             gc.restore()

diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -1801,7 +1801,7 @@ def _update_label_position(self, bboxes, bboxes2):
         if self.label_position == 'bottom':
             try:
                 spine = self.axes.spines['bottom']
-                spinebbox = spine.get_transform().transform_path(
+                spinebbox = spine.transform.transform_path(
                     spine.get_path()).get_extents()
             except KeyError:
                 # use axes if spine doesn't exist
@@ -1816,7 +1816,7 @@ def _update_label_position(self, bboxes, bboxes2):
         else:
             try:
                 spine = self.axes.spines['top']
-                spinebbox = spine.get_transform().transform_path(
+                spinebbox = spine.transform.transform_path(
                     spine.get_path()).get_extents()
             except KeyError:
                 # use axes if spine doesn't exist
@@ -2123,7 +2123,7 @@ def _update_label_position(self, bboxes, bboxes2):
         if self.label_position == 'left':
             try:
                 spine = self.axes.spines['left']
-                spinebbox = spine.get_transform().transform_path(
+                spinebbox = spine.transform.transform_path(
                     spine.get_path()).get_extents()
             except KeyError:
                 # use axes if spine doesn't exist
@@ -2138,7 +2138,7 @@ def _update_label_position(self, bboxes, bboxes2):
         else:
             try:
                 spine = self.axes.spines['right']
-                spinebbox = spine.get_transform().transform_path(
+                spinebbox = spine.transform.transform_path(
                     spine.get_path()).get_extents()
             except KeyError:
                 # use axes if spine doesn't exist

diff --git a/lib/matplotlib/backends/backend_pgf.py b/lib/matplotlib/backends/backend_pgf.py
@@ -651,7 +651,7 @@ def draw_text(self, gc, x, y, s, prop, angle, ismath=False, mtext=None):
         if mtext and (angle == 0 or mtext.get_rotation_mode() == "anchor"):
             # if text anchoring can be supported, get the original coordinates
             # and add alignment information
-            x, y = mtext.get_transform().transform_point(mtext.get_position())
+            x, y = mtext.transform.transform_point(mtext.get_position())
             text_args.append("x=%fin" % (x * f))
             text_args.append("y=%fin" % (y * f))
 

diff --git a/lib/matplotlib/backends/backend_svg.py b/lib/matplotlib/backends/backend_svg.py
@@ -1031,7 +1031,7 @@ def _draw_text_as_text(self, gc, x, y, s, prop, angle, ismath, mtext=None):
                 # coordinates and add alignment information.
 
                 # Get anchor coordinates.
-                transform = mtext.get_transform()
+                transform = mtext.transform
                 ax, ay = transform.transform_point(mtext.get_position())
                 ay = self.height - ay
 

diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -182,7 +182,7 @@ def get_offset_transform(self):
         return t
 
     def get_datalim(self, transData):
-        transform = self.get_transform()
+        transform = self.transform
         transOffset = self.get_offset_transform()
         offsets = self._offsets
         paths = self.get_paths()
@@ -217,7 +217,7 @@ def get_window_extent(self, renderer):
     def _prepare_points(self):
         """Point prep for drawing and hit testing"""
 
-        transform = self.get_transform()
+        transform = self.transform
         transOffset = self.get_offset_transform()
         offsets = self._offsets
         paths = self.get_paths()
@@ -1622,7 +1622,7 @@ def determine_facecolor(patch):
         self.set_paths(patches)
 
     def set_paths(self, patches):
-        paths = [p.get_transform().transform_path(p.get_path())
+        paths = [p.transform.transform_path(p.get_path())
                  for p in patches]
         self._paths = paths
 
@@ -1677,7 +1677,7 @@ def draw(self, renderer):
         if not self.get_visible():
             return
         renderer.open_group(self.__class__.__name__)
-        transform = self.get_transform()
+        transform = self.transform
 
         # Get a list of triangles and the color at each vertex.
         tri = self._triangulation
@@ -1757,7 +1757,7 @@ def set_paths(self):
         self.stale = True
 
     def get_datalim(self, transData):
-        return (self.get_transform() - transData).transform_bbox(self._bbox)
+        return (self.transform - transData).transform_bbox(self._bbox)
 
     @staticmethod
     def convert_mesh_to_paths(meshWidth, meshHeight, coordinates):
@@ -1832,7 +1832,7 @@ def draw(self, renderer):
         if not self.get_visible():
             return
         renderer.open_group(self.__class__.__name__, self.get_gid())
-        transform = self.get_transform()
+        transform = self.transform
         transOffset = self.get_offset_transform()
         offsets = self._offsets
 

diff --git a/lib/matplotlib/contour.py b/lib/matplotlib/contour.py
@@ -29,8 +29,6 @@
 import matplotlib.transforms as mtrans
 from matplotlib.cbook import mplDeprecation
 
-from .traitlest import TransformInstance
-
 # Import needed for adding manual selection capability to clabel
 from matplotlib.blocking_input import BlockingContourLabeler
 
@@ -50,7 +48,7 @@ class ClabelText(text.Text):
     """
     def get_rotation(self):
         angle = text.Text.get_rotation(self)
-        trans = self.get_transform()
+        trans = self.transform
         x, y = self.get_position()
         new_angles = trans.transform_angles(np.array([angle]),
                                             np.array([[x, y]]))
@@ -651,7 +649,7 @@ def labels(self, inline, inline_spacing):
                 self.labelFontSizeList, self.labelCValueList):
 
             con = self.collections[icon]
-            trans = con.get_transform()
+            trans = con.transform
             lw = self.get_label_width(lev, self.labelFmt, fsize)
             lw *= self.ax.figure.dpi / 72.0  # scale to screen coordinates
             additions = []
@@ -1396,7 +1394,7 @@ def find_nearest_contour(self, x, y, indices=None, pixel=True):
 
         for icon in indices:
             con = self.collections[icon]
-            trans = con.get_transform()
+            trans = con.transform
             paths = con.get_paths()
 
             for segNum, linepath in enumerate(paths):

diff --git a/lib/matplotlib/image.py b/lib/matplotlib/image.py
@@ -285,7 +285,7 @@ def _draw_unsampled_image(self, renderer, gc):
         draw unsampled image. The renderer should support a draw_image method
         with scale parameter.
         """
-        trans = self.get_transform()  # axes.transData
+        trans = self.transform  # axes.transData
 
         # convert the coordinates to the intermediate coordinate (ic).
         # The transformation from the ic to the canvas is a pure
@@ -609,7 +609,7 @@ def make_image(self, magnification=1.0):
 
         # image is created in the canvas coordinate.
         x1, x2, y1, y2 = self.get_extent()
-        trans = self.get_transform()
+        trans = self.transform
         xy = trans.transform(np.array([(x1, y1),
                                        (x2, y2),
                                        ]))

diff --git a/lib/matplotlib/legend.py b/lib/matplotlib/legend.py
@@ -741,7 +741,7 @@ def _auto_legend_data(self):
         for handle in ax.lines:
             assert isinstance(handle, Line2D)
             path = handle.get_path()
-            trans = handle.get_transform()
+            trans = handle.transform
             tpath = trans.transform_path(path)
             lines.append(tpath)
 
@@ -752,7 +752,7 @@ def _auto_legend_data(self):
                 transform = handle.get_data_transform()
                 bboxes.append(handle.get_bbox().transformed(transform))
             else:
-                transform = handle.get_transform()
+                transform = handle.transform
                 bboxes.append(handle.get_path().get_extents(transform))
 
         try:

diff --git a/lib/matplotlib/legend_handler.py b/lib/matplotlib/legend_handler.py
@@ -116,7 +116,7 @@ def legend_artist(self, legend, orig_handle,
                  fontsize)
         artists = self.create_artists(legend, orig_handle,
                                       xdescent, ydescent, width, height,
-                                      fontsize, handlebox.get_transform())
+                                      fontsize, handlebox.transform)
 
         # create_artists will return a list of artists.
         for a in artists: