added set and get introspection

svn path=/trunk/matplotlib/; revision=708

Author: jdh2358

CHANGELOG

@@ -1,5 +1,8 @@
 New entries should be added at the top
 
+2004-11-23 Added matplotlib compatible set and get introspection.  See
+           set_and_get.py
+
 2004-11-23 applied Norbert's patched and exposed legend configuration
            to kwargs - JDH
 

examples/set_and_get.py

@@ -0,0 +1,94 @@
+"""
+
+matlab (and matplotlib) allow you to use set and get to set and get
+object properties, as well as to do introspection on the object
+
+set
+    To set the linestyle of a line to be dashed, you can do
+
+      >>> line, = plot([1,2,3])
+      >>> set(line, linestyle='--')
+
+    If you want to know the valid types of arguments, you can provide the
+    name of the property you want to set without a value
+
+      >>> set(line, 'linestyle')
+          linestyle: [ '-' | '--' | '-.' | ':' | 'steps' | 'None' ]
+
+    If you want to see all the properties that can be set, and their
+    possible values, you can do
+
+        >>> set(line)
+
+    set operates on a single instance or a list of instances.  If you are
+    in quey mode introspecting the possible values, only the first
+    instance in the sequnce is used.  When actually setting values, all
+    the instances will be set.  Eg, suppose you have a list of two lines,
+    the following will make both lines thicker and red
+
+        >>> x = arange(0,1.0,0.01)
+        >>> y1 = sin(2*pi*x)
+        >>> y2 = sin(4*pi*x)
+        >>> lines = plot(x, y1, x, y2)
+        >>> set(lines, linewidth=2, color='r')
+
+
+get:
+
+    get returns the value of a given attribute.  You can use get to query
+    the value of a single attribute
+
+        >>> get(line, 'linewidth')
+            0.5
+
+    or all the attribute/value pairs
+
+    >>> get(line)
+        aa = True
+        alpha = 1.0
+        antialiased = True
+        c = b
+        clip_on = True
+        color = b
+        ... long listing skipped ...
+  
+Alisases:
+
+  To reduce keystrokes in interactive mode, a number of properties
+  have short aliases, eg 'lw' for 'linewidth' and 'mec' for
+  'markeredgecolor'.  When calling set or get in introspection mode,
+  these properties will be listed as 'fullname or aliasname', as in
+
+  
+
+  
+"""
+
+from matplotlib.matlab import *
+
+
+x = arange(0,1.0,0.01)
+y1 = sin(2*pi*x)
+y2 = sin(4*pi*x)
+lines = plot(x, y1, x, y2)
+l1, l2 = lines
+set(lines, linestyle='--')       # set both to dashed 
+set(l1, linewidth=2, color='r')  # line1 is thick and red
+set(l2, linewidth=1, color='g')  # line2 is thicker and green
+
+
+print 'Line setters'
+set(l1)
+print 'Line getters'
+get(l1)
+
+print 'Rectangle setters'
+set(gca().axesPatch)
+print 'Rectangle getters'
+get(gca().axesPatch)
+
+t = title('Hi mom')
+print 'Text setters'
+set(t)
+print 'Text getters'
+get(t)

lib/matplotlib/artist.py

@@ -25,7 +25,11 @@ def is_transform_set(self):
         return self._transformSet
 
     def set_transform(self, t):
-        'set the Transformation instance used by this artist'        
+        """
+set the Transformation instance used by this artist
+
+ACCEPTS: a matplotlib.transform transformation instance
+"""
         self._transform = t
         self._transformSet = True
 
@@ -38,13 +42,17 @@ def is_figure_set(self):
 
     def set_figure(self, fig):
         """
-        Set the figure instance the artist belong to
+Set the figure instance the artist belong to
+
+ACCEPTS: a matplotlib.figure.Figure instance
         """
         self.figure = fig
 
-    def set_clip_box(self, clipbox):
+    def set_clip_box(self, clipbox):        
         """
-        Set the artist's clip Bbox
+Set the artist's clip Bbox
+
+ACCEPTS: a matplotlib.transform.Bbox instance
         """
         self.clipbox = clipbox
         self._clipon = clipbox is not None
@@ -65,7 +73,11 @@ def get_clip_on(self):
         return self._clipon and self.clipbox is not None
 
     def set_clip_on(self, b):
-        'Set  whether artist uses clipping'
+        """
+Set  whether artist uses clipping
+
+ACCEPTS: [True | False]
+"""
         self._clipon = b
 
     def draw(self, renderer, *args, **kwargs):
@@ -74,20 +86,28 @@ def draw(self, renderer, *args, **kwargs):
 
     def set_alpha(self, alpha):
         """
-        Set the alpha value used for blending - not supported on
-        all backends
+Set the alpha value used for blending - not supported on
+all backends
+
+ACCEPTS: float
         """
         self._alpha = alpha
 
 
     def set_lod(self, on):
         """
-        Set Level of Detail on or off.  If on, the artists may examine
-        things like the pixel width of the axes and draw a subset of
-        their contents accordingly
+Set Level of Detail on or off.  If on, the artists may examine
+things like the pixel width of the axes and draw a subset of
+their contents accordingly
+
+ACCEPTS: [True | False]
         """
         self._lod = on
 
     def set_visible(self, b):
-        "set the artist's visiblity"
+        """
+set the artist's visiblity
+
+ACCEPTS: [True | False]
+"""
         self._visible = b

lib/matplotlib/axes.py

@@ -1597,10 +1597,10 @@ def pcolor(self, *args, **kwargs):
         if not self._hold: self.cla()
 
         alpha = kwargs.pop('alpha', 1.0)
-        norm = kwargs.pop('norm')
-        cmap = kwargs.pop('cmap')        
-        vmin = kwargs.pop('vmin')
-        vmax = kwargs.pop('vmax')        
+        norm = kwargs.pop('norm', None)
+        cmap = kwargs.pop('cmap', None)        
+        vmin = kwargs.pop('vmin', None)
+        vmax = kwargs.pop('vmax', None)        
         shading = kwargs.pop('shading', 'faceted')
         if len(kwargs):
             raise TypeError, 'Unknown argument "%s"'%kwargs.keys()[0]

lib/matplotlib/backends/backend_gtk.py

@@ -1563,8 +1563,8 @@ def exception_handler(type, value, tb):
     if len(msg) :error_msg_gtk(msg)
 
 # override excepthook only if it has not already been overridden
-if sys.__excepthook__ is sys.excepthook:
-    sys.excepthook = exception_handler
+#if sys.__excepthook__ is sys.excepthook:
+#    sys.excepthook = exception_handler
 
 FigureManager = FigureManagerGTK
 error_msg = error_msg_gtk