Adding cache kwarg, use cache=False in tests

Author: bsipocz

CHANGES.rst

@@ -36,6 +36,12 @@ heasarc
 - Add alternative instance of HEASARC Server, maintained by
   INTEGRAL Science Data Center. [#1988]
 
+irsa
+^^^^
+
+- Adding ``cache`` kwarg to the class methods to be able to control the use
+  of local cache. [#2092]
+
 nasa_exoplanet_archive
 ^^^^^^^^^^^^^^^^^^^^^^
 

astroquery/irsa/core.py

@@ -125,7 +125,8 @@ class IrsaClass(BaseQuery):
 
     def query_region(self, coordinates=None, catalog=None, spatial='Cone',
                      radius=10 * u.arcsec, width=None, polygon=None,
-                     get_query_payload=False, verbose=False, selcols=None):
+                     get_query_payload=False, verbose=False, selcols=None,
+                     cache=True):
         """
         This function can be used to perform either cone, box, polygon or
         all-sky search in the catalogs hosted by the NASA/IPAC Infrared
@@ -169,7 +170,8 @@ def query_region(self, coordinates=None, catalog=None, spatial='Cone',
             conform to the standard. Defaults to `False`.
         selcols : str, optional
             Target column list with value separated by a comma(,)
-
+        cache : bool, optional
+            Use local cache when set to `True`.
 
         Returns
         -------
@@ -180,15 +182,15 @@ def query_region(self, coordinates=None, catalog=None, spatial='Cone',
                                            spatial=spatial, radius=radius,
                                            width=width, polygon=polygon,
                                            get_query_payload=get_query_payload,
-                                           selcols=selcols)
+                                           selcols=selcols, cache=cache)
         if get_query_payload:
             return response
         return self._parse_result(response, verbose=verbose)
 
     def query_region_async(self, coordinates=None, catalog=None,
                            spatial='Cone', radius=10 * u.arcsec, width=None,
                            polygon=None, get_query_payload=False,
-                           selcols=None):
+                           selcols=None, cache=True):
         """
         This function serves the same purpose as
         :meth:`~astroquery.irsa.IrsaClass.query_region`, but returns the raw
@@ -228,6 +230,8 @@ def query_region_async(self, coordinates=None, catalog=None,
             Defaults to `False`.
         selcols : str, optional
             Target column list with value separated by a comma(,)
+        cache : bool, optional
+            Use local cache when set to `True`.
 
         Returns
         -------
@@ -246,7 +250,8 @@ def query_region_async(self, coordinates=None, catalog=None,
         if get_query_payload:
             return request_payload
         response = self._request("GET", url=Irsa.IRSA_URL,
-                                 params=request_payload, timeout=Irsa.TIMEOUT)
+                                 params=request_payload, timeout=Irsa.TIMEOUT,
+                                 cache=cache)
         return response
 
     def _parse_spatial(self, spatial, coordinates, radius=None, width=None,
@@ -410,33 +415,42 @@ def _parse_result(self, response, verbose=False):
 
         return table
 
-    def list_catalogs(self):
+
+    def list_catalogs(self, cache=False):
         """
         Return a dictionary of the catalogs in the IRSA Gator tool.
 
+        Parameters
+        ----------
+        cache : bool
+            Use local cache when set to `True`. Default is `False`.
+
         Returns
         -------
         catalogs : dict
             A dictionary of catalogs where the key indicates the catalog
             name to be used in query functions, and the value is the verbose
             description of the catalog.
+
         """
         response = self._request("GET", url=Irsa.GATOR_LIST_URL,
-                                 params=dict(mode='xml'), timeout=Irsa.TIMEOUT)
+                                 params=dict(mode='xml'), cache=cache,
+                                 timeout=Irsa.TIMEOUT)
 
         root = tree.fromstring(response.content)
         catalogs = {}
         for catalog in root.findall('catalog'):
             catname = catalog.find('catname').text
             desc = catalog.find('desc').text
             catalogs[catname] = desc
+
         return catalogs
 
-    def print_catalogs(self):
+    def print_catalogs(self, cache=False):
         """
         Display a table of the catalogs in the IRSA Gator tool.
         """
-        catalogs = self.list_catalogs()
+        catalogs = self.list_catalogs(cache=cache)
         for catname in catalogs:
             print("{:30s}  {:s}".format(catname, catalogs[catname]))
 

astroquery/irsa/tests/test_irsa.py

@@ -39,7 +39,7 @@ def patch_get(request):
     return mp
 
 
-def get_mockreturn(method, url, params=None, timeout=10, **kwargs):
+def get_mockreturn(method, url, params=None, timeout=10, cache=False, **kwargs):
     filename = data_path(DATA_FILES[params['spatial']])
     content = open(filename, 'rb').read()
     return MockResponse(content, **kwargs)

astroquery/irsa/tests/test_irsa_remote.py

@@ -6,7 +6,7 @@
 from astropy.table import Table
 from astropy.coordinates import SkyCoord
 
-from ... import irsa
+from astroquery.irsa import Irsa
 
 
 OBJ_LIST = ["m31", "00h42m44.330s +41d16m07.50s",
@@ -16,41 +16,46 @@
 
 @pytest.mark.remote_data
 class TestIrsa:
-
     def test_query_region_cone_async(self):
-        response = irsa.core.Irsa.query_region_async(
-            'm31', catalog='fp_psc', spatial='Cone', radius=2 * u.arcmin)
+        response = Irsa.query_region_async(
+            'm31', catalog='fp_psc', spatial='Cone', radius=2 * u.arcmin, cache=False)
         assert response is not None
 
     def test_query_region_cone(self):
-        result = irsa.core.Irsa.query_region(
-            'm31', catalog='fp_psc', spatial='Cone', radius=2 * u.arcmin)
+        result = Irsa.query_region(
+            'm31', catalog='fp_psc', spatial='Cone', radius=2 * u.arcmin, cache=False)
         assert isinstance(result, Table)
 
     def test_query_region_box_async(self):
-        response = irsa.core.Irsa.query_region_async(
+        response = Irsa.query_region_async(
             "00h42m44.330s +41d16m07.50s", catalog='fp_psc', spatial='Box',
-            width=2 * u.arcmin)
+            width=2 * u.arcmin, cache=False)
         assert response is not None
 
     def test_query_region_box(self):
-        result = irsa.core.Irsa.query_region(
+        result = Irsa.query_region(
             "00h42m44.330s +41d16m07.50s", catalog='fp_psc', spatial='Box',
-            width=2 * u.arcmin)
+            width=2 * u.arcmin, cache=False)
         assert isinstance(result, Table)
 
     def test_query_region_async_polygon(self):
         polygon = [SkyCoord(ra=10.1, dec=10.1, unit=(u.deg, u.deg)),
                    SkyCoord(ra=10.0, dec=10.1, unit=(u.deg, u.deg)),
                    SkyCoord(ra=10.0, dec=10.0, unit=(u.deg, u.deg))]
-        response = irsa.core.Irsa.query_region_async(
-            "m31", catalog="fp_psc", spatial="Polygon", polygon=polygon)
+        response = Irsa.query_region_async(
+            "m31", catalog="fp_psc", spatial="Polygon", polygon=polygon, cache=False)
 
         assert response is not None
 
     def test_query_region_polygon(self):
         polygon = [(10.1, 10.1), (10.0, 10.1), (10.0, 10.0)]
-        result = irsa.core.Irsa.query_region(
-            "m31", catalog="fp_psc", spatial="Polygon", polygon=polygon)
+        result = Irsa.query_region(
+            "m31", catalog="fp_psc", spatial="Polygon", polygon=polygon, cache=False)
 
         assert isinstance(result, Table)
+
+    def test_list_catalogs(self):
+        catalogs = Irsa.list_catalogs(cache=False)
+        # Number of available catalogs may change over time, test only for significant drop.
+        # (at the time of writing there are 587 catalogs in the list).
+        assert len(catalogs) > 500