Renamed query_sso_maps -> query_sso

Author: imbasimba

astroquery/esasky/core.py

@@ -444,7 +444,7 @@ def find_sso(self, sso_name, *, sso_type="ALL", cache=True):
         except (HTTPError, ConnectionError) as err:
             log.error("Connection failed with {}.".format(err))
 
-    def query_sso_maps(self, sso_name, *, sso_type="ALL", missions=__ALL_STRING,
+    def query_sso(self, sso_name, *, sso_type="ALL", missions=__ALL_STRING,
                        row_limit=DEFAULT_ROW_LIMIT):
         """
         This method performs a crossmatch on the chosen solar system object
@@ -482,9 +482,9 @@ def query_sso_maps(self, sso_name, *, sso_type="ALL", missions=__ALL_STRING,
 
         Examples
         --------
-        query_sso_maps(sso_name="Pallas", missions="HST")
-        query_sso_maps(sso_name="503", sso_type="SATELLITE")
-        query_sso_maps(sso_name="503", sso_type="SATELLITE", missions=["XMM", "HST"])
+        query_sso(sso_name="Pallas", missions="HST")
+        query_sso(sso_name="503", sso_type="SATELLITE")
+        query_sso(sso_name="503", sso_type="SATELLITE", missions=["XMM", "HST"])
         """
         sso = self.find_sso(sso_name=sso_name, sso_type=sso_type)
         if len(sso) == 0:
@@ -560,7 +560,7 @@ def get_images_sso(self, *, sso_name=None, sso_type="ALL", table_list=None, miss
         table_list : `~astroquery.utils.TableList` or dict or list of (name, `~astropy.table.Table`) pairs
             A TableList or dict or list of name and Table pairs with all the
             missions wanted and their respective metadata. Usually the
-            return value of query_sso_maps.
+            return value of query_sso.
         missions : str or list, optional
             Can be either a specific mission or a list of missions (all mission
             names are found in list_sso()) or 'all' to search in all
@@ -593,7 +593,7 @@ def get_images_sso(self, *, sso_name=None, sso_type="ALL", table_list=None, miss
         get_images_sso(sso_name="503", sso_type="SATELLITE")
         get_images_sso(sso_name="503", sso_type="SATELLITE", missions=["XMM", "HST"])
 
-        table = ESASky.query_sso_maps(sso_name="503", sso_type="SATELLITE", missions=["XMM", "HST"])
+        table = ESASky.query_sso(sso_name="503", sso_type="SATELLITE", missions=["XMM", "HST"])
         table["XMM"].remove_rows([1, 18, 23])
         get_images_sso(table_list=table, missions="XMM")
 
@@ -605,7 +605,7 @@ def get_images_sso(self, *, sso_name=None, sso_type="ALL", table_list=None, miss
         sso_name = self._sanitize_input_sso_name(sso_name)
         sso_type = self._sanitize_input_sso_type(sso_type)
         if table_list is None:
-            map_query_result = self.query_sso_maps(sso_name=sso_name, sso_type=sso_type, missions=sanitized_missions)
+            map_query_result = self.query_sso(sso_name=sso_name, sso_type=sso_type, missions=sanitized_missions)
         else:
             map_query_result = self._sanitize_input_table_list(table_list)
 

astroquery/esasky/tests/test_esasky_remote.py

@@ -290,30 +290,30 @@ def test_get_columns(self):
         assert isinstance(columns[0], TapColumn)
         assert len(column_names) == len(columns)
 
-    def test_esasky_query_sso_maps(self):
-        result = ESASkyClass.query_sso_maps(sso_name="ceres")
+    def test_esasky_query_sso(self):
+        result = ESASkyClass.query_sso(sso_name="ceres")
         assert isinstance(result, TableList)
         assert "HST" in result.keys()
         assert "XMM" in result.keys()
         assert "HERSCHEL" in result.keys()
         assert len(result["HST"]) >= 176
 
-        result = ESASkyClass.query_sso_maps(sso_name="ceres", missions="HST", row_limit=1)
+        result = ESASkyClass.query_sso(sso_name="ceres", missions="HST", row_limit=1)
         assert isinstance(result, TableList)
         assert "HST" in result.keys()
         assert "XMM" not in result.keys()
         assert "HERSCHEL" not in result.keys()
         assert len(result["HST"]) == 1
 
-        result = ESASkyClass.query_sso_maps(sso_name="io", sso_type="SATELLITE", missions=["HST", "XMM"])
+        result = ESASkyClass.query_sso(sso_name="io", sso_type="SATELLITE", missions=["HST", "XMM"])
         assert isinstance(result, TableList)
         assert "HST" in result.keys()
         assert "XMM" in result.keys()
         assert "HERSCHEL" not in result.keys()
 
-    def test_esasky_query_sso_maps_ambiguous_name(self):
+    def test_esasky_query_sso_ambiguous_name(self):
         try:
-            ESASkyClass.query_sso_maps(sso_name="io")
+            ESASkyClass.query_sso(sso_name="io")
         except ValueError as err:
             assert 'Try narrowing your search' in str(err)
             return
@@ -339,7 +339,7 @@ def test_esasky_get_images_sso(self):
         if not os.path.exists(download_directory):
             os.makedirs(download_directory)
 
-        table_list = ESASkyClass.query_sso_maps(sso_name="ceres")
+        table_list = ESASkyClass.query_sso(sso_name="ceres")
         assert "HERSCHEL" in table_list.keys()
         fits_files = ESASkyClass.get_images_sso(table_list=table_list, missions="XMM",
                                                 download_dir=download_directory)

docs/esasky/esasky.rst

@@ -86,7 +86,7 @@ There are three very similar query objects methods in this module
 :meth:`~astroquery.esasky.ESASkyClass.query_object_maps`, and
 :meth:`~astroquery.esasky.ESASkyClass.query_object_spectra`.
 There is also a method for querying SSO object
-:meth:`~astroquery.esasky.ESASkyClass.query_sso_maps`
+:meth:`~astroquery.esasky.ESASkyClass.query_sso`
 which is covered in its own section further down.
 
 For catalogs, the query returns a maximum of 10000 sources per mission by
@@ -408,14 +408,14 @@ time the images were being taken.
 `Read more about the ESASky SSO feature
 <https://www.cosmos.esa.int/web/esdc/esasky-interface#SSO>`__
 You can access the results of this crossmatch by using
-:meth:`astroquery.esasky.ESASkyClass.query_sso_maps` which
+:meth:`astroquery.esasky.ESASkyClass.query_sso` which
 works like the other query methods, but it takes an SSO
 name as input instead of a position.
 
 .. code-block:: python
 
     >>> from astroquery.esasky import ESASky
-    >>> result = ESASky.query_sso_maps(sso_name="Pallas", missions=["XMM", "HST"])
+    >>> result = ESASky.query_sso(sso_name="Pallas", missions=["XMM", "HST"])
 
 In some cases an SSO name is ambiguous, in which case you
 may need to use a more precise SSO name or specify the
@@ -424,7 +424,7 @@ SSO type of the desired object. For example:
 .. code-block:: python
 
     >>> from astroquery.esasky import ESASky
-    >>> ESASky.query_sso_maps(sso_name="503")
+    >>> ESASky.query_sso(sso_name="503")
     INFO: Found 4 SSO's with name: 503.
     Try narrowing your search by typing a more specific sso_name.
     You can also narrow your search by specifying the sso_type.
@@ -440,7 +440,7 @@ In this case, you can specify the sso_type
 
 .. code-block:: python
     >>> from astroquery.esasky import ESASky
-    >>> ESASky.query_sso_maps(sso_name="503", sso_type="SATELLITE")
+    >>> ESASky.query_sso(sso_name="503", sso_type="SATELLITE")
 
 
 You can see the available missions with:
@@ -465,7 +465,7 @@ in get_maps by doing something like this:
 
 .. code-block:: python
     >>> from astroquery.esasky import ESASky
-    >>> table_list_from_query_maps=ESASky.query_sso_maps(sso_name="ganymede", missions="XMM")
+    >>> table_list_from_query_maps=ESASky.query_sso(sso_name="ganymede", missions="XMM")
     >>> table_list_from_query_maps['XMM'].remove_rows(list(range(0, 32)))
     >>> images=ESASky.get_images_sso(table_list=table_list_from_query_maps)