Skip to content

Commit 30d90a0

Browse files
committed
rename query_by_columns to query_constraints
1 parent d0ecb45 commit 30d90a0

File tree

4 files changed

+49
-49
lines changed

4 files changed

+49
-49
lines changed

astroquery/heasarc/core.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,7 @@ def _query_execute(self, catalog=None, where=None, *,
295295
get_query_payload=False, columns=None,
296296
verbose=False, maxrec=None):
297297
"""Queries some catalog using the HEASARC TAP server based on the
298-
where condition and returns an `~astropy.table.Table`.
298+
'where' condition and returns an `~astropy.table.Table`.
299299
300300
Parameters
301301
----------
@@ -531,22 +531,22 @@ def query_object(self, object_name, mission, *,
531531
return self.query_region(pos, catalog=mission, spatial='cone',
532532
get_query_payload=get_query_payload)
533533

534-
def query_by_column(self, catalog, params, *,
535-
get_query_payload=False, columns=None,
536-
verbose=False, maxrec=None):
534+
def query_constraints(self, catalog, column_filters, *,
535+
get_query_payload=False, columns=None,
536+
verbose=False, maxrec=None):
537537
"""Query the HEASARC TAP server using a constraints on the columns.
538538
539539
This is a simple wrapper around
540540
`~astroquery.heasarc.HeasarcClass.query_tap`
541-
that constructs an ADQL query from a dictionary of parameters.
541+
that constructs an ADQL query from a dictionary of filters.
542542
543543
Parameters
544544
----------
545545
catalog : str
546546
The catalog to query. To list the available catalogs, use
547547
:meth:`~astroquery.heasarc.HeasarcClass.list_catalogs`.
548-
params : dict
549-
A dictionary of column constraint parameters to include in the query.
548+
column_filters : dict
549+
A dictionary of column constraint filters to include in the query.
550550
Each key-value pair will be translated into an ADQL condition.
551551
- For a range query, use a tuple of two values (min, max).
552552
e.g. ``{'flux': (1e-12, 1e-10)}`` translates to
@@ -576,11 +576,11 @@ def query_by_column(self, catalog, params, *,
576576
577577
"""
578578

579-
if not isinstance(params, dict):
579+
if not isinstance(column_filters, dict):
580580
raise ValueError('params must be a dictionary of key-value pairs')
581581

582582
conditions = []
583-
for key, value in params.items():
583+
for key, value in column_filters.items():
584584
if isinstance(value, tuple):
585585
if (
586586
len(value) == 2
@@ -784,15 +784,15 @@ def _guess_host(self, host):
784784
return 'aws'
785785
return 'heasarc'
786786

787-
def download_data(self, links, host=None, location='.'):
787+
def download_data(self, links, *, host=None, location='.'):
788788
"""Download data products in links with a choice of getting the
789789
data from either the heasarc server, sciserver, or the cloud in AWS.
790790
791791
792792
Parameters
793793
----------
794794
links : `astropy.table.Table` or `astropy.table.Row`
795-
The result from locate_data
795+
A table (or row) of data links, typically the result of locate_data.
796796
host : str or None
797797
The data host. The options are: None (default), heasarc, sciserver, aws.
798798
If None, the host is guessed based on the environment.

astroquery/heasarc/tests/test_heasarc.py

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -231,11 +231,11 @@ def test_no_catalog():
231231
OBJ_LIST[0], spatial="cone", columns="*", radius="2arcmin")
232232

233233

234-
def test_by_columns_no_catalog():
234+
def test_query_constraints_no_catalog():
235235
with pytest.raises(InvalidQueryError):
236236
# OBJ_LIST[0] and radius added to avoid a remote call
237-
Heasarc.query_by_column(
238-
None, params={"flux": (1e-12, 1e-10)})
237+
Heasarc.query_constraints(
238+
None, column_filters={"flux": (1e-12, 1e-10)})
239239

240240

241241
def test__query_execute_no_catalog():
@@ -244,87 +244,87 @@ def test__query_execute_no_catalog():
244244
Heasarc._query_execute(None)
245245

246246

247-
def test_by_columns_none_params():
247+
def test_query_constraints_none_params():
248248
with pytest.raises(ValueError):
249-
Heasarc.query_by_column('testcatalog', params=None)
249+
Heasarc.query_constraints('testcatalog', column_filters=None)
250250

251251

252-
def test_by_columns_no_params():
253-
query = Heasarc.query_by_column(
252+
def test_query_constraints_no_params():
253+
query = Heasarc.query_constraints(
254254
catalog="suzamaster",
255-
params={},
255+
column_filters={},
256256
columns="*",
257257
get_query_payload=True,
258258
)
259259
assert query == "SELECT * FROM suzamaster"
260260

261261

262-
def test_by_columns_limit():
263-
query = Heasarc.query_by_column(
262+
def test_query_constraints_limit():
263+
query = Heasarc.query_constraints(
264264
catalog="suzamaster",
265-
params={},
265+
column_filters={},
266266
columns="*",
267267
get_query_payload=True,
268268
maxrec=500000,
269269
)
270270
assert query == "SELECT TOP 2000000 * FROM suzamaster"
271271

272272

273-
def test_by_columns_range():
274-
query = Heasarc.query_by_column(
273+
def test_query_constraints_range():
274+
query = Heasarc.query_constraints(
275275
catalog="suzamaster",
276-
params={"flux": (1e-12, 1e-10)},
276+
column_filters={"flux": (1e-12, 1e-10)},
277277
columns="*",
278278
get_query_payload=True,
279279
)
280280
assert query == "SELECT * FROM suzamaster WHERE flux BETWEEN 1e-12 AND 1e-10"
281281

282282

283-
def test_by_columns_eq_float():
284-
query = Heasarc.query_by_column(
283+
def test_query_constraints_eq_float():
284+
query = Heasarc.query_constraints(
285285
catalog="suzamaster",
286-
params={"flux": 1.2},
286+
column_filters={"flux": 1.2},
287287
columns="*",
288288
get_query_payload=True,
289289
)
290290
assert query == "SELECT * FROM suzamaster WHERE flux = 1.2"
291291

292292

293-
def test_by_columns_eq_str():
294-
query = Heasarc.query_by_column(
293+
def test_query_constraints_eq_str():
294+
query = Heasarc.query_constraints(
295295
catalog="suzamaster",
296-
params={"flux": "1.2"},
296+
column_filters={"flux": "1.2"},
297297
columns="*",
298298
get_query_payload=True,
299299
)
300300
assert query == "SELECT * FROM suzamaster WHERE flux = '1.2'"
301301

302302

303-
def test_by_columns_cmp_float():
304-
query = Heasarc.query_by_column(
303+
def test_query_constraints_cmp_float():
304+
query = Heasarc.query_constraints(
305305
catalog="suzamaster",
306-
params={"flux": ('>', 1.2)},
306+
column_filters={"flux": ('>', 1.2)},
307307
columns="*",
308308
get_query_payload=True,
309309
)
310310
assert query == "SELECT * FROM suzamaster WHERE flux > 1.2"
311311

312312

313-
def test_by_columns_cmp_float_2():
314-
query = Heasarc.query_by_column(
313+
def test_query_constraints_cmp_float_2():
314+
query = Heasarc.query_constraints(
315315
catalog="suzamaster",
316-
params={"flux": ('>', 1.2), "magnitude": ('<=', 15)},
316+
column_filters={"flux": ('>', 1.2), "magnitude": ('<=', 15)},
317317
columns="*",
318318
get_query_payload=True,
319319
)
320320
assert query == ("SELECT * FROM suzamaster WHERE flux > 1.2 "
321321
"AND magnitude <= 15")
322322

323323

324-
def test_by_columns_list():
325-
query = Heasarc.query_by_column(
324+
def test_query_constraints_by_columns_list():
325+
query = Heasarc.query_constraints(
326326
catalog="suzamaster",
327-
params={"flux": [1.2, 2.3, 3.4]},
327+
column_filters={"flux": [1.2, 2.3, 3.4]},
328328
columns="*",
329329
get_query_payload=True,
330330
)

astroquery/heasarc/tests/test_heasarc_remote.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ def test_download_data__heasarc_file(self):
188188
filename = "00README"
189189
tab = Table({
190190
"access_url": [
191-
("https://heasarc.gsfc.nasa.gov/FTP/rxte/"
191+
("https://heasarc.gsfc.nasa.gov/FTP/xte/"
192192
f"data/archive/{filename}")
193193
]
194194
})
@@ -199,7 +199,7 @@ def test_download_data__heasarc_file(self):
199199
def test_download_data__heasarc_folder(self):
200200
tab = Table({
201201
"access_url": [
202-
("https://heasarc.gsfc.nasa.gov/FTP/rxte/data/archive/"
202+
("https://heasarc.gsfc.nasa.gov/FTP/xte/data/archive/"
203203
"AO10/P91129/91129-01-68-00A/stdprod")
204204
]
205205
})
@@ -213,7 +213,7 @@ def test_download_data__heasarc_folder(self):
213213
def test_download_data__s3_file(self):
214214
filename = "00README"
215215
tab = Table(
216-
{"aws": [f"s3://nasa-heasarc/rxte/data/archive/{filename}"]}
216+
{"aws": [f"s3://nasa-heasarc/xte/data/archive/{filename}"]}
217217
)
218218
with tempfile.TemporaryDirectory() as tmpdir:
219219
Heasarc.enable_cloud(provider='aws', profile=None)
@@ -225,7 +225,7 @@ def test_download_data__s3_folder(self, slash):
225225
tab = Table(
226226
{
227227
"aws": [
228-
(f"s3://nasa-heasarc/rxte/data/archive/AO10/"
228+
(f"s3://nasa-heasarc/xte/data/archive/AO10/"
229229
f"P91129/91129-01-68-00A/stdprod{slash}")
230230
]
231231
}

docs/heasarc/heasarc.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -183,16 +183,16 @@ following for instance will find master catalogs that have keywords 'nicer' or '
183183

184184
Other non-region queries
185185
----------------------------------------
186-
In addition to `~astroquery.heasarc.HeasarcClass.query_region`, `~astroquery.heasarc.HeasarcClass.query_by_column`
186+
In addition to `~astroquery.heasarc.HeasarcClass.query_region`, `~astroquery.heasarc.HeasarcClass.query_constraints`
187187
is also available. This method allows you to query a catalog by specifying
188188
various column constraints. For example, the following query searches the ``chanmaster``
189189
catalog for all observations with exposure time greater than 190 ks.
190190

191191
.. doctest-remote-data::
192192

193193
>>> from astroquery.heasarc import Heasarc
194-
>>> tab = Heasarc.query_by_column(
195-
... catalog='chanmaster', params={'exposure': ('>', '190000')}
194+
>>> tab = Heasarc.query_constraints(
195+
... catalog='chanmaster', column_filters={'exposure': ('>', '190000')}
196196
... )
197197
>>> tab['name', 'obsid', 'ra', 'dec', 'exposure'][:3].pprint()
198198
name obsid ra dec exposure
@@ -207,8 +207,8 @@ Another example may be to search the ``xmmmaster`` for a observation in some tim
207207
.. doctest-remote-data::
208208

209209
>>> from astroquery.heasarc import Heasarc
210-
>>> tab = Heasarc.query_by_column(
211-
... catalog='xmmmaster', params={'time': (52300, 52310)}
210+
>>> tab = Heasarc.query_constraints(
211+
... catalog='xmmmaster', column_filters={'time': (52300, 52310)}
212212
... )
213213
>>> tab['name', 'obsid', 'ra', 'dec', 'time', 'duration'][:3].pprint()
214214
name obsid ra dec time duration

0 commit comments

Comments
 (0)