Rename collections --> surveys

Author: juanmcloaiza

astroquery/eso/core.py

@@ -71,7 +71,7 @@ class EsoNames:
     raw_table = "dbo.raw"
     phase3_table = "ivoa.ObsCore"
     raw_instruments_column = "instrument"
-    phase3_collections_column = "obs_collection"
+    phase3_surveys_column = "obs_collection"
 
     @staticmethod
     def ist_table(instrument_name):
@@ -108,7 +108,7 @@ class EsoClass(QueryWithLogin):
     def __init__(self):
         super().__init__()
         self._instruments: Optional[List[str]] = None
-        self._collections: Optional[List[str]] = None
+        self._surveys: Optional[List[str]] = None
         self._auth_info: Optional[AuthInfo] = None
         self._hash = None
         self._maxrec = None
@@ -305,8 +305,8 @@ def list_instruments(self) -> List[str]:
         return self._instruments
 
     @unlimited_max_rec
-    def list_collections(self) -> List[str]:
-        """ List all the available collections (phase 3) in the ESO archive.
+    def list_surveys(self) -> List[str]:
+        """ List all the available surveys (phase 3) in the ESO archive.
 
         Returns
         -------
@@ -315,14 +315,14 @@ def list_collections(self) -> List[str]:
             Defaults to True. If set overrides global caching behavior.
             See :ref:`caching documentation <astroquery_cache>`.
         """
-        if self._collections is None:
-            self._collections = []
+        if self._surveys is None:
+            self._surveys = []
             t = EsoNames.phase3_table
-            c = EsoNames.phase3_collections_column
+            c = EsoNames.phase3_surveys_column
             query_str = f"select distinct {c} from {t}"
             res = self.query_tap_service(query_str)[c].data
-            self._collections = list(res)
-        return self._collections
+            self._surveys = list(res)
+        return self._surveys
 
     @unlimited_max_rec
     def print_table_help(self, table_name: str) -> None:
@@ -386,16 +386,16 @@ def _query_on_allowed_values(
             message += f"Values provided: ra = {ra}, dec = {dec}, radius = {radius}"
             raise ValueError(message)
 
-        where_collections_strlist = []
+        where_allowed_vals_strlist = []
         if allowed_values:
             if isinstance(allowed_values, str):
                 allowed_values = _split_str_as_list_of_str(allowed_values)
 
             allowed_values = list(map(lambda x: f"'{x.strip()}'", allowed_values))
-            where_collections_strlist = [f"{column_name} in (" + ", ".join(allowed_values) + ")"]
+            where_allowed_vals_strlist = [f"{column_name} in (" + ", ".join(allowed_values) + ")"]
 
         where_constraints_strlist = [f"{k} = {adql_sanitize_val(v)}" for k, v in filters.items()]
-        where_constraints = where_collections_strlist + where_constraints_strlist
+        where_constraints = where_allowed_vals_strlist + where_constraints_strlist
         query = py2adql(table=table_name, columns=columns,
                         ra=ra, dec=dec, radius=radius,
                         where_constraints=where_constraints,
@@ -412,9 +412,9 @@ def _query_on_allowed_values(
 
         return retval
 
-    def query_collections(
+    def query_surveys(
             self,
-            collections: Union[List[str], str] = None, *,
+            surveys: Union[List[str], str] = None, *,
             ra: float = None, dec: float = None, radius: float = None,
             columns: Union[List, str] = None,
             top: int = None,
@@ -424,8 +424,8 @@ def query_collections(
             authenticated: bool = False,
             **kwargs) -> Union[astropy.table.Table, int, str]:
         return self._query_on_allowed_values(table_name=EsoNames.phase3_table,
-                                             column_name=EsoNames.phase3_collections_column,
-                                             allowed_values=collections,
+                                             column_name=EsoNames.phase3_surveys_column,
+                                             allowed_values=surveys,
                                              ra=ra, dec=dec, radius=radius,
                                              columns=columns,
                                              top=top,

astroquery/eso/tests/test_eso.py

@@ -142,7 +142,7 @@ def test_vvv(monkeypatch):
     # monkeypatch instructions from https://pytest.org/latest/monkeypatch.html
     eso = Eso()
     monkeypatch.setattr(eso, 'query_tap_service', monkey_tap)
-    result = eso.query_collections(collections='VVV',
+    result = eso.query_surveys(surveys='VVV',
                                    ra=266.41681662, dec=-29.00782497,
                                    radius=0.1775,
                                    )
@@ -155,7 +155,7 @@ def test_vvv(monkeypatch):
 def test_list_collections(monkeypatch):
     eso = Eso()
     monkeypatch.setattr(eso, 'query_tap_service', monkey_tap)
-    saved_list = eso.list_collections()
+    saved_list = eso.list_surveys()
     assert isinstance(saved_list, list)
     assert set(TEST_COLLECTIONS) <= set(saved_list)
 

astroquery/eso/tests/test_eso_remote.py

@@ -66,7 +66,7 @@ def test_row_limit(self):
             assert n == eso.maxrec, f"Expected {eso.maxrec}; Obtained {n}"
 
         with pytest.warns(MaxResultsWarning):
-            table = eso.query_collections('VVV')
+            table = eso.query_surveys('VVV')
             n = len(table)
             assert n == eso.maxrec, f"Expected {eso.maxrec}; Obtained {n}"
 
@@ -86,7 +86,7 @@ def test_top(self):
         n = len(table)
         assert n == top, f"Expected {top}; Obtained {n}"
 
-        table = eso.query_collections('VVV', top=top)
+        table = eso.query_surveys('VVV', top=top)
         n = len(table)
         assert n == top, f"Expected {top}; Obtained {n}"
 
@@ -107,12 +107,12 @@ def test_sgrastar(self):
             result_i = eso.query_instrument('midi', ra=266.41681662,
                                             dec=-29.00782497, radius=1.0)
 
-        collections = eso.list_collections()
+        collections = eso.list_surveys()
         assert len(collections) > 0
         # result_s = eso.query_collections('VVV', target='Sgr A*')
         # Equivalent, does not depend on SESAME:
         with pytest.warns(MaxResultsWarning):
-            result_s = eso.query_collections(collections='VVV', ra=266.41681662,
+            result_s = eso.query_surveys(surveys='VVV', ra=266.41681662,
                                              dec=-29.00782497,
                                              radius=1.0)
 
@@ -142,7 +142,7 @@ def test_multicollection(self, tmp_path):
 
         test_collections = ['VVV', 'XSHOOTER']
         with pytest.warns(MaxResultsWarning):
-            result_s = eso.query_collections(collections=test_collections,
+            result_s = eso.query_surveys(surveys=test_collections,
                                              ra=266.41681662,
                                              dec=-29.00782497,
                                              radius=1.0)
@@ -158,12 +158,12 @@ def test_multicollection(self, tmp_path):
     def test_empty_return(self):
         # test for empty return with an object from the North
         eso = Eso()
-        collections = eso.list_collections()
+        collections = eso.list_surveys()
         assert len(collections) > 0
 
         # Avoid SESAME
         with pytest.warns(NoResultsWarning):
-            result_s = eso.query_collections(collections=collections[0], ra=202.469575,
+            result_s = eso.query_surveys(surveys=collections[0], ra=202.469575,
                                              dec=47.195258, radius=1.0)
 
         assert len(result_s) == 0
@@ -243,23 +243,23 @@ def test_each_collection_sgrastar(self, tmp_path):
         eso.cache_location = tmp_path
         eso.maxrec = 1
 
-        collections = eso.list_collections()
+        collections = eso.list_surveys()
         for collection in collections:
             if collection in SGRA_COLLECTIONS:
                 with pytest.warns(MaxResultsWarning):
-                    result_s = eso.query_collections(
-                        collections=collection,
+                    result_s = eso.query_surveys(
+                        surveys=collection,
                         ra=266.41681662, dec=-29.00782497, radius=0.1775)
                 assert len(result_s) > 0
             else:
                 with pytest.warns(NoResultsWarning):
-                    result_s = eso.query_collections(collections=collection, ra=266.41681662,
+                    result_s = eso.query_surveys(surveys=collection, ra=266.41681662,
                                                      dec=-29.00782497,
                                                      radius=0.1775)
                     assert len(result_s) == 0, f"Failed for collection {collection}"
 
                 with pytest.warns(MaxResultsWarning):
-                    generic_result = eso.query_collections(collections=collection)
+                    generic_result = eso.query_surveys(surveys=collection)
 
                     assert generic_result is not None, \
                         f"query_collection({collection}) returned None"