python22 fixes; verbose class

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

Author: jdh2358

.matplotlibrc

@@ -32,6 +32,12 @@ numerix      : Numeric   # Numeric or numarray
 interactive  : False     # see http://matplotlib.sourceforge.net/interactive.html
 toolbar      : toolbar2   # None | classic | toolbar2
 timezone     : UTC        # a pytz timezone string, eg US/Central or Europe/Paris
+
+# Set the verbose flags
+verbose.level  : silent     # one of silent, helpful, annoying
+verbose.fileo  : sys.stdout # a log filename, sys.stdout or sys.stderr
+
+
 # Where your matplotlib data lives if you installed to a non-default
 # location.  This is where the matplotlib fonts, bitmaps, etc reside
 #datapath : /home/jdhunter/mpldata

CHANGELOG

@@ -3,9 +3,13 @@ New entries should be added at the top
 ==============================================================
 2004-09-30 Add GTK+ 2.4 support for the message in the toolbar. SC
 
+2004-09-30 Made some changes to support python22 - lots of doc
+fixes. - JDH
 
+2004-09-29 Added a Verbose class for reporting - JDH
 
 ==============================================================
+
 2004-09-28 Released 0.63.0
 
 2004-09-28 Added save to file object for agg - see

LICENSE/LICENSE

@@ -1,4 +1,4 @@
-LICENSE AGREEMENT FOR MATPLOTLIB 0.63.0
+LICENSE AGREEMENT FOR MATPLOTLIB 0.63.4
 --------------------------------------
 
 1. This LICENSE AGREEMENT is between the John D. Hunter ("JDH"), and the
@@ -9,30 +9,30 @@ documentation.
 2. Subject to the terms and conditions of this License Agreement, JDH
 hereby grants Licensee a nonexclusive, royalty-free, world-wide license
 to reproduce, analyze, test, perform and/or display publicly, prepare
-derivative works, distribute, and otherwise use matplotlib 0.63.0
+derivative works, distribute, and otherwise use matplotlib 0.63.4
 alone or in any derivative version, provided, however, that JDH's
 License Agreement and JDH's notice of copyright, i.e., "Copyright (c)
 2002-2004 John D. Hunter; All Rights Reserved" are retained in
-matplotlib 0.63.0 alone or in any derivative version prepared by
+matplotlib 0.63.4 alone or in any derivative version prepared by
 Licensee.
 
 3. In the event Licensee prepares a derivative work that is based on or
-incorporates matplotlib 0.63.0 or any part thereof, and wants to
+incorporates matplotlib 0.63.4 or any part thereof, and wants to
 make the derivative work available to others as provided herein, then
 Licensee hereby agrees to include in any such work a brief summary of
-the changes made to matplotlib 0.63.0.
+the changes made to matplotlib 0.63.4.
 
-4. JDH is making matplotlib 0.63.0 available to Licensee on an "AS
+4. JDH is making matplotlib 0.63.4 available to Licensee on an "AS
 IS" basis.  JDH MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
 IMPLIED.  BY WAY OF EXAMPLE, BUT NOT LIMITATION, JDH MAKES NO AND
 DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
-FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF MATPLOTLIB 0.63.0
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF MATPLOTLIB 0.63.4
 WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.
 
 5. JDH SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF MATPLOTLIB
-0.63.0 FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR
+0.63.4 FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR
 LOSS AS A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING
-MATPLOTLIB 0.63.0, OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF
+MATPLOTLIB 0.63.4, OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF
 THE POSSIBILITY THEREOF.
 
 6. This License Agreement will automatically terminate upon a material
@@ -44,6 +44,6 @@ Licensee.  This License Agreement does not grant permission to use JDH
 trademarks or trade name in a trademark sense to endorse or promote
 products or services of Licensee, or any third party.
 
-8. By copying, installing or otherwise using matplotlib 0.63.0,
+8. By copying, installing or otherwise using matplotlib 0.63.4,
 Licensee agrees to be bound by the terms and conditions of this License
 Agreement.

MANIFEST

@@ -5,6 +5,7 @@ GOALS
 INSTALL
 INTERACTIVE
 KNOWN_BUGS
+MANIFEST
 MANIFEST.in
 Makefile
 README

TODO

@@ -570,7 +570,7 @@ ZeroDivisionError: SeparableTransformation::eval_scalars yin interval is zero; c
 
 -- post hacking points memo on site, ann and send copy to Fernando
 
---  loadrc() function, possibly replacing  per-directory .matplotlibrc
+-- loadrc() function, possibly replacing  per-directory .matplotlibrc
     files.  
 
 -- file save dialog for Tk?  See Mayavi for the right call to make.
@@ -582,4 +582,8 @@ ZeroDivisionError: SeparableTransformation::eval_scalars yin interval is zero; c
 
 -- DONE an rrulewrapper demo
 
--- implement a new data clipping method with more exensive cache interval
+-- implement a new data clipping method with more exensive cache
+   interval
+
+-- DONE Humufr errorbar and font bug
+

lib/matplotlib/__init__.py

@@ -1,3 +1,4 @@
+from __future__ import generators
 """
 This is a matlab style functional interface the matplotlib.
 
@@ -113,7 +114,7 @@
 the exception of those in mlab.py provided by matplotlib.
 """
 
-__version__  = '0.63.0'
+__version__  = '0.63.4'
 __revision__ = '$Revision$'
 __date__     = '$Date$'
 
@@ -140,15 +141,89 @@ def warn(s):
 
 import sys, os
 
+    
 major, minor1, minor2, s, tmp = sys.version_info
-if major<2 or (major==2 and minor1<3):
-    True = 1
-    False = 0
-else:
-    True = True
-    False = False
+_python23 = major>=2 and minor1>=3
+
+_havemath = _python23
+
+try:
+    import datetime
+    import dateutil
+    import pytz
+except ImportError: _havedate = False
+else: _havedate = True
+
+if not _python23:
+    def enumerate(seq):
+         for i in range(len(seq)):
+             yield i, seq[i]
+
+
+class Verbose:
+    """
+    A class to handle reporting.  Set the fileo attribute to any file
+    instance to handle the output.  Default is sys.stdout
+    """
+    levels = ('silent', 'helpful', 'annoying')
+    vald = dict( [(level, i) for i,level in enumerate(levels)])
+    
+    def __init__(self, level):
+        self.set_level(level)
+        self.fileo = sys.stdout
+        
+    def set_level(self, level):
+        'set the verbosity to one of the Verbose.levels strings'
+        assert level in self.levels
+        self.level = level
+
+    def silent(self):
+        return self.level=='silent'
 
+    def helpful(self):
+        return self.vald[self.level]>=self.vald['helpful']
 
+    def annoying(self):
+        return self.vald[self.level]>=self.vald['annoying']
+
+    def report(self, s, level='helpful'):
+        """
+        print message s to self.fileo if self.level>=level.  Return
+        value indicates whether a message was issued
+        
+        """
+        if self.ge(level):
+            print >>self.fileo, s
+            return True
+        return False
+
+
+    def wrap(self, fmt, func, level='helpful', always=True):
+        """
+        return a callable function that wraps func and reports it
+        output through the verbose handler if current verbosity level
+        is higher than level
+
+        if always is True, the report will occur on every function
+        call; otherwise only on the first time the function is called
+        """
+        assert(callable, func)
+        def wrapper(*args, **kwargs):
+            ret = func(*args, **kwargs)
+
+            if (always or not wrapper._spoke):
+                spoke = self.report(fmt%ret, level)
+                if not wrapper._spoke: wrapper._spoke = spoke
+            return ret
+        wrapper._spoke = False
+        wrapper.__doc__ = func.__doc__
+        return wrapper
+
+    def ge(self, level):
+        'return true if self.level is >= level'
+        return self.vald[self.level]>=self.vald[level]
+        
+verbose=Verbose('silent')  # silent until rc is parsed
 
 def get_home():
     """
@@ -168,8 +243,9 @@ def get_home():
 
     return None
 
-def get_data_path():
 
+def _get_data_path():
+    'get the path to matplotlib data'
     path = os.path.join(distutils.sysconfig.PREFIX, 'share', 'matplotlib')
     if os.path.isdir(path): return path
 
@@ -195,6 +271,8 @@ def get_data_path():
         return path
     raise RuntimeError('Could not find the matplotlib data files')
 
+get_data_path = verbose.wrap('matplotlib data path %s', _get_data_path, always=False)
+    
 
 def validate_path_exists(s):
     'If s is a path, return s, else False'
@@ -302,6 +380,26 @@ def validate_fontsize(s):
         raise ValueError('not a valid font size')
 
 
+def validate_verbose(s):
+    verbose.set_level(s)
+    return verbose
+    
+
+def validate_verbose_fileo(s):
+    d = {'sys.stdout':sys.stdout,
+         'sys.stderr':sys.stderr,
+         }
+    if d.has_key(s): verbose.fileo = d[s]
+    else:
+        try: fileo = file(s, 'w')
+        except IOError:
+            raise ValueError('Verbose object could not open log file "%s" for writing.\nCheck your matplotlibrc verbose.fileo setting'%s)
+        
+
+        else:
+            verbose.fileo = fileo
+    return verbose.fileo
+
 # a map from key -> value, converter
 defaultParams = {
     'backend'           : ['GTK', str],
@@ -311,6 +409,10 @@ def validate_fontsize(s):
     'interactive'       : [False, validate_bool],
     'timezone'          : ['UTC', str],    
 
+    # the verbosity setting
+    'verbose.level'           : ['silent', validate_verbose],
+    'verbose.fileo'           : ['sys.stdout', validate_verbose_fileo],        
+
     # line props    
     'lines.linewidth'   : [0.5, validate_float],     # line width in points
     'lines.linestyle'   : ['-', str],                # solid line
@@ -434,6 +536,8 @@ def matplotlib_fname():
         print >> sys.stderr, 'Could not find .matplotlibrc; using defaults'
     return fname
 
+
+
 def rc_params():
     'Return the default params updated from the values in the rc file'
 
@@ -448,8 +552,11 @@ def rc_params():
 
     fname = matplotlib_fname()
     if not os.path.exists(fname):
-        return dict([ (key, tup[0]) for key, tup in defaultParams.items()])
-
+        message = 'could not find rc file; returning defaults'
+        ret =  dict([ (key, tup[0]) for key, tup in defaultParams.items()])
+        verbose.report(message)
+        return ret
+        
     cnt = 0
     for line in file(fname):
         cnt +=1
@@ -488,7 +595,10 @@ def rc_params():
             defaultParams[key][0] = cval
 
     # strip the conveter funcs and return
-    return dict([ (key, tup[0]) for key, tup in defaultParams.items()])
+    ret =  dict([ (key, tup[0]) for key, tup in defaultParams.items()])
+    verbose.report('loaded rc file %s'%fname)
+    return ret
+
 
 # this is the instance used by the matplotlib classes
 rcParams = rc_params()