Make globals private

jkseppan · jkseppan · commit bb22d115d6f3 · 2017-01-25T23:24:47.000+02:00
diff --git a/conftest.py b/conftest.py
@@ -80,22 +80,23 @@ def pytest_configure(config):
         IGNORED_TESTS['matplotlib'] += 'test_coding_standards'
     max_size = config.getoption('--conversion-cache-max-size')
     if max_size is not None:
-        ccache.conversion_cache = \
-            ccache.ConversionCache(max_size=int(max_size))
+        ccache._conversion_cache = \
+            ccache._ConversionCache(max_size=int(max_size))
     else:
-        ccache.conversion_cache = ccache.ConversionCache()
+        ccache._conversion_cache = ccache._ConversionCache()
     if config.pluginmanager.hasplugin('xdist'):
         config.pluginmanager.register(DeferPlugin())
 
 
 def pytest_unconfigure(config):
-    ccache.conversion_cache.expire()
+    ccache._conversion_cache.expire()
     matplotlib._called_from_pytest = False
 
 
 def pytest_sessionfinish(session):
     if hasattr(session.config, 'slaveoutput'):
-        session.config.slaveoutput['cache-report'] = ccache.conversion_cache.report()
+        session.config.slaveoutput['cache-report'] = \
+            ccache._conversion_cache.report()
 
 
 def pytest_terminal_summary(terminalreporter):
@@ -107,7 +108,7 @@ def pytest_terminal_summary(terminalreporter):
                 'gets': reduce(lambda x, y: x.union(y),
                                (rep['gets'] for rep in reports))}
     else:
-        data = ccache.conversion_cache.report()
+        data = ccache._conversion_cache.report()
     tr.write_sep('=', 'Image conversion cache report')
     tr.write_line('Hit rate: %d/%d' % (len(data['hits']), len(data['gets'])))
     if tr.config.getoption('--conversion-cache-report-misses'):
diff --git a/lib/matplotlib/testing/_conversion_cache.py b/lib/matplotlib/testing/_conversion_cache.py
@@ -21,7 +21,7 @@
 from matplotlib import checkdep_inkscape
 
 
-class ConversionCache(object):
+class _ConversionCache(object):
     """A cache that stores png files converted from svg or pdf formats.
 
     The image comparison test cases compare svg and pdf files by
@@ -180,7 +180,7 @@ def expire(self):
     def get_cache_dir():
         cachedir = _get_cachedir()
         if cachedir is None:
-            raise CacheError('No suitable configuration directory')
+            raise _CacheError('No suitable configuration directory')
         cachedir = os.path.join(cachedir, 'test_cache')
         return cachedir
 
@@ -189,13 +189,14 @@ def ensure_cache_dir(self):
             try:
                 cbook.mkdirs(self.cachedir)
             except IOError as e:
-                raise CacheError("Error creating cache directory %s: %s"
-                                 % (self.cachedir, str(e)))
+                raise _CacheError("Error creating cache directory %s: %s"
+                                  % (self.cachedir, str(e)))
         if not os.access(self.cachedir, os.W_OK):
-            raise CacheError("Cache directory %s not writable" % self.cachedir)
+            raise _CacheError("Cache directory %s not writable"
+                              % self.cachedir)
 
 
-class CacheError(Exception):
+class _CacheError(Exception):
     def __init__(self, message):
         self.message = message
 
@@ -204,4 +205,4 @@ def __str__(self):
 
 
 # A global cache instance, set by the appropriate test runner.
-conversion_cache = None
+_conversion_cache = None
diff --git a/lib/matplotlib/testing/compare.py b/lib/matplotlib/testing/compare.py
@@ -121,12 +121,12 @@ def comparable_formats():
     return ['png'] + list(converter)
 
 
-@cbook.deprecated('2.1', addendum='Use ConversionCache instead')
+@cbook.deprecated('2.1', addendum='Use _ConversionCache instead')
 def get_cache_dir():
-    return ccache.ConversionCache.get_cache_dir()
+    return ccache._ConversionCache.get_cache_dir()
 
 
-@cbook.deprecated('2.1', addendum='Use ConversionCache instead')
+@cbook.deprecated('2.1', addendum='Use _ConversionCache instead')
 def get_file_hash(path, block_size=2 ** 20):
     if path.endswith('.pdf'):
         from matplotlib import checkdep_ghostscript
@@ -136,7 +136,7 @@ def get_file_hash(path, block_size=2 ** 20):
         version_tag = checkdep_inkscape().encode('utf-8')
     else:
         version_tag = None
-    return ccache.ConversionCache._get_file_hash_static(
+    return ccache._ConversionCache._get_file_hash_static(
         path, block_size, version_tag)
 
 
@@ -148,7 +148,7 @@ def convert(filename, cache=None):
     Parameters
     ----------
     filename : str
-    cache : ConversionCache, optional
+    cache : _ConversionCache, optional
 
     Returns
     -------
@@ -256,7 +256,7 @@ def compare_images(expected, actual, tol, in_decorator=False, cache=None):
     in_decorator : bool
         If called from image_comparison decorator, this should be
         True. (default=False)
-    cache : cache.ConversionCache, optional
+    cache : matplotlib.testing._conversion_cache._ConversionCache, optional
 
     Example
     -------
diff --git a/lib/matplotlib/tests/test_cache.py b/lib/matplotlib/tests/test_cache.py
@@ -13,7 +13,7 @@
 from nose.tools import raises
 
 from matplotlib import cbook
-from matplotlib.testing.conversion_cache import ConversionCache, CacheError
+from matplotlib.testing._conversion_cache import _ConversionCache, _CacheError
 
 
 def test_cache_basic():
@@ -22,7 +22,7 @@ def test_cache_basic():
     def intmp(f):
         return os.path.join(tmpdir, f)
     try:
-        cache = ConversionCache(intmp('cache'))
+        cache = _ConversionCache(intmp('cache'))
         with open(intmp('fake.pdf'), 'w') as pdf:
             pdf.write('this is a fake pdf file')
         with open(intmp('fake.svg'), 'w') as svg:
@@ -63,7 +63,7 @@ def test_cache_expire():
     def intmp(*f):
         return os.path.join(tmpdir, *f)
     try:
-        cache = ConversionCache(intmp('cache'), 10)
+        cache = _ConversionCache(intmp('cache'), 10)
         for i in range(5):
             filename = intmp('cache', 'file%d.png' % i)
             with open(filename, 'w') as f:
@@ -95,9 +95,9 @@ def intmp(*f):
 
 def test_cache_default_dir():
     try:
-        path = ConversionCache.get_cache_dir()
+        path = _ConversionCache.get_cache_dir()
         assert path.endswith('test_cache')
-    except CacheError:
+    except _CacheError:
         pass
 
 
@@ -107,7 +107,7 @@ def test_cache_default_dir():
 def test_cache_mkdir_error(mkdirs):
     tmpdir = tempfile.mkdtemp()
     try:
-        c = ConversionCache(os.path.join(tmpdir, 'cache'))
+        c = _ConversionCache(os.path.join(tmpdir, 'cache'))
     finally:
         shutil.rmtree(tmpdir)
 
@@ -120,6 +120,6 @@ def test_cache_unwritable_error(access):
     cachedir = os.path.join(tmpdir, 'test_cache')
     try:
         cbook.mkdirs(cachedir)
-        c = ConversionCache(cachedir)
+        c = _ConversionCache(cachedir)
     finally:
         shutil.rmtree(tmpdir)
