Allow bypassing the download mechanism in get_sample_data

jkseppan · jkseppan · commit 9027a79edcf0 · 2010-11-07T08:06:41.000Z
svn path=/branches/v1_0_maint/; revision=8776
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,7 @@
+2010-11-07 New rc parameters examples.download and examples.directory
+           allow bypassing the download mechanism in get_sample_data. 
+           - JKS
+
 2010-08-21 Change Axis.set_view_interval() so that when updating an
            existing interval, it respects the orientation of that
            interval, and can enlarge but not reduce the interval.
diff --git a/lib/matplotlib/cbook.py b/lib/matplotlib/cbook.py
@@ -649,9 +649,20 @@ def get_sample_data(fname, asfileobj=True):
       svn co https://matplotlib.svn.sourceforge.net/svnroot/matplotlib/trunk/sample_data
 
     and svn add the data file you want to support.  This is primarily
-    intended for use in mpl examples that need custom data
+    intended for use in mpl examples that need custom data.
+
+    To bypass all downloading, set the rc parameter examples.download to False
+    and examples.directory to the directory where we should look.
     """
 
+    if not matplotlib.rcParams['examples.download']:
+        directory = matplotlib.rcParams['examples.directory']
+        f = os.path.join(directory, fname)
+        if asfileobj:
+            return open(f, 'rb')
+        else:
+            return f
+
     myserver = get_sample_data.myserver
     if myserver is None:
         configdir = matplotlib.get_configdir()
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -566,7 +566,11 @@ def __call__(self, s):
     'keymap.grid' : ['g', validate_stringlist],
     'keymap.yscale' : ['l', validate_stringlist],
     'keymap.xscale' : [['k', 'L'], validate_stringlist],
-    'keymap.all_axes' : ['a', validate_stringlist]
+    'keymap.all_axes' : ['a', validate_stringlist],
+
+    # sample data
+    'examples.download' : [True, validate_bool],
+    'examples.directory' : ['', str],
 
 }
 
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -370,3 +370,12 @@ backend      : %(backend)s
 #keymap.xscale : L, k                # toggle scaling of x-axes ('log'/'linear')
 #keymap.all_axes : a                 # enable all axes
 
+# Control downloading of example data. Various examples download some
+# data from the Matplotlib svn repository to avoid distributing extra
+# files, but sometimes you want to avoid that. In that case set
+# examples.download to False and examples.directory to the directory
+# where you have a checkout of
+# https://matplotlib.svn.sourceforge.net/svnroot/matplotlib/trunk/sample_data
+
+#examples.download : True  # False to bypass downloading mechanism
+#examples.directory : ''   # absolute directory to look in if download is false
