regularizing conf usage ande fixing suspend cache function

Author: ceb8

astroquery/__init__.py

@@ -58,11 +58,11 @@ class Conf(_config.ConfigNamespace):
           604800,  # 1 week
           'Astroquery-wide default cache timeout (seconds).'
           )
-    cache_location = _config.ConfigItem(
+    default_cache_location = _config.ConfigItem(
           os.path.join(_config.paths.get_cache_dir(), 'astroquery'),
           'Astroquery default cache location (within astropy cache).'
           )
-    use_cache = _config.ConfigItem(
+    default_cache_active = _config.ConfigItem(
         True,
         "Astroquery global cache usage, False turns off all caching."
         )

astroquery/query.py

@@ -190,14 +190,10 @@ def __init__(self):
             .format(vers=version.version,
                     olduseragent=S.headers['User-Agent']))
 
-        self.cache_location = os.path.join(
-            conf.cache_location,
-            self.__class__.__name__.split("Class")[0])
-        os.makedirs(self.cache_location, exist_ok=True)
-
         self.name = self.__class__.__name__.split("Class")[0]
-        self._cache_active = conf.use_cache
-        self.cache_timeout = conf.default_cache_timeout
+
+
+        self.reset_cache_preferences()
 
     def __call__(self, *args, **kwargs):
         """ init a fresh copy of self """
@@ -248,11 +244,11 @@ def reset_cache_preferences(self):
         """Resets cache preferences to default values"""
 
         self.cache_location = os.path.join(
-            conf.cache_location,
+            conf.default_cache_location,
             self.__class__.__name__.split("Class")[0])
         os.makedirs(self.cache_location, exist_ok=True)
 
-        self._cache_active = conf.use_cache
+        self.cache_active = conf.default_cache_active
         self.cache_timeout = conf.default_cache_timeout
 
     def _request(self, method, url,
@@ -325,7 +321,7 @@ def _request(self, method, url,
             json=json
         )
 
-        if (cache is not False) and self._cache_active:
+        if (cache is not False) and self.cache_active:
             cache = True
         else:
             cache = False
@@ -349,7 +345,7 @@ def _request(self, method, url,
                 return local_filepath
         else:
             query = AstroQuery(method, url, **req_kwargs)
-            if ((self.cache_location is None) or (not self._cache_active) or (not cache)):
+            if ((self.cache_location is None) or (not self.cache_active) or (not cache)):
                 with suspend_cache(self):
                     response = query.request(self._session, stream=stream,
                                              auth=auth, verify=verify,
@@ -499,12 +495,13 @@ class suspend_cache:
 
     def __init__(self, obj):
         self.obj = obj
+        self.original_cache_setting = self.obj.cache_active
 
     def __enter__(self):
-        self.obj._cache_active = False
+        self.obj.cache_active = False
 
     def __exit__(self, exc_type, exc_value, traceback):
-        self.obj._cache_active = True
+        self.obj.cache_active = self.original_cache_setting
         return False
 
 

astroquery/tests/test_cache.py

@@ -48,7 +48,7 @@ def _login(self, username):
 
 def test_cache_reset():
     mytest = TestClass()
-    assert mytest._cache_active
+    assert mytest.cache_active
 
     default_timeout = mytest.cache_timeout
     default_loc = mytest.cache_location
@@ -65,7 +65,7 @@ def test_cache_reset():
 def test_basic_caching():
 
     mytest = TestClass()
-    assert mytest._cache_active
+    assert mytest.cache_active
 
     mytest.clear_cache()
     assert len(os.listdir(mytest.cache_location)) == 0
@@ -96,7 +96,7 @@ def test_basic_caching():
 def test_login():
 
     mytest = TestClass()
-    assert mytest._cache_active
+    assert mytest.cache_active
 
     mytest.clear_cache()
     assert len(os.listdir(mytest.cache_location)) == 0
@@ -116,7 +116,7 @@ def test_login():
 def test_timeout():
 
     mytest = TestClass()
-    assert mytest._cache_active
+    assert mytest.cache_active
 
     mytest.clear_cache()
     assert len(os.listdir(mytest.cache_location)) == 0
@@ -136,3 +136,24 @@ def test_timeout():
     sleep(2)  # run out cache time
     resp = mytest.test_func(URL1)
     assert resp.content == TEXT2  # no see the new response
+
+
+def test_deactivate():
+
+    mytest = TestClass()
+    mytest.cache_active = False
+
+    mytest.clear_cache()
+    assert len(os.listdir(mytest.cache_location)) == 0
+
+    set_response(TEXT1)
+
+    resp = mytest.test_func(URL1)
+    assert resp.content == TEXT1
+    assert len(os.listdir(mytest.cache_location)) == 0
+
+    set_response(TEXT2)
+
+    resp = mytest.test_func(URL1)
+    assert resp.content == TEXT2
+    assert len(os.listdir(mytest.cache_location)) == 0