rename query_by_columns to query_constraints

Author: zoghbi-a

astroquery/heasarc/core.py

@@ -295,7 +295,7 @@ def _query_execute(self, catalog=None, where=None, *,
                        get_query_payload=False, columns=None,
                        verbose=False, maxrec=None):
         """Queries some catalog using the HEASARC TAP server based on the
-        where condition and returns an `~astropy.table.Table`.
+        'where' condition and returns an `~astropy.table.Table`.
 
         Parameters
         ----------
@@ -531,22 +531,22 @@ def query_object(self, object_name, mission, *,
         return self.query_region(pos, catalog=mission, spatial='cone',
                                  get_query_payload=get_query_payload)
 
-    def query_by_column(self, catalog, params, *,
-                        get_query_payload=False, columns=None,
-                        verbose=False, maxrec=None):
+    def query_constraints(self, catalog, column_filters, *,
+                          get_query_payload=False, columns=None,
+                          verbose=False, maxrec=None):
         """Query the HEASARC TAP server using a constraints on the columns.
 
         This is a simple wrapper around
         `~astroquery.heasarc.HeasarcClass.query_tap`
-        that constructs an ADQL query from a dictionary of parameters.
+        that constructs an ADQL query from a dictionary of filters.
 
         Parameters
         ----------
         catalog : str
             The catalog to query. To list the available catalogs, use
             :meth:`~astroquery.heasarc.HeasarcClass.list_catalogs`.
-        params : dict
-            A dictionary of column constraint parameters to include in the query.
+        column_filters : dict
+            A dictionary of column constraint filters to include in the query.
             Each key-value pair will be translated into an ADQL condition.
             - For a range query, use a tuple of two values (min, max).
             e.g. ``{'flux': (1e-12, 1e-10)}`` translates to
@@ -576,11 +576,11 @@ def query_by_column(self, catalog, params, *,
 
         """
 
-        if not isinstance(params, dict):
+        if not isinstance(column_filters, dict):
             raise ValueError('params must be a dictionary of key-value pairs')
 
         conditions = []
-        for key, value in params.items():
+        for key, value in column_filters.items():
             if isinstance(value, tuple):
                 if (
                     len(value) == 2
@@ -784,15 +784,15 @@ def _guess_host(self, host):
                 return 'aws'
         return 'heasarc'
 
-    def download_data(self, links, host=None, location='.'):
+    def download_data(self, links, *, host=None, location='.'):
         """Download data products in links with a choice of getting the
         data from either the heasarc server, sciserver, or the cloud in AWS.
 
 
         Parameters
         ----------
         links : `astropy.table.Table` or `astropy.table.Row`
-            The result from locate_data
+            A table (or row) of data links, typically the result of locate_data.
         host : str or None
             The data host. The options are: None (default), heasarc, sciserver, aws.
             If None, the host is guessed based on the environment.

astroquery/heasarc/tests/test_heasarc.py

@@ -231,11 +231,11 @@ def test_no_catalog():
             OBJ_LIST[0], spatial="cone", columns="*", radius="2arcmin")
 
 
-def test_by_columns_no_catalog():
+def test_query_constraints_no_catalog():
     with pytest.raises(InvalidQueryError):
         # OBJ_LIST[0] and radius added to avoid a remote call
-        Heasarc.query_by_column(
-            None, params={"flux": (1e-12, 1e-10)})
+        Heasarc.query_constraints(
+            None, column_filters={"flux": (1e-12, 1e-10)})
 
 
 def test__query_execute_no_catalog():
@@ -244,87 +244,87 @@ def test__query_execute_no_catalog():
         Heasarc._query_execute(None)
 
 
-def test_by_columns_none_params():
+def test_query_constraints_none_params():
     with pytest.raises(ValueError):
-        Heasarc.query_by_column('testcatalog', params=None)
+        Heasarc.query_constraints('testcatalog', column_filters=None)
 
 
-def test_by_columns_no_params():
-    query = Heasarc.query_by_column(
+def test_query_constraints_no_params():
+    query = Heasarc.query_constraints(
         catalog="suzamaster",
-        params={},
+        column_filters={},
         columns="*",
         get_query_payload=True,
     )
     assert query == "SELECT * FROM suzamaster"
 
 
-def test_by_columns_limit():
-    query = Heasarc.query_by_column(
+def test_query_constraints_limit():
+    query = Heasarc.query_constraints(
         catalog="suzamaster",
-        params={},
+        column_filters={},
         columns="*",
         get_query_payload=True,
         maxrec=500000,
     )
     assert query == "SELECT TOP 2000000 * FROM suzamaster"
 
 
-def test_by_columns_range():
-    query = Heasarc.query_by_column(
+def test_query_constraints_range():
+    query = Heasarc.query_constraints(
         catalog="suzamaster",
-        params={"flux": (1e-12, 1e-10)},
+        column_filters={"flux": (1e-12, 1e-10)},
         columns="*",
         get_query_payload=True,
     )
     assert query == "SELECT * FROM suzamaster WHERE flux BETWEEN 1e-12 AND 1e-10"
 
 
-def test_by_columns_eq_float():
-    query = Heasarc.query_by_column(
+def test_query_constraints_eq_float():
+    query = Heasarc.query_constraints(
         catalog="suzamaster",
-        params={"flux": 1.2},
+        column_filters={"flux": 1.2},
         columns="*",
         get_query_payload=True,
     )
     assert query == "SELECT * FROM suzamaster WHERE flux = 1.2"
 
 
-def test_by_columns_eq_str():
-    query = Heasarc.query_by_column(
+def test_query_constraints_eq_str():
+    query = Heasarc.query_constraints(
         catalog="suzamaster",
-        params={"flux": "1.2"},
+        column_filters={"flux": "1.2"},
         columns="*",
         get_query_payload=True,
     )
     assert query == "SELECT * FROM suzamaster WHERE flux = '1.2'"
 
 
-def test_by_columns_cmp_float():
-    query = Heasarc.query_by_column(
+def test_query_constraints_cmp_float():
+    query = Heasarc.query_constraints(
         catalog="suzamaster",
-        params={"flux": ('>', 1.2)},
+        column_filters={"flux": ('>', 1.2)},
         columns="*",
         get_query_payload=True,
     )
     assert query == "SELECT * FROM suzamaster WHERE flux > 1.2"
 
 
-def test_by_columns_cmp_float_2():
-    query = Heasarc.query_by_column(
+def test_query_constraints_cmp_float_2():
+    query = Heasarc.query_constraints(
         catalog="suzamaster",
-        params={"flux": ('>', 1.2), "magnitude": ('<=', 15)},
+        column_filters={"flux": ('>', 1.2), "magnitude": ('<=', 15)},
         columns="*",
         get_query_payload=True,
     )
     assert query == ("SELECT * FROM suzamaster WHERE flux > 1.2 "
                      "AND magnitude <= 15")
 
 
-def test_by_columns_list():
-    query = Heasarc.query_by_column(
+def test_query_constraints_by_columns_list():
+    query = Heasarc.query_constraints(
         catalog="suzamaster",
-        params={"flux": [1.2, 2.3, 3.4]},
+        column_filters={"flux": [1.2, 2.3, 3.4]},
         columns="*",
         get_query_payload=True,
     )

astroquery/heasarc/tests/test_heasarc_remote.py

@@ -188,7 +188,7 @@ def test_download_data__heasarc_file(self):
         filename = "00README"
         tab = Table({
             "access_url": [
-                ("https://heasarc.gsfc.nasa.gov/FTP/rxte/"
+                ("https://heasarc.gsfc.nasa.gov/FTP/xte/"
                  f"data/archive/{filename}")
             ]
         })
@@ -199,7 +199,7 @@ def test_download_data__heasarc_file(self):
     def test_download_data__heasarc_folder(self):
         tab = Table({
             "access_url": [
-                ("https://heasarc.gsfc.nasa.gov/FTP/rxte/data/archive/"
+                ("https://heasarc.gsfc.nasa.gov/FTP/xte/data/archive/"
                  "AO10/P91129/91129-01-68-00A/stdprod")
             ]
         })
@@ -213,7 +213,7 @@ def test_download_data__heasarc_folder(self):
     def test_download_data__s3_file(self):
         filename = "00README"
         tab = Table(
-            {"aws": [f"s3://nasa-heasarc/rxte/data/archive/{filename}"]}
+            {"aws": [f"s3://nasa-heasarc/xte/data/archive/{filename}"]}
         )
         with tempfile.TemporaryDirectory() as tmpdir:
             Heasarc.enable_cloud(provider='aws', profile=None)
@@ -225,7 +225,7 @@ def test_download_data__s3_folder(self, slash):
         tab = Table(
             {
                 "aws": [
-                    (f"s3://nasa-heasarc/rxte/data/archive/AO10/"
+                    (f"s3://nasa-heasarc/xte/data/archive/AO10/"
                      f"P91129/91129-01-68-00A/stdprod{slash}")
                 ]
             }

docs/heasarc/heasarc.rst

@@ -183,16 +183,16 @@ following for instance will find master catalogs that have keywords 'nicer' or '
 
 Other non-region queries
 ----------------------------------------
-In addition to `~astroquery.heasarc.HeasarcClass.query_region`, `~astroquery.heasarc.HeasarcClass.query_by_column`
+In addition to `~astroquery.heasarc.HeasarcClass.query_region`, `~astroquery.heasarc.HeasarcClass.query_constraints`
 is also available. This method allows you to query a catalog by specifying
 various column constraints. For example, the following query searches the ``chanmaster``
 catalog for all observations with exposure time greater than 190 ks.
 
 .. doctest-remote-data::
 
     >>> from astroquery.heasarc import Heasarc
-    >>> tab = Heasarc.query_by_column(
-    ...     catalog='chanmaster', params={'exposure': ('>', '190000')}
+    >>> tab = Heasarc.query_constraints(
+    ...     catalog='chanmaster', column_filters={'exposure': ('>', '190000')}
     ... )
     >>> tab['name', 'obsid', 'ra', 'dec', 'exposure'][:3].pprint()
         name      obsid     ra       dec    exposure
@@ -207,8 +207,8 @@ Another example may be to search the ``xmmmaster`` for a observation in some tim
 .. doctest-remote-data::
 
     >>> from astroquery.heasarc import Heasarc
-    >>> tab = Heasarc.query_by_column(
-    ...     catalog='xmmmaster', params={'time': (52300, 52310)}
+    >>> tab = Heasarc.query_constraints(
+    ...     catalog='xmmmaster', column_filters={'time': (52300, 52310)}
     ... )
     >>> tab['name', 'obsid', 'ra', 'dec', 'time', 'duration'][:3].pprint()
          name       obsid       ra       dec          time       duration