made new dfault config file dir .matplotlib

jdh2358 · jdh2358 · commit efa9ea6a2fd2 · 2005-07-06T14:37:37.000Z
svn path=/trunk/matplotlib/; revision=1538
diff --git a/API_CHANGES b/API_CHANGES
@@ -1,5 +1,14 @@
 
-API Changes in matplotlib-0.82.1
+API Changes in matplotlib-0.83
+
+  Made HOME/.matplotlib the new config dir where the matplotlibrc
+  file, the ttf.cache, and the tex.cache live.  The new default
+  filenames in .matplotlib have no leading dot and are not hidden.
+  Eg, the new names are matplotlibrc tex.cache ttffont.cache.  This is
+  how ipython does it so it must be right.
+
+           If old files are found, a warning is issued and they are
+           moved to the new location.
 
   backends/__init__.py no longer imports new_figure_manager,
   draw_if_interactive and show from the default backend, but puts
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,5 +1,17 @@
 New entries should be added at the top
 
+2005-07-06 Made HOME/.matplotlib the new config dir where the
+           matplotlibrc file, the ttf.cache, and the tex.cache live.
+           The new default filenames in .matplotlib have no leading
+           dot and are not hidden.  Eg, the new names are matplotlibrc
+           tex.cache ttffont.cache.  This is how ipython does it so it
+           must be right.  If old files are found, a warning is issued
+           and they are moved to the new location.  Also fixed
+           texmanager to put all files, including temp files in
+           ~/.matplotlib/tex.cache, which allows you to usetex in
+           non-writable dirs.
+
+
 2005-07-05 Fixed bug #1231611 in subplots adjust layout.  The problem
            was that the text cacheing mechanism was not using the
            transformation affine in the key. - JDH
diff --git a/LICENSE/LICENSE b/LICENSE/LICENSE
@@ -1,4 +1,4 @@
-LICENSE AGREEMENT FOR MATPLOTLIB 0.82
+LICENSE AGREEMENT FOR MATPLOTLIB 0.83a
 --------------------------------------
 
 1. This LICENSE AGREEMENT is between 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.82
+derivative works, distribute, and otherwise use matplotlib 0.83a
 alone or in any derivative version, provided, however, that JDH's
 License Agreement and JDH's notice of copyright, i.e., "Copyright (c)
 2002-2005 John D. Hunter; All Rights Reserved" are retained in
-matplotlib 0.82 alone or in any derivative version prepared by
+matplotlib 0.83a 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.82 or any part thereof, and wants to
+incorporates matplotlib 0.83a 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.82.
+the changes made to matplotlib 0.83a.
 
-4. JDH is making matplotlib 0.82 available to Licensee on an "AS
+4. JDH is making matplotlib 0.83a 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.82
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF MATPLOTLIB 0.83a
 WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.
 
 5. JDH SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF MATPLOTLIB
-0.82 FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR
+0.83a FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR
 LOSS AS A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING
-MATPLOTLIB 0.82, OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF
+MATPLOTLIB 0.83a, 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.82,
+8. By copying, installing or otherwise using matplotlib 0.83a,
 Licensee agrees to be bound by the terms and conditions of this License
 Agreement.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,7 +1,7 @@
 include API_CHANGES CHANGELOG KNOWN_BUGS INSTALL NUMARRAY_ISSUES
 include INTERACTIVE TODO
 include Makefile  MANIFEST.in MANIFEST
-include .matplotlibrc
+include matplotlibrc
 include __init__.py setupext.py setup.py makeswig.py
 include examples/data/*
 include images/*
diff --git a/examples/tex_demo.py b/examples/tex_demo.py
@@ -28,7 +28,7 @@
 title(r"\TeX\ is Number $\displaystyle\sum_{n=1}^\infty\frac{-e^{i\pi}}{2^n}$!", 
       fontsize=16, color='r')
 grid(True)
-savefig('tex_demo.eps')
+#savefig('tex_demo.eps')
 
 
 show()
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -142,7 +142,7 @@
 """
 from __future__ import generators
 
-__version__  = '0.82'
+__version__  = '0.83a'
 __revision__ = '$Revision$'
 __date__     = '$Date$'
 
@@ -159,13 +159,13 @@
 
   - environment variable MATPLOTLIBRC
 
-  - HOME/.matplotlibrc if HOME is defined
+  - HOME/.matplotlib/matplotlibrc if HOME is defined
 
-  - PATH/.matplotlibrc where PATH is the return value of
+  - PATH/matplotlibrc where PATH is the return value of
     get_data_path()
 """
 
-import sys, os
+import sys, os, tempfile
 
     
 major, minor1, minor2, s, tmp = sys.version_info
@@ -186,6 +186,21 @@ def enumerate(seq):
              yield i, seq[i]
 
 
+
+def _is_writable_dir(p):
+    """
+    p is a string pointing to a putative writable dir -- return True p
+    is such a string, else False
+    """
+    try: p + ''  # test is string like
+    except TypeError: return False    
+    try:
+        t = tempfile.TemporaryFile(dir=p)
+        t.write('1')
+        t.close()
+    except OSError: return False
+    else: return True
+
 class Verbose:
     """
     A class to handle reporting.  Set the fileo attribute to any file
@@ -259,23 +274,65 @@ def ge(self, level):
         
 verbose=Verbose('silent')  
 
-def get_home():
+
+def _get_home():
+    """Return the closest possible equivalent to a 'home' directory.
+
+    We first try $HOME.  Absent that, on NT it's USERPROFILE if
+    defined, else, $HOMEDRIVE\$HOMEPATH, else C:\
+
     """
-    return the users HOME dir across platforms or None.
-    
-    On win32, if either HOME is not set or HOME is set but doesn't
-    exist, the value of USERPROFILE will be used instead.
+
+     
+    try: return os.environ['HOME']
+    except KeyError: pass
+
+    if os.name == 'nt':  
+        # For some strange reason, win9x returns 'nt' for os.name.
+
+        try: p = os.environ['USERPROFILE']
+        except KeyError: pass
+        else:
+            if os.path.exists(p): return p
+        
+        try: p =  os.path.join(os.environ['HOMEDRIVE'],os.environ['HOMEPATH'])
+        except KeyError: pass
+        else:
+            if os.path.exists(p): return p
+
+        try:
+            import _winreg as wreg
+            key = wreg.OpenKey(wreg.HKEY_CURRENT_USER,
+                               'Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders')
+            p = wreg.QueryValueEx(key,'Personal')[0]
+            key.Close()
+            if os.path.exists(p): return p
+        except: pass
+        return 'C:\\'
+
+    raise RuntimeError('please define environment variable $HOME')
+
+
+
+
+get_home = verbose.wrap('$HOME=%s', _get_home, always=False)
+
+def _get_configdir():
     """
+    Return the string representing the configuration dir.  If s is the
+    special string _default_, use HOME/.matplotlib.  s must be writable
+    """
+    h = get_home()
+    if not _is_writable_dir(h):
+        raise RuntimeError("'%s' is not a writable dir; you must set environment variable HOME to be a writable dir "%h)
 
-    if os.environ.has_key('HOME'):
-        path = os.environ['HOME']
-        if os.path.exists(path): return path
+    p = os.path.join(get_home(), '.matplotlib')
 
-    if sys.platform=='win32' and os.environ.has_key('USERPROFILE'):
-        path = os.environ['USERPROFILE']
-        if os.path.exists(path): return path
+    if not _is_writable_dir(p):
+        os.mkdir(p)
 
-    return None
+    return p
+get_configdir = verbose.wrap('$HOME=%s', _get_configdir, always=False)
 
 
 def _get_data_path():
@@ -320,6 +377,7 @@ def _get_data_path():
 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'
     if os.path.exists(s): return s
@@ -594,7 +652,7 @@ def __call__(self, s):
 
     'grid.color'       :   ['k', validate_color],       # grid color
     'grid.linestyle'   :   [':', str],       # dotted
-    'grid.linewidth'   :   ['0.5', validate_float],     # in points            
+    'grid.linewidth'   :   [0.5, validate_float],     # in points            
 
 
     # figure props
@@ -628,17 +686,9 @@ def __call__(self, s):
     }
 
 
-def matplotlib_fname():
+def _old_matplotlib_fname():
     """
-    Return the path to the rc file
-
-    Search order:
-
-     * current working dir
-     * environ var MATPLOTLIBRC
-     * HOME/.matplotlibrc
-     * MATPLOTLIBDATA/.matplotlibrc
-     
+    Return the path to the rc file using the old search method
     """
 
     fname = os.path.join( os.getcwd(), '.matplotlibrc')
@@ -663,6 +713,60 @@ def matplotlib_fname():
         warnings.warn('Could not find .matplotlibrc; using defaults')
     return fname
 
+def matplotlib_fname():
+    """
+    Return the path to the rc file
+
+    Search order:
+
+     * current working dir
+     * environ var MATPLOTLIBRC
+     * HOME/.matplotlib/matplotlibrc
+     * MATPLOTLIBDATA/matplotlibrc
+     
+
+    """
+
+    oldname = os.path.join( os.getcwd(), '.matplotlibrc')
+    if os.path.exists(oldname):
+        print >> sys.stderr, """\
+WARNING: Old rc filename ".matplotlibrc" found in working dir
+  and and renamed to new default rc file name "matplotlibrc"
+  (no leading"dot"). """
+        os.rename('.matplotlibrc', 'matplotlibrc')
+
+    home = get_home()
+    oldname = os.path.join( home, '.matplotlibrc')
+    if os.path.exists(oldname):
+        configdir = get_configdir()
+        newname = os.path.join(configdir, 'matplotlibrc')
+        print >> sys.stderr, """\
+WARNING: Old rc filename "%s" found and renamed to
+  new default rc file name "%s"."""%(oldname, newname)
+
+        os.rename(oldname, newname)
+            
+        
+    fname = os.path.join( os.getcwd(), 'matplotlibrc')
+    if os.path.exists(fname): return fname
+
+    if os.environ.has_key('MATPLOTLIBRC'):
+        path =  os.environ['MATPLOTLIBRC']
+        if os.path.exists(path):
+            fname = os.path.join(path, 'matplotlibrc')
+            if os.path.exists(fname):
+                return fname
+
+    fname = os.path.join(get_configdir(), 'matplotlibrc')
+    if os.path.exists(fname): return fname
+    
+    
+    path =  get_data_path() # guaranteed to exist or raise
+    fname = os.path.join(path, 'matplotlibrc')
+    if not os.path.exists(fname):
+        warnings.warn('Could not find matplotlibrc; using defaults')
+    return fname
+
 
 
 def rc_params():
@@ -699,7 +803,7 @@ def rc_params():
         key = key.strip()
         if key in deprecated_map.keys():
             alt = deprecated_map[key]
-            warnings.warn('%s is deprecated in .matplotlibrc - use %s instead.' % (key, alt))
+            warnings.warn('%s is deprecated in matplotlibrc - use %s instead.' % (key, alt))
             key = alt
             
         if not defaultParams.has_key(key):
@@ -809,6 +913,12 @@ def rcdefaults():
     rcParams.update(rcParamsDefault)
 
 
+    
+    
+        
+    
+
+
 
 # Now allow command line to override
 
diff --git a/lib/matplotlib/axes.py b/lib/matplotlib/axes.py
@@ -2750,9 +2750,9 @@ def scatter(self, x, y, s=20, c='b', marker='o', cmap=None, norm=None,
                     faceted=True,
                     **kwargs):
         """
-        SCATTER(x, y, s=20, c='b', marker='o', cmap=None, norm=None,
-                vmin=None, vmax=None, alpha=1.0)
-
+    SCATTER(x, y, s=20, c='b', marker='o', cmap=None, norm=None,
+            vmin=None, vmax=None, alpha=1.0, linewidths=None,
+            faceted=True, **kwargs)        
         Supported function signatures:
 
             SCATTER(x, y) - make a scatter plot of x vs y
diff --git a/lib/matplotlib/backends/backend_gtk.py b/lib/matplotlib/backends/backend_gtk.py
@@ -20,6 +20,7 @@ def fn_name(): return sys._getframe(1).f_code.co_name
 
 from backend_gdk import RendererGDK
 
+
 pygtk_version_required = (2,0,0)
 try:
     import pygtk
diff --git a/lib/matplotlib/backends/backend_ps.py b/lib/matplotlib/backends/backend_ps.py
@@ -935,7 +935,9 @@ def print_figure(self, outfile, dpi=72,
                 # need to make some temporary files so latex can run without
                 # writing over something important.
                 m = md5.md5(outfile)
-                tmpname = m.hexdigest()
+                tmpname = os.path.join(TexManager.texcache, m.hexdigest())
+                os.environ['TEXMFOUTPUT'] = TexManager.texcache
+                
                 epsfile = tmpname + '.eps'
                 psfile = tmpname + '.ps'
                 texfile = tmpname + '.tex'
diff --git a/lib/matplotlib/font_manager.py b/lib/matplotlib/font_manager.py
diff --git a/lib/matplotlib/lines.py b/lib/matplotlib/lines.py
diff --git a/lib/matplotlib/texmanager.py b/lib/matplotlib/texmanager.py
diff --git a/setup.py b/setup.py
